IntroduçãoBem-vindo ao cel_cash!São muitas as vantagens que o cel_cash tem disponível para revolucionar a cobrança da sua empresa. Para tornar este caminho mais fácil, iremos oferecer mais uma grande ajuda: abaixo você conhecerá o Manual de Integração da sua empresa com a API do cel_cash que permitirá o uso das melhores soluções de cobrança do mercado. Para que a nossa parceria atenda-o de forma satisfatória e segura, o cel_cash oferece diferentes soluções seguras para captura de transações. As recomendações de cada etapa baixo, devem ser lidas com atenção e usadas como guia de referência para dúvidas que possam surgir no momento da implementação da integração em sua plataforma. O conteúdo deste Manual de Integração é direcionado a programadores e desenvolvedores que desejam realizar a captura e o processamento de suas transações diretamente com o cel_cash. O desenvolvedor/analista terá acesso a todos os passos e processos referentes à integração com o sistema de captura e autorização de transações financeiras do cel_cash via as funcionalidades da API. Antes de apresentá-los as funcionalidades desta API, mais uma dica: sugerimos que periodicamente e sempre que for iniciado um desenvolvimento relacionado à captura de transações, utilize este portal para acompanhamento de mudanças e versionamento dos produtos de nossa plataforma. IPs dos servidores de produção: 54.232.59.251 54.232.204.133 IPs dos servidores de sandbox: 54.207.173.93 Esses IPs podem ser alterados sem aviso prévio. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FuncionalidadesCom nossa API você terá a possibilidade de ter o nosso sistema integrado com o seu. Todas as ações necessárias para que você integre seu sistema com o nosso estão disponíveis para implementação. A integração permite que você crie um cliente no nosso sistema e até consulte o status do pagamento, se já foi pago ou não.Disponibilizamos os métodos e dados de teste para que você consiga realizar a integração com nosso sistema sem riscos. Após a contratação e solicitação de credenciais, iremos encaminhar um e-mail com os credenciais de sua empresas para a integração funcionar em ambiente de produção. Fluxo básico de integração
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ParceirosPara identificarmos que a transação partiu de determinado parceiro, envie nas requisições o header "PartnerId" com o galaxId do parceiro. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Dados de testeLogin no sistema de teste (clique aqui para acessar)Login: [email protected] Senha: webservice@ Chaves de autenticação de teste: URL: https://app.sandbox.cel.cash/ galaxId: 5473 galaxHash: 83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Dados de produçãoApós a finalização da integração utilizando as chaves de autenticação de teste, entre dentro do sistema do cel_cash, e solicite pelo formulário de "Ajuda" as chaves de autenticações de produção.URL: https://celcash.celcoin.com.br/ |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Dados de cartão
Utilize as chaves de autenticação de teste e os cartões abaixo para simular um pagamento com o resultado esperado. Os cartões citados irão ter o resultado esperado apenas no ambiente de testes. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Status das transaçõesAbaixo estão listados os status disponíveis para uma transação.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ClienteÁrea destinada para as transações de Contratos/Vendas. Você conseguirá retornar todas as transações necessárias em uma lista, estornar uma transação, cancelar uma transação, visualizar uma lista contendo todos os status de transações disponíveis para seu sistema, dentre outras funcionalidades. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/createCustomerÁrea destinada ao cadastro dos dados de um novo cliente, podendo ou não conter o endereço do cliente.Parâmetros
NOTAS1 - O parametro "password" é obrigatório caso o módulo de senha para cliente externo esteja ativo.2 - Caso informado o parametro "Address", todos os campos de endereço, exceto o "complement", serão obrigatorios. 3 - Para cadastrar Contratos/Vendas de boleto para o cliente, informe o endereço completo. 4 - Caso informado o parametro "holdIss" para um cliente que possui CNPJ, ao cadastrar um novo Contrato/Venda com emissão de NFS-e, irá alterar o valor da transação retirando a taxa de ISS que será paga pelo pagador. |
post
https://app.sandbox.cel.cash/webservice/createCustomer
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"integrationId": "1","document": "012.345.678-90","name": "Teste cliente do cel_cash API","email": "[email protected]","phone": "(31)4020-1512"} }
{"type":"true","customerInternalId":"1308","message":"Cliente cadastrado com sucesso"}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/updateCustomerAtualiza os dados enviados do cliente.Parâmetros
NOTAS5 - É obrigatório apenas um dos dois parâmetros citados (customerInternalId, customerIntegrationId). Somente um destes parâmetros é considerado, logo, os mesmos estão em ordem de relevância.6 - O parâmetro "customerInternalId" não irá ser alterado caso informado, o restante sim. 7 - Informe apenas os parametros que deseja alterar. |
post
https://app.sandbox.cel.cash/webservice/updateCustomer
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"customerIntegrationId": "1","document": "012.345.678-90","name": "Teste cliente do cel_cash","email": "[email protected]","phone": "(31)4020-1512","cellphone": "(31)98585-8585","Address": {"zipCode": "30411-325","street": "Rua platina","number": "1375","neighborhood": "Prado","city": "Belo Horizonte","state": "MG","complement": "2º andar","countryInitials": "BRA"}} }
{"type":"true","message":"Cliente alterado com sucesso"}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getCustomerInfoRetorna todas as informações referente ao cliente desejado, que pode ser filtrado por diferentes parâmetros.Parâmetros
NOTAS8 - É obrigatório o uso de apenas um dos quatro parâmetros citados acima.9 - Somente um destes parâmetros será considerado e por isso, estão citados acima por ordem de relevância. |
post
https://app.sandbox.cel.cash/webservice/getCustomerInfo
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"customerInternalId": "1"} }
{"type": "true","customer": {"internalId": "123","integrationId": "123","document": "01234567890","name": "Testes Construsite","email": "[email protected]","phone": "(23)4234-23423","cellphone": "(23)9423-23423","isForeign":"false","Address": {"street": "Rua Platina","number": "1375","complement": "2° Andar","neighborhood": "Prado","city": "Belo Horizonte","state": "MG","zipCode": "30411325","countryInitials":"null"}}}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/verifyPasswordCustomerRetorna se a senha enviada está em conformidade com a senha cadastrada no sistema.Utilizado somente para clientes que possuirem o módulo de senha para cliente ativo. Parâmetros
NOTAS10 - É obrigatório apenas um dos três parâmetros citados (customerInternalId, customerIntegrationId, customerEmail). Somente um destes parâmetros é considerado, logo, os mesmos estão em ordem de relevância. |
post
https://app.sandbox.cel.cash/webservice/verifyPasswordCustomer
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"customerEmail": "[email protected]","password": "123456"} }
{"type":"true","message":"Senha correta."}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getCustomersRetorna todas as informações de clientes de acordo com o filtro de data escolhido.Parâmetros
|
post
https://app.sandbox.cel.cash/webservice/getCustomers
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"startDate": "2020-05-10","endDate": "2020-05-15","typeDate": "dateCreatedAt"} }
{"type":true,"quantity":1,"customers":[{"internalId":"1","integrationId":"","document":"01234567890","name":"cel_cash Teste","email":"[email protected]","phone":"(31) 4020-1512","cellphone":"(31) 98787-8787","isForeign":"false","insertdate":"2020-05-15 08:49:59","updatedate":"2020-05-15 08:49:59","Address":{"street":"Rua Monte Alverne","number":"","complement":null,"neighborhood":"Floresta","city":"Belo Horizonte","state":"MG","zipCode":"31015400","countryInitials":"null"},"CustomFields":{"CP_CAMPO_PERSONALIZADO_CLIENTE":"Teste cel_cash Data de Nascimento","CP_CAMPO_PERSONALIZADO_CLIENTE1":"Teste cel_cash"}}]}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PlanosÁrea destinada a métodos dos planos, você conseguirá visualizar todos os planos e seus preços até apenas um único plano. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/createPlanÁrea destinada ao cadastro de planos.Parâmetros
NOTAS11 - Caso a periodicidade seja "Manual", o cel_cash não irá gerar nenhuma transação, sendo necessário utilizar o endpoint /addTransactionContract.12 - Os métodos de pagamento disponíveis para utilizar no parâmetro "values" pode ser obtido utilizando o resultado do método "/getPaymentTypesEnabled". |
post
https://app.sandbox.cel.cash/webservice/createPlan
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"integrationId": "1","name": "Plano mensal básico","periodicity": "monthly","quantity": "12","values": {"credit": "50.00"}} }
{"type":"true","message":"Plano cadastrado com sucesso."}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getAllPlansActiveRetorna uma lista contendo todos os planos ativos e seus preços. Este método não necessita de parâmetros na requisição.
|
post
https://app.sandbox.cel.cash/webservice/getAllPlansActive
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
}
{"type":"true","plans":[{"internalId":"11","integrationId":"23","name":"Plano de exemplo 1","planType":"contract","periodicity":"monthly","periodicityDescription":"Mensal","quantity":"5","initialPrice":"100.00","priceList":{"credit":[{"price":"100.00","installment":"1"}]}},{"internalId":"52","integrationId":"","name":"Plano de exemplo 2","planType":"sale","periodicity":"monthly","periodicityDescription":"Mensal","quantity":"2","initialPrice":"100.00","priceList":{"credit":[{"price":"100.00","installment":"1"},{"price":"100.00","installment":"2"}],"boleto":[{"price":"100.00","installment":"1"}]}},{"internalId":"63","integrationId":"23","name":"Plano de exemplo 3","planType":"contract","periodicity":"monthly","periodicityDescription":"Mensal","quantity":"4","initialPrice":"100.00","priceList":{"boleto":[{"price":"100.00","installment":"1"}]}}]}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getPlansByIdsRetorna uma lista contendo todos os planos ativos e seus preços filtrados pelos IDs que foram informados.Os índices "credit" e "boleto"Parâmetros
NOTAS13 - É obrigatório apenas um dos dois parâmetros citados (ids, integrationIds).Somente um destes parâmetros é considerado, logo, os mesmos estão em ordem de relevância. 14 - Separe o IDs por vírgula, conforme o exemplo. |
post
https://app.sandbox.cel.cash/webservice/getPlansByIds
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"ids": "11,52,63"} }
{"type":"true","plans":[{"internalId":"11","integrationId":"23","name":"Plano de exemplo 1","planType":"contract","periodicity":"monthly","periodicityDescription":"Mensal","quantity":"5","initialPrice":"100.00","priceList":{"credit":[{"price":"100.00","installment":"1"}]}},{"internalId":"52","integrationId":"","name":"Plano de exemplo 2","planType":"sale","periodicity":"monthly","periodicityDescription":"Mensal","quantity":"2","initialPrice":"100.00","priceList":{"credit":[{"price":"100.00","installment":"1"},{"price":"100.00","installment":"2"}],"boleto":[{"price":"100.00","installment":"1"}]}},{"internalId":"63","integrationId":"23","name":"Plano de exemplo 3","planType":"contract","periodicity":"monthly","periodicityDescription":"Mensal","quantity":"4","initialPrice":"100.00","priceList":{"boleto":[{"price":"100.00","installment":"1"}]}}]}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CartõesÁrea destinada aos métodos dos clientes. Você conseguirá visualizar uma lista de informações sobre os cartões cadastrados para determinado cliente, poderá receber uma lista contendo todas as bandeiras disponíveis para determinada operadora, dentre outras funcionalidades. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/createCardÁrea destinada ao cadastro do cartão para determinado cliente.Parâmetros
NOTAS15 - A bandeira do cartão para utilizar no parâmetro "brand" pode ser obtido utilizando o resultado do método "/getCardBrandsByOperator". |
post
https://app.sandbox.cel.cash/webservice/createCard
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"customerInternalId": "1","Card": {"integrationId": "1","number": "4716 0248 9944 1650","holder": "Cliente de exemplo cel_cash","expiryMonth": "04","expiryYear": "2023","cvv": "541","brand": "visa"}} }
{"type":"true","cardInternalId":"1308","message":"Cliente cadastrado com sucesso"}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getCardsByCustomerRetorna uma lista contendo as informações de todos os cartões cadastrados para determinado cliente, podendo ser filtrado por diferentes parâmetros.Parâmetros
NOTAS16 - É obrigatório o uso de apenas um dos parâmetros citados acima. |
post
https://app.sandbox.cel.cash/webservice/getCardsByCustomer
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"customerIntegrationId": "1"} }
{"type": "true","cards": [{"integrationId": "123","internalId": "123","truncatedNumber": "455187******0183","brand": "Visa"}]}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getCardBrandsByOperatorRetorna uma lista das bandeiras disponíveis para uso de determinada operadora. Cada bandeira irá possuir um limite de parcelas disponíveis para uso no parcelamento.Parâmetros
NOTAS17 - O nome da operadora para utilizar no parâmetro "operatorName" pode ser obtido utilizando o resultado do método "/getOperatorList". |
post
https://app.sandbox.cel.cash/webservice/getCardBrandsByOperator
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"operatorName": "cielo"} }
{"type": "true","brands": [{"name": "visa","displayName": "Visa","maxNumberOfInstallments": "12"}]}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getBrandCardRetorna a bandeira do cartão.Parâmetros
|
post
https://app.sandbox.cel.cash/webservice/getBrandCard
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"cardNumber": "4539 4044 6689 9859"} }
{"type":"true","brand":[{"internalName":"visa","name":"Visa"}]}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getAllBrandsEnabledRetorna todas as bandeiras disponiveis. Este método não necessita de parâmetros na requisição.
|
post
https://app.sandbox.cel.cash/webservice/getAllBrandsEnabled
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
}
{"type":"true","brands":[{"internalName":"visa","name":"Visa"},{"internalName":"mastercard","name":"MasterCard"},{"internalName":"diners","name":"Diners"},{"internalName":"discover","name":"Discover"},{"internalName":"elo","name":"Elo"},{"internalName":"amex","name":"Amex"},{"internalName":"aura","name":"Aura"},{"internalName":"hipercard","name":"Hipercard"},{"internalName":"jcb","name":"JCB"}]}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getMaxInstallmentByBrandRetorna o limite máximo de vezes disponível para determinada bandeira.Parâmetros
|
post
https://app.sandbox.cel.cash/webservice/getMaxInstallmentByBrand
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"brandInternalName": "visa"} }
{"type":"true","maxInstallment":"15"}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OperadorasÁrea destinada a métodos das operadoras de cobranças. Você conseguirá uma lista de operadoras disponíveis para realizar pagamentos em seu sistema, dentre outras funcionalidades. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getOperatorListRetorna uma lista de todas as operadoras disponíveis para realizar pagamentos. O resultado retornado poderá ser utilizado em outros métodos da API. Este método não necessita de parâmetros na requisição.
|
post
https://app.sandbox.cel.cash/webservice/getOperatorList
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
}
{"type": "true","operators": [{"name": "cielo","displayName": "Cielo"}]}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getPaymentTypesEnabledRetorna uma lista de todas os métodos de pagamentos disponíveis para realizar pagamentos. O resultado retornado poderá ser utilizado em outros métodos da API. Este método não necessita de parâmetros na requisição.
|
post
https://app.sandbox.cel.cash/webservice/getPaymentTypesEnabled
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
}
{"type":"true","paymentMethods":[{"displayName":"Débito","name":"debit"},{"displayName":"Crédito","name":"credit"},{"displayName":"Boleto","name":"boleto"}]}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Contratos/VendasÁrea destinada a Contratos/Vendas do sistema. Você conseguirá criar cobranças de vários tipos para seus clientes, uma lista de cobranças por cliente, realizar o cancelamento de um Contrato/Venda, alterar um cartão de um Contrato/Venda para realizar uma nova tentativa de cobrança, dentre outras funcionalidades. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/createPaymentBillÁrea destinada ao cadastro de um novo Contrato/Venda para realizar a cobrança em um cartão de crédito ou débito. Este novo Contrato/Venda poderá ser configurado de diferentes formas.Parâmetros
NOTAS18 - Caso a periodicidade seja "Manual", o cel_cash não irá gerar nenhuma transação, sendo necessário utilizar o endpoint /addTransactionContract.19 - O nome da operadora para utilizar no parâmetro "operator" pode ser obtido utilizando o resultado do método "/getOperatorList". 20 - A bandeira do cartão para utilizar no parâmetro "brand" pode ser obtido utilizando o resultado do método "/getCardBrandsByOperator". 21 - Caso não for informado o parâmetro "operator", irá obedecer a prioridade de operadoras do sistema, somente se o "paymentType" for igual a "newCard". 22 - Caso sejam informados algum dos parâmetros do plano(planInternalId, planIntegrationId) somente um será considerado. 23 - O campo "discounts" é aplicado somente a Contratos do typo "contract". 24 - É obrigatório apenas um dos quatro parâmetros citados (customerInternalId, customerIntegrationId). Somente um destes parâmetros é considerado, logo, os mesmos estão em ordem de relevância. 25 - O parâmetro "Invoice" deverá ser informado apenas quando desejar gerar notas fiscais. 26 - O parâmetro "CustomFields" deverá ser informado apenas quando deseja registrar informações nos campos personalizados dos sistema. 27 - Caso seja informado que irá ser gerado nota fiscal e o cliente retenha ISS, os valores informados irão descontar o valor correspondente ao ISS automáticamente. |
post
https://app.sandbox.cel.cash/webservice/createPaymentBill
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"integrationId": "1","customerIntegrationId": "1","typeBill": "sale","payday": "2018-06-21","value": "80.00","numberOfInstallments": "2","paymentType": "newCard","Card": {"integrationId": "1","number": "4716 0248 9944 1650","holder": "Cliente de exemplo cel_cash","expiryMonth": "04","expiryYear": "2023","cvv": "541","brand": "visa"}} }
{"type": "true","paymentBillInternalId":"1245","message": "Contrato/Venda cadastrado com sucesso."}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/createPaymentBillAndCustomerÁrea destinada ao cadastro ou alteração de um cliente e cadastro de um Contrato/Venda para realizar a cobrança em um cartão de crédito ou débito. Este novo Contrato/Venda poderá ser configurado de diferentes formas.Parâmetros
NOTAS28 - Caso a periodicidade seja "Manual", o cel_cash não irá gerar nenhuma transação, sendo necessário utilizar o endpoint /addTransactionContract.29 - O nome da operadora para utilizar no parâmetro "operator" pode ser obtido utilizando o resultado do método "/getOperatorList". 30 - A bandeira do cartão para utilizar no parâmetro "brand" pode ser obtido utilizando o resultado do método "/getCardBrandsByOperator". 31 - Caso não for informado o parâmetro "operator", irá obedecer a prioridade de operadoras do sistema, somente se o "paymentType" for igual a "newCard". 32 - Caso sejam informados algum dos parâmetros do plano(planInternalId, planIntegrationId) somente um será considerado. 33 - O campo "discounts" é aplicado somente a Contratos do typo "contract". 34 - É obrigatório apenas um dos quatro parâmetros citados (customerInternalId, customerIntegrationId). Somente um destes parâmetros é considerado, logo, os mesmos estão em ordem de relevância. 35 - O parametro "password" é obrigatório caso o módulo de senha para cliente externo esteja ativo. 36 - Caso informado o parametro "Address", todos os campos de endereço, exceto o "complement", serão obrigatorios. 37 - O parâmetro "Invoice" deverá ser informado apenas quando desejar gerar notas fiscais. 38 - O parâmetro "CustomFields" deverá ser informado apenas quando deseja registrar informações nos campos personalizados dos sistema. 39 - Caso seja informado que irá ser gerado nota fiscal e o cliente retenha ISS, os valores informados irão descontar o valor correspondente ao ISS automáticamente. 40 - Caso informado o parametro "holdIss" para um cliente que possui CNPJ, ao cadastrar um novo Contrato/Venda com emissão de NFS-e, irá alterar o valor da transação retirando a taxa de ISS que será paga pelo pagador. |
post
https://app.sandbox.cel.cash/webservice/createPaymentBillAndCustomer
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"integrationId": "1","typeBill": "sale","payday": "2018-06-21","value": "80.00","numberOfInstallments": "4","paymentType": "newCard","Customer": {"integrationId": "1","document": "012.345.678-90","name": "Teste cliente do cel_cash","email": "[email protected]","phone": "(31)4020-1512","Address": {"zipCode": "30411-325","street": "Rua platina","number": "1375","neighborhood": "Prado","city": "Belo Horizonte","state": "MG","complement": "2º andar","countryInitials": "BRA"}},"Card": {"integrationId": "1","number": "4716 0248 9944 1650","holder": "Cliente de exemplo cel_cash","expiryMonth": "04","expiryYear": "2023","cvv": "541","brand": "visa"}} }
{"type": "true","paymentBillInternalId":"1245","message": "Contrato/Venda cadastrado com sucesso."}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/createPaymentBillBoletoÁrea destinada ao cadastro de um novo Contrato/Venda para realizar cobranças com boletos. Este novo Contrato/Venda poderá ser configurado de diferentes formas.Parâmetros
NOTAS41 - Caso a periodicidade seja "Manual", o cel_cash não irá gerar nenhuma transação, sendo necessário utilizar o endpoint /addTransactionContract.42 - Caso sejam informados algum dos parâmetros do plano(planInternalId, planIntegrationId) somente um será considerado. 43 - Os parâmetros "typeConditionalDiscount", "daysBeforePayDayDiscount" e "conditionalDiscount" serão utilizados apenas se o módulo "Desconto condicional por boleto" esteja ativo dentro do sistema. 44 - O campo "discounts" é aplicado somente a Contratos do typo "contract". 45 - O parâmetro "Invoice" deverá ser informado apenas quando desejar gerar notas fiscais. 46 - O parâmetro "CustomFields" deverá ser informado apenas quando deseja registrar informações nos campos personalizados dos sistema. 47 - Caso seja informado que irá ser gerado nota fiscal e o cliente retenha ISS, os valores informados irão descontar o valor correspondente ao ISS automáticamente. |
post
https://app.sandbox.cel.cash/webservice/createPaymentBillBoleto
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"integrationId": "1","typeBill": "contract","periodicity": "monthly","payday": "2018-06-21","value": "80.00","quantity": "4","customerIntegrationId": "1","fineBoleto": "2.50","interestBoleto": "1.25"} }
{"type": "true","paymentBillInternalId":"1245","message": "Contrato/Venda cadastrado com sucesso."}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/createPaymentBillBoletoAndCustomerÁrea destinada ao cadastro ou alteração de um cliente e cadastro de um Contrato/Venda para realizar cobranças com boletos. Este novo Contrato/Venda poderá ser configurado de diferentes formas.Parâmetros
NOTAS48 - Caso a periodicidade seja "Manual", o cel_cash não irá gerar nenhuma transação, sendo necessário utilizar o endpoint /addTransactionContract.49 - Caso sejam informados algum dos parâmetros do plano(planInternalId, planIntegrationId) somente um será considerado. 50 - Os parâmetros "typeConditionalDiscount", "daysBeforePayDayDiscount" e "conditionalDiscount" serão utilizados apenas se o módulo "Desconto condicional por boleto" esteja ativo dentro do sistema. 51 - O campo "discounts" é aplicado somente a Contratos do typo "contract". 52 - O parâmetro "Invoice" deverá ser informado apenas quando desejar gerar notas fiscais. 53 - O parâmetro "CustomFields" deverá ser informado apenas quando deseja registrar informações nos campos personalizados dos sistema. 54 - Caso seja informado que irá ser gerado nota fiscal e o cliente retenha ISS, os valores informados irão descontar o valor correspondente ao ISS automáticamente. 55 - Caso informado o parametro "holdIss" para um cliente que possui CNPJ, ao cadastrar um novo Contrato/Venda com emissão de NFS-e, irá alterar o valor da transação retirando a taxa de ISS que será paga pelo pagador. |
post
https://app.sandbox.cel.cash/webservice/createPaymentBillBoletoAndCustomer
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"integrationId": "1","typeBill": "contract","periodicity": "monthly","payday": "2018-06-21","value": "80.00","quantity": "4","fineBoleto": "2.50","interestBoleto": "1.25","Customer": {"integrationId": "1","document": "012.345.678-90","name": "Teste cliente do cel_cash","email": "[email protected]","phone": "(31)4020-1512","Address": {"zipCode": "30411-325","street": "Rua platina","number": "1375","neighborhood": "Prado","city": "Belo Horizonte","state": "MG","complement": "2º andar","countryInitials": "BRA"}}} }
{"type": "true","paymentBillInternalId":"1245","message": "Contrato/Venda cadastrado com sucesso."}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getPaymentBillInfoRetorna todas as informações do pagamento e suas transações.Parâmetros
NOTAS56 - É obrigatório o uso de apenas um dos parâmetros citados acima.57 - Caso a transação seja do tipo de boleto o RESPONSE do método retornará a URL do boleto e a linha digitável. |
post
https://app.sandbox.cel.cash/webservice/getPaymentBillInfo
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"internalId": "1"} }
{"type":true,"paymentBill":{"internalId":"1","integrationId":"","periodicity":"monthly","quantity":"6","dateFirst":"2020-05-15","status":"active","statusDescription":"Ativa","additionalInfo":null,"urlCarne":"https://data.galaxpay.com.br/testegalaxpay/carne/c3b17e535f11c02338a0d05db4ac9b0a","infoBoleto":"Referente ao pagamento da mensalidade","value":"50.00","customerInternalId":"1","customerIntegrationId":"","customerName":"cel_cash Teste","operator":"boletoGalaxPay","operatorName":"Boleto cel_cash","transactions":[{"internalId":"1","integrationId":null,"payday":"2020-05-15","installmentNumber":"1","additionalInfo":null,"customerInternalId":"1","customerIntegrationId":null,"paymentBillInternalId":"1","paymentBillIntegrationId":null,"paymentBillAdditionalInfo":null,"value":"50.00","lastUpdateDate":"2020-05-15 09:34:57","status":"pendingBoleto","statusDescription":"Em aberto","isBoleto":true,"boleto":"https://data.galaxpay.com.br/testegalaxpay/boleto/2020052PR6JHV2Z8EFQY1J7KLYCL0GF15093457","boletoBankLine":"03399022070600000001517232201016982560000005000","boletoBankNumber":"13485793TESTE-1172322249990985","boletoEmissionDate":"2020-05-15 09:34:57","boletoBankEmissor":"santander","qrCodePix":"ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123","imageQrCodePix":"https://data.galaxpay.com.br/testegalaxpay/pix/13485793TESTE","pageQrCodePix":"https://gpay.com.br/q/5473/cce43a96"}]}}
{"type":true,"paymentBill":{"internalId":"2","integrationId":"","periodicity":"monthly","quantity":"5","dateFirst":"2020-05-15","status":"active","statusDescription":"Ativa","additionalInfo":null,"link":"https://app.galaxpay.com.br/testegalaxpay/cobranca/2/cartao","value":"50.00","brand":"Visa","cardTruncate":"4024********4517","customerInternalId":"1","customerIntegrationId":"","customerName":"cel_cash Teste","operator":"bin","operatorName":"BIN","transactions":[{"internalId":"7","integrationId":null,"payday":"2020-05-15","installmentNumber":"1","tid":null,"additionalInfo":null,"customerInternalId":"1","customerIntegrationId":null,"link":"https://app.galaxpay.com.br/testegalaxpay/cobranca/2/cartao","paymentBillInternalId":"2","paymentBillIntegrationId":null,"paymentBillAdditionalInfo":null,"value":"50.00","authorizationCode":"APROVADO89BIN90205","lastUpdateDate":"2020-05-15 09:48:43","status":"captured","statusDescription":"Capturada na Operadora","isBoleto":false,"brand":"Visa","truncatedNumber":"4024********4517","cardInternalId":"1"},{"internalId":"8","integrationId":null,"payday":"2020-06-15","installmentNumber":"2","tid":null,"additionalInfo":null,"customerInternalId":"1","customerIntegrationId":null,"link":"https://app.galaxpay.com.br/testegalaxpay/cobranca/2/cartao","paymentBillInternalId":"2","paymentBillIntegrationId":null,"paymentBillAdditionalInfo":null,"value":"50.00","authorizationCode":null,"lastUpdateDate":"","status":"notSend","statusDescription":"Ainda não enviada para operadora","isBoleto":false,"brand":"Visa","truncatedNumber":"4024********4517","cardInternalId":"1"}]}}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getPaymentBillsByCustomerRetorna todas as informações dos pagamentos e transações de um determinado cliente em um período de tempo específico.Parâmetros
NOTAS58 - É obrigatório apenas um dos quatro parâmetros citados (customerInternalId, customerIntegrationId, customerDocument, customerEmail). Somente um destes parâmetros é considerado, logo, os mesmos estão em ordem de relevância.59 - Caso sejam utilizados os filtros por data, todos estes parâmetros (typeDate, startDate, endDate) serão obrigatórios. |
post
https://app.sandbox.cel.cash/webservice/getPaymentBillsByCustomer
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"customerInternalId": "1"} }
{"type":true,"paymentBill":{"internalId":"1","integrationId":"","periodicity":"monthly","quantity":"6","status":"active","additionalInfo":null,"infoBoleto":"Referente ao pagamento da mensalidade","value":"50.00","customerInternalId":"1","customerIntegrationId":"","customerName":"cel_cash Teste","operator":"boletoGalaxPay","transactions":[{"internalId":"1","integrationId":null,"payday":"2020-05-15","installmentNumber":"1","additionalInfo":null,"customerInternalId":"1","customerIntegrationId":null,"paymentBillInternalId":"1","paymentBillIntegrationId":null,"paymentBillAdditionalInfo":null,"value":"50.00","lastUpdateDate":"2020-05-15 09:34:57","status":"pendingBoleto","statusDescription":"Em aberto","isBoleto":true,"boleto":"https://data.galaxpay.com.br/testegalaxpay/boleto/2020052PR6JHV2Z8EFQY1J7KLYCL0GF15093457","boletoBankLine":"03399022070600000001517232201016982560000005000","boletoBankNumber":"13485793TESTE-1172322249990985","qrCodePix":"ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123","imageQrCodePix":"https://data.galaxpay.com.br/testegalaxpay/pix/13485793TESTE","pageQrCodePix":"https://gpay.com.br/q/5473/cce43a96"}]}}
{"type":true,"paymentBill":{"internalId":"2","integrationId":"","periodicity":"monthly","quantity":"5","status":"active","additionalInfo":null,"link":"https://app.galaxpay.com.br/testegalaxpay/cobranca/2/cartao","value":"50.00","brand":"Visa","cardTruncate":"4024********4517","customerInternalId":"1","customerIntegrationId":"","customerName":"cel_cash Teste","operator":"bin","transactions":[{"internalId":"7","integrationId":null,"payday":"2020-05-15","installmentNumber":"1","additionalInfo":null,"customerInternalId":"1","customerIntegrationId":null,"link":"https://app.galaxpay.com.br/testegalaxpay/cobranca/2/cartao","paymentBillInternalId":"2","paymentBillIntegrationId":null,"paymentBillAdditionalInfo":null,"value":"50.00","authorizationCode":"APROVADO89BIN90205","lastUpdateDate":"2020-05-15 09:48:43","status":"captured","statusDescription":"Capturada na Operadora","isBoleto":false,"brand":"Visa","truncatedNumber":"4024********4517","cardInternalId":"1"},{"internalId":"8","integrationId":null,"payday":"2020-06-15","installmentNumber":"2","additionalInfo":null,"customerInternalId":"1","customerIntegrationId":null,"link":"https://app.galaxpay.com.br/testegalaxpay/cobranca/2/cartao","paymentBillInternalId":"2","paymentBillIntegrationId":null,"paymentBillAdditionalInfo":null,"value":"50.00","authorizationCode":null,"lastUpdateDate":"","status":"notSend","statusDescription":"Ainda não enviada para operadora","isBoleto":false,"brand":"Visa","truncatedNumber":"4024********4517","cardInternalId":"1"}]}}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getPaymentsWithCustomersRetorna todas as informações do cliente, de seus pagamentos e transações em um período de tempo específico.Parâmetros
|
post
https://app.sandbox.cel.cash/webservice/getPaymentsWithCustomers
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"startDate": "2018-01-10","endDate": "2018-12-15","typeDate": "dateOfLastUpdate"} }
{"type":true,"customers":[{"internalId":"3","integrationId":"14234","document":"06988994000182","name":"Cliente de Teste para Boleto","email":"[email protected]","phone":"(31) 9999-9999","cellphone":"null","isForeign":"false","insertdate":"2018-07-05 11:19:06","Address":{"street":"Rua Platina","number":"1330","complement":"null","neighborhood":"Calafatão","city":"Belo Horizonte","state":"MG","zipCode":"30411325","countryInitials":"null"},"paymentBill":{"internalId":"1","integrationId":"","periodicity":"monthly","quantity":"6","dateFirst":"2020-05-15","status":"active","statusDescription":"Ativa","additionalInfo":null,"urlCarne":"https://data.galaxpay.com.br/testegalaxpay/carne/c3b17e535f11c02338a0d05db4ac9b0a","infoBoleto":"Referente ao pagamento da mensalidade","value":"50.00","customerInternalId":"1","customerIntegrationId":"","customerName":"cel_cash Teste","operator":"boletoGalaxPay","operatorName":"Boleto cel_cash","transactions":[{"internalId":"1","integrationId":null,"payday":"2020-05-15","installmentNumber":"1","additionalInfo":null,"customerInternalId":"1","customerIntegrationId":null,"paymentBillInternalId":"1","paymentBillIntegrationId":null,"paymentBillAdditionalInfo":null,"value":"50.00","lastUpdateDate":"2020-05-15 09:34:57","status":"pendingBoleto","statusDescription":"Em aberto","isBoleto":true,"boleto":"https://data.galaxpay.com.br/testegalaxpay/boleto/2020052PR6JHV2Z8EFQY1J7KLYCL0GF15093457","boletoBankLine":"03399022070600000001517232201016982560000005000","boletoBankNumber":"13485793TESTE-1172322249990985","boletoEmissionDate":"2020-05-15 09:34:57","boletoBankEmissor":"santander","qrCodePix":"ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123","imageQrCodePix":"https://data.galaxpay.com.br/testegalaxpay/pix/13485793TESTE","pageQrCodePix":"https://gpay.com.br/q/5473/cce43a96"}]}}]}
{"type":true,"customers":[{"internalId":"3","integrationId":"123","document":"12345678909","name":"Cliente de Teste para Cartão","email":"[email protected]","phone":"(31) 9999-9999","cellphone":"null","isForeign":"false","insertdate":"2018-07-05 11:19:06","Address":{"street":"Rua Platina","number":"1330","complement":"null","neighborhood":"Calafate","city":"Belo Horizonte","state":"MG","zipCode":"30411325","countryInitials":"null"},"paymentBill":{"internalId":"2","integrationId":"","periodicity":"monthly","quantity":"5","dateFirst":"2020-05-15","status":"active","statusDescription":"Ativa","additionalInfo":null,"link":"https://app.galaxpay.com.br/testegalaxpay/cobranca/2/cartao","value":"50.00","brand":"Visa","cardTruncate":"4024********4517","customerInternalId":"1","customerIntegrationId":"","customerName":"cel_cash Teste","operator":"bin","operatorName":"BIN","transactions":[{"internalId":"7","integrationId":null,"payday":"2020-05-15","installmentNumber":"1","tid":null,"additionalInfo":null,"customerInternalId":"1","customerIntegrationId":null,"link":"https://app.galaxpay.com.br/testegalaxpay/cobranca/2/cartao","paymentBillInternalId":"2","paymentBillIntegrationId":null,"paymentBillAdditionalInfo":null,"value":"50.00","authorizationCode":"APROVADO89BIN90205","lastUpdateDate":"2020-05-15 09:48:43","status":"captured","statusDescription":"Capturada na Operadora","isBoleto":false,"brand":"Visa","truncatedNumber":"4024********4517","cardInternalId":"1"},{"internalId":"8","integrationId":null,"payday":"2020-06-15","installmentNumber":"2","tid":null,"additionalInfo":null,"customerInternalId":"1","customerIntegrationId":null,"link":"https://app.galaxpay.com.br/testegalaxpay/cobranca/2/cartao","paymentBillInternalId":"2","paymentBillIntegrationId":null,"paymentBillAdditionalInfo":null,"value":"50.00","authorizationCode":null,"lastUpdateDate":"","status":"notSend","statusDescription":"Ainda não enviada para operadora","isBoleto":false,"brand":"Visa","truncatedNumber":"4024********4517","cardInternalId":"1"}]}}]}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/cancelPaymentBillÁrea destinada para cancelar um Contrato/Venda específica. Ao cancelar não será realizado nenhum tipo de cobrança para o cliente.Parâmetros
NOTAS60 - É obrigatório o uso de apenas um dos parâmetros citados acima.61 - Somente um destes parâmetros será considerado e por isso, estão citados acima por ordem de relevância. |
post
https://app.sandbox.cel.cash/webservice/cancelPaymentBill
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"paymentBillIntegrationId": "1"} }
{"type": "true","message": "Transação cancelada com sucesso."}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/updatePaymentBillCardÁrea destinada para atualizar o cartão de um Contrato/Venda para futuras cobranças ou novas tentativas em transações negadas.Parâmetros
NOTAS62 - Um dos parâmetros, "paymentBillIntegrationId" ou "paymentBillInternalId", é necessário ser informado.63 - Um dos parâmetros, "customerIntegrationId" ou "customerInternalId", é necessário ser informado. 64 - A bandeira do cartão para utilizar no parâmetro "brand" pode ser obtida utilizando o resultado do método "/getCardBrandsByOperator". |
post
https://app.sandbox.cel.cash/webservice/updatePaymentBillCard
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"paymentBillIntegrationId": "1","customerIntegrationId": "1","Card": {"integrationId": "1","number": "4716 0248 9944 1650","holder": "Cliente de exemplo cel_cash","expiryMonth": "04","expiryYear": "2023","cvv": "541","brand": "visa"}} }
{"type": "true","message": "Cartão atualizado com sucesso."}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getCarneListMétodo utilizado para a geração de carnês em massa, ao termino da geração de cada carnê o sistema irá enviar um Webhook informando os dados sobre o carnê.Parâmetros
NOTAS65 - É obrigatório apenas um dos dois parâmetros citados (billInternalIds, billIntegrationIds).Somente um destes parâmetros é considerado, logo, os mesmos estão em ordem de relevância. 66 - Separe o IDs por vírgula, conforme o exemplo. 67 - O evento "bill.generatePaper", informado nos eventos de Webhook, é responsavel em informar o termino da geração do carnê. |
post
https://app.sandbox.cel.cash/webservice/getCarneList
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"billInternalIds": "11,52,63"} }
{"type":"true","message":"A fila para geração de carnês começou a ser processada."}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getCarneCustomMétodo utilizado para a geração de um carnê com diferentes Contratos/Vendas ou Transações, ao término da geração do carnê o sistema irá enviar um Webhook informando os dados sobre o carnê.Parâmetros
NOTAS68 - O carnê personalizado somente irá ser gerado se todas as transações estiverem válidas para serem acrescentadas no carnê.69 - É obrigatório apenas um dos quatro parâmetros citados (billInternalIds, billIntegrationIds, transactionInternalIds, transactionIntegrationIds). Somente um destes parâmetros é considerado, logo, os mesmos estão em ordem de relevância. 70 - Separe o IDs por vírgula, conforme o exemplo. 71 - O evento "bill.generatePaperCustom", informado nos eventos de Webhook, é responsavel em informar o termino da geração do carnê. |
post
https://app.sandbox.cel.cash/webservice/getCarneCustom
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"billInternalIds": "11,52,63"} }
{"type":"true","message":"A geração do carnê foi iniciada. Assim que finalizado, você irá receber o webhook."}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/updateIndeterminatedContractValueÁrea destinada para alteração de valor de um Contrato indeterminado. Este método não irá alterar o valor das transações já geradas.Parâmetros
NOTAS72 - Um dos parâmetros, "paymentBillIntegrationId" ou "paymentBillInternalId", é necessário ser informado. |
post
https://app.sandbox.cel.cash/webservice/updateIndeterminatedContractValue
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"paymentBillIntegrationId": "1","value": "80.00"} }
{"type": "true","message": "Valor alterado com sucesso."}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/changeNfseEmissionÁrea destinada para alterar informações de emissão de nota fiscal de um contrato. Caso atualizado o momento de emissão das notas fiscais, as notas com vencimento anterior a data de atualização, não serão emitidas de acordo com a nova regra.Parâmetros
NOTAS73 - Um dos parâmetros, "paymentBillIntegrationId" ou "paymentBillInternalId", é necessário ser informado. |
post
https://app.sandbox.cel.cash/webservice/changeNfseEmission
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"paymentBillIntegrationId": "1","isToGenerate": "true","moment": "afterpay"} }
{"type": "true","message": "Informações alteradas com sucesso."}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TransaçõesÁrea destinada as transações de Contratos/Vendas, você conseguirá retornar todas transações necessárias em uma lista, estornar uma transação, cancelar uma transação, visualize uma lista contendo todos os status de transações disponíveis para seu sistema, dentre outras funcionalidades. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/addTransactionContractAcrescenta uma transação em um Contrato já existente.Parâmetros
NOTAS74 - Um dos parâmetros, "paymentBillInternalId" ou "paymentBillIntegrationId", é necessario ser informado, logo, os mesmos estão em ordem de relevância.75 - Caso o Contrato/Venda esteja encerrado, irá ser ativado novamente. |
post
https://app.sandbox.cel.cash/webservice/addTransactionContract
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"paymentBillIntegrationId": "1","payday": "2019-02-07","value": "80.00","Invoice": {"isToGenerate": "true","moment": "afterpay","subAccountBilling": "1532","description": "NF primeira mensalidade"}} }
{"type":"true","transaction":{"internalId":"1","value":"100","payday":"2018-08-07","lastUpdateDate":"2018-08-07 17:45:18","authorizationCode":"","status":"denied","statusDescription":"Negada na Operadora"}}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getTransactionRetorna informações sobre uma determinada transação.Parâmetros
NOTAS76 - É obrigatório o uso de apenas um dos parâmetros citados acima, logo, os mesmos estão em ordem de relevância. |
post
https://app.sandbox.cel.cash/webservice/getTransaction
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"transactionInternalId": "1"} }
{"type":true,"transaction":{"internalId":"89532","integrationId":null,"payday":"2020-05-20","installmentNumber":"1","tid":null,"additionalInfo":null,"customerInternalId":"3386","customerIntegrationId":"15523","link":"https://app.galaxpay.com.br/testegalaxpay/cobranca/14873/cartao","paymentBillInternalId":"14873","paymentBillIntegrationId":null,"paymentBillAdditionalInfo":null,"value":"50.00","lastUpdateDate":"2020-05-20 09:58:35","status":"pendingBoleto","statusDescription":"Em aberto","isBoleto":true,"boleto":"https://data.galaxpay.com.br/testegalaxpay/boleto/202005NDXD41J99J4W0FDRZ13DB018720095835","boletoBankLine":"03399022070600000001518988501013682610000005000","boletoBankNumber":"701915336TESTE-1189885786007956","boletoEmissionDate":"2020-05-20 09:58:35","boletoBankEmissor":"santander","qrCodePix":"ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123","imageQrCodePix":"https://data.galaxpay.com.br/testegalaxpay/pix/13485793TESTE","pageQrCodePix":"https://gpay.com.br/q/5473/cce43a96","invoiceDescription":"Teste cel_cash","invoiceStatus":"emmited","invoiceStatusDescription":"NFS-e emitida","invoicePdf":"https://data.galaxpay.com.br/testegalaxpay/download-invoice-pdf/d8ebda6e3f269f772af4dd9f949a5243","invoiceXml":"https://data.galaxpay.com.br/testegalaxpay/download-invoice-xml/d8ebda6e3f269f772af4dd9f949a5243"}}
{"type":true,"transaction":{"internalId":"89531","integrationId":null,"payday":"2020-05-20","installmentNumber":"1","tid":null,"additionalInfo":null,"customerInternalId":"3386","customerIntegrationId":"15523","link":"https://app.galaxpay.com.br/testegalaxpay/cobranca/14872/cartao","paymentBillInternalId":"14872","paymentBillIntegrationId":null,"paymentBillAdditionalInfo":null,"value":"50.00","authorizationCode":"APROVADO37BIN96787","lastUpdateDate":"2020-05-20 09:55:51","status":"captured","statusDescription":"Capturada na Operadora","isBoleto":true,"boleto":"https://data.galaxpay.com.br/testegalaxpay/boleto/202005IHBHVPDJS38LDLNOJ4JGQV3CH20095550","boletoBankLine":null,"boletoBankNumber":null,"boletoEmissionDate":null,"boletoBankEmissor":null,"brand":"Visa","truncatedNumber":"4024********4517","cardInternalId":"10100","invoiceDescription":"teste","invoiceStatus":"emmited","invoiceStatusDescription":"NFS-e emitida","invoicePdf":"https://data.galaxpay.com.br/testegalaxpay/download-invoice-pdf/fe6e8dc5301977d91e9e735f8761e669","invoiceXml":"https://data.galaxpay.com.br/testegalaxpay/download-invoice-xml/fe6e8dc5301977d91e9e735f8761e669","operator":"bin"}}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getTransactionsByPaymentBillRetorna uma lista com todas as transações de um Contrato/Venda com informações necessárias, como o status e valor.Parâmetros
NOTAS77 - É obrigatório o uso de apenas um dos parâmetros citados acima, logo, os mesmos estão em ordem de relevância.78 - Caso a transação seja do tipo de boleto o RESPONSE do método retornará a URL do boleto e a linha digitável. |
post
https://app.sandbox.cel.cash/webservice/getTransactionsByPaymentBill
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"integrationId": "1"} }
{"type":true,"paymentBillInternalId":"14875","paymentBillIntegrationId":null,"transactions":[{"internalId":"89536","integrationId":null,"payday":"2020-05-20","installmentNumber":"1","tid":null,"additionalInfo":null,"customerInternalId":"3386","customerIntegrationId":"15523","link":"https://app.galaxpay.com.br/developers/online/testegalaxpay/cobranca/14875","paymentBillInternalId":"14875","paymentBillIntegrationId":null,"paymentBillAdditionalInfo":null,"value":"50.00","lastUpdateDate":"2020-05-20 10:06:16","status":"payedBoleto","statusDescription":"Boleto compensado","isBoleto":true,"boleto":"https://data.galaxpay.com.br/testegalaxpay/boleto/2020055WBKJBILQJMPDRK0OC110I0AT20100553","boletoBankLine":"03399022070600000001518990601017482610000005000","boletoBankNumber":"329105619TESTE-1189906289476013","boletoEmissionDate":"2020-05-20 10:05:53","boletoBankEmissor":"santander","qrCodePix":"ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123","imageQrCodePix":"https://data.galaxpay.com.br/testegalaxpay/pix/13485793TESTE","pageQrCodePix":"https://gpay.com.br/q/5473/cce43a96","invoiceDescription":"Teste cel_cash","invoiceStatus":"emmited","invoiceStatusDescription":"NFS-e emitida","invoicePdf":"https://data.galaxpay.com.br/testegalaxpay/download-invoice-pdf/775ff89c24b044629e4f9bb580e81cc2","invoiceXml":"https://data.galaxpay.com.br/testegalaxpay/download-invoice-xml/775ff89c24b044629e4f9bb580e81cc2"},{"internalId":"89537","integrationId":null,"payday":"2020-06-20","installmentNumber":"2","tid":null,"additionalInfo":null,"customerInternalId":"3386","customerIntegrationId":"15523","link":"https://app.galaxpay.com.br/developers/online/testegalaxpay/cobranca/14875","paymentBillInternalId":"14875","paymentBillIntegrationId":null,"paymentBillAdditionalInfo":null,"value":"50.00","lastUpdateDate":"2020-05-20 10:05:56","status":"pendingBoleto","statusDescription":"Em aberto","isBoleto":true,"boleto":"https://data.galaxpay.com.br/testegalaxpay/boleto/202005OSGD4PB6BWN08418KKOV9AMQA20100556","boletoBankLine":null,"boletoBankNumber":null,"boletoEmissionDate":null,"boletoBankEmissor":null,"qrCodePix":null,"imageQrCodePix":null,"pageQrCodePix":null,"invoiceDescription":"Teste cel_cash","invoiceStatus":"emmited","invoiceStatusDescription":"NFS-e emitida","invoicePdf":"https://data.galaxpay.com.br/testegalaxpay/download-invoice-pdf/6daf35f34441de05ed50deeb7053f053","invoiceXml":"https://data.galaxpay.com.br/testegalaxpay/download-invoice-xml/6daf35f34441de05ed50deeb7053f053"}]}
{"type":true,"paymentBillInternalId":"14874","paymentBillIntegrationId":null,"transctions":[{"internalId":"89533","integrationId":null,"payday":"2020-05-20","installmentNumber":"1","tid":null,"additionalInfo":null,"customerInternalId":"3386","customerIntegrationId":"15523","link":"https://app.galaxpay.com.br/testegalaxpay/cobranca/14874/cartao","paymentBillInternalId":"14874","paymentBillIntegrationId":null,"paymentBillAdditionalInfo":null,"value":"50.00","authorizationCode":"APROVADO18BIN31122","lastUpdateDate":"2020-05-20 10:02:03","status":"captured","statusDescription":"Capturada na Operadora","isBoleto":true,"boleto":"https://data.galaxpay.com.br/testegalaxpay/boleto/2020051L22IDH203CATS8Q0YY2ZY9MT20100202","boletoBankLine":null,"boletoBankNumber":null,"boletoEmissionDate":null,"boletoBankEmissor":null,"brand":"Visa","truncatedNumber":"4024********4517","cardInternalId":"10100","invoiceDescription":"Nota fiscal parcela 1","invoiceStatus":"emmited","invoiceStatusDescription":"NFS-e emitida","invoicePdf":"https://data.galaxpay.com.br/testegalaxpay/download-invoice-pdf/be6ac147e7801ed99bbfc9703a992161","invoiceXml":"https://data.galaxpay.com.br/testegalaxpay/download-invoice-xml/be6ac147e7801ed99bbfc9703a992161","operator":"bin"},{"internalId":"89534","integrationId":null,"payday":"2020-06-20","installmentNumber":"2","tid":null,"additionalInfo":null,"customerInternalId":"3386","customerIntegrationId":"15523","link":"https://app.galaxpay.com.br/testegalaxpay/cobranca/14874/cartao","paymentBillInternalId":"14874","paymentBillIntegrationId":null,"paymentBillAdditionalInfo":null,"value":"50.00","authorizationCode":null,"lastUpdateDate":"","status":"notSend","statusDescription":"Ainda não enviada para operadora","isBoleto":true,"boleto":"https://data.galaxpay.com.br/testegalaxpay/boleto/202005EHHAHFVQC2J9P258C9MFFT13V20100203","boletoBankLine":null,"boletoBankNumber":null,"boletoEmissionDate":null,"boletoBankEmissor":null,"brand":"Visa","truncatedNumber":"4024********4517","cardInternalId":"10100","operator":"bin" },{"internalId":"89535","integrationId":null,"payday":"2020-07-20","installmentNumber":"3","tid":null,"additionalInfo":null,"customerInternalId":"3386","customerIntegrationId":"15523","link":"https://app.galaxpay.com.br/testegalaxpay/cobranca/14874/cartao","paymentBillInternalId":"14874","paymentBillIntegrationId":null,"paymentBillAdditionalInfo":null,"value":"50.00","authorizationCode":null,"lastUpdateDate":"","status":"notSend","statusDescription":"Ainda não enviada para operadora","isBoleto":true,"boleto":"https://data.galaxpay.com.br/testegalaxpay/boleto/202005KYV1QIEU1KNXI9U4DHBJG8VXS20100203","boletoBankLine":null,"boletoBankNumber":null,"boletoEmissionDate":null,"boletoBankEmissor":null,"brand":"Visa","truncatedNumber":"4024********4517","cardInternalId":"10100","operator":"bin"}]}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getTransactionsRetorna uma lista contendo transações de diferentes Contratos/Vendas filtradas por uma data específica.Parâmetros
|
post
https://app.sandbox.cel.cash/webservice/getTransactions
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"startDate": "2018-01-10","endDate": "2018-12-15","typeDate": "dateOfLastUpdate"} }
{"type":true,"paymentBills":[{"internalId":"14875","integrationId":"","periodicity":"monthly","quantity":"2","dateFirst":"2020-05-20","status":"active","statusDescription":"Ativa","additionalInfo":null,"link":"https://app.galaxpay.com.br/testegalaxpay/cobranca/14875/cartao","urlCarne":"https://data.galaxpay.com.br/testegalaxpay/carne/1277a2e5a05a8471a47a7fd88960ec04","infoBoleto":"Teste cel_cash","value":"50.00","customerInternalId":"3386","customerIntegrationId":"15523","customerName":"Teste Cliente cel_cash","operator":"boletoGalaxPay","operatorName":"Boleto cel_cash","transactions":[{"internalId":"89536","integrationId":null,"payday":"2020-05-20","installmentNumber":"1","tid":null,"additionalInfo":null,"customerInternalId":"3386","customerIntegrationId":"15523","link":"https://app.galaxpay.com.br/testegalaxpay/cobranca/14875/cartao","paymentBillInternalId":"14875","paymentBillIntegrationId":null,"paymentBillAdditionalInfo":null,"value":"50.00","lastUpdateDate":"2020-05-20 10:06:16","status":"payedBoleto","statusDescription":"Boleto compensado","isBoleto":true,"boleto":"https://data.galaxpay.com.br/testegalaxpay/boleto/2020055WBKJBILQJMPDRK0OC110I0AT20100553","boletoBankLine":"03399022070600000001518990601017482610000005000","boletoBankNumber":"329105619TESTE-1189906289476013","boletoEmissionDate":"2020-05-20 10:05:53","boletoBankEmissor":"santander","qrCodePix":"ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123","imageQrCodePix":"https://data.galaxpay.com.br/testegalaxpay/pix/13485793TESTE","pageQrCodePix":"https://gpay.com.br/q/5473/cce43a96","invoiceDescription":"Teste cel_cash","invoiceStatus":"emmited","invoiceStatusDescription":"NFS-e emitida","invoicePdf":"https://data.galaxpay.com.br/testegalaxpay/download-invoice-pdf/775ff89c24b044629e4f9bb580e81cc2","invoiceXml":"https://data.galaxpay.com.br/testegalaxpay/download-invoice-xml/775ff89c24b044629e4f9bb580e81cc2"}]}]}
{"type":true,"paymentBills":[{"internalId":"14874","integrationId":"","periodicity":"monthly","quantity":"3","dateFirst":"2020-05-20","status":"active","statusDescription":"Ativa","additionalInfo":null,"link":"https://app.galaxpay.com.br/testegalaxpay/cobranca/14874/cartao","value":"50.00","brand":"Visa","cardTruncate":"4024********4517","customerInternalId":"3386","customerIntegrationId":"15523","customerName":"Teste Cliente cel_cash","operator":"bin","operatorName":"BIN","transactions":[{"internalId":"89533","integrationId":null,"payday":"2020-05-20","installmentNumber":"1","tid":null,"additionalInfo":null,"customerInternalId":"3386","customerIntegrationId":"15523","link":"https://app.galaxpay.com.br/testegalaxpay/cobranca/14874/cartao","paymentBillInternalId":"14874","paymentBillIntegrationId":null,"paymentBillAdditionalInfo":null,"value":"50.00","authorizationCode":"APROVADO18BIN31122","lastUpdateDate":"2020-05-20 10:02:03","status":"captured","statusDescription":"Capturada na Operadora","isBoleto":true,"boleto":"https://data.galaxpay.com.br/testegalaxpay/boleto/2020051L22IDH203CATS8Q0YY2ZY9MT20100202","boletoBankLine":null,"boletoBankNumber":null,"boletoEmissionDate":null,"boletoBankEmissor":null,"brand":"Visa","truncatedNumber":"4024********4517","cardInternalId":"10100","invoiceDescription":"Nota fiscal parcela 1","invoiceStatus":"emmited","invoiceStatusDescription":"NFS-e emitida","invoicePdf":"https://data.galaxpay.com.br/testegalaxpay/download-invoice-pdf/be6ac147e7801ed99bbfc9703a992161","invoiceXml":"https://data.galaxpay.com.br/testegalaxpay/download-invoice-xml/be6ac147e7801ed99bbfc9703a992161","operator":"bin"}]}]}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getTransactionsByIdsRetorna uma lista contendo transações de diferentes Contratos/Vendas filtradas.Parâmetros
NOTAS79 - É obrigatório o uso de apenas um dos parâmetros citados acima, logo, os mesmos estão em ordem de relevância. |
post
https://app.sandbox.cel.cash/webservice/getTransactionsByIds
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"ids": "73991, 74002"} }
{"type":true,"transactions":[{"internalId":"89536","integrationId":null,"payday":"2020-05-20","installmentNumber":"1","tid":null,"additionalInfo":null,"customerInternalId":"3386","customerIntegrationId":"15523","link":"https://app.galaxpay.com.br/testegalaxpay/cobranca/14875/cartao","paymentBillInternalId":"14875","paymentBillIntegrationId":null,"paymentBillAdditionalInfo":null,"value":"50.00","lastUpdateDate":"2020-05-20 10:06:16","status":"payedBoleto","statusDescription":"Boleto compensado","isBoleto":true,"boleto":"https://data.galaxpay.com.br/testegalaxpay/boleto/2020055WBKJBILQJMPDRK0OC110I0AT20100553","boletoBankLine":"03399022070600000001518990601017482610000005000","boletoBankNumber":"329105619TESTE-1189906289476013","boletoEmissionDate":"2020-05-20 10:05:53","boletoBankEmissor":"santander","qrCodePix":"ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123","imageQrCodePix":"https://data.galaxpay.com.br/testegalaxpay/pix/13485793TESTE","pageQrCodePix":"https://gpay.com.br/q/5473/cce43a96","invoiceDescription":"Teste cel_cash","invoiceStatus":"emmited","invoiceStatusDescription":"NFS-e emitida","invoicePdf":"https://data.galaxpay.com.br/testegalaxpay/download-invoice-pdf/775ff89c24b044629e4f9bb580e81cc2","invoiceXml":"https://data.galaxpay.com.br/testegalaxpay/download-invoice-xml/775ff89c24b044629e4f9bb580e81cc2"}]}
{"type":true,"transactions":[{"internalId":"89533","integrationId":null,"payday":"2020-05-20","installmentNumber":"1","tid":null,"additionalInfo":null,"customerInternalId":"3386","customerIntegrationId":"15523","link":"https://app.galaxpay.com.br/testegalaxpay/cobranca/14874/cartao","paymentBillInternalId":"14874","paymentBillIntegrationId":null,"paymentBillAdditionalInfo":null,"value":"50.00","authorizationCode":"APROVADO18BIN31122","lastUpdateDate":"2020-05-20 10:02:03","status":"captured","statusDescription":"Capturada na Operadora","isBoleto":true,"boleto":"https://data.galaxpay.com.br/testegalaxpay/boleto/2020051L22IDH203CATS8Q0YY2ZY9MT20100202","boletoBankLine":null,"boletoBankNumber":null,"boletoEmissionDate":null,"boletoBankEmissor":null,"brand":"Visa","truncatedNumber":"4024********4517","cardInternalId":"10100","invoiceDescription":"Nota fiscal parcela 1","invoiceStatus":"emmited","invoiceStatusDescription":"NFS-e emitida","invoicePdf":"https://data.galaxpay.com.br/testegalaxpay/download-invoice-pdf/be6ac147e7801ed99bbfc9703a992161","invoiceXml":"https://data.galaxpay.com.br/testegalaxpay/download-invoice-xml/be6ac147e7801ed99bbfc9703a992161","operator":"bin"}]}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/updateTransactionCardÁrea destinada para atualizar o cartão de uma transação.Parâmetros
NOTAS80 - Um dos parâmetros, "transactionInternalId" ou "transactionIntegrationId", é necessario ser informado, logo, os mesmos estão em ordem de relevância.81 - Um dos parâmetros, "cardInternalId", "cardIntegrationId" ou "cardBill", é necessario ser informado, logo, os mesmos estão em ordem de relevância. |
post
https://app.sandbox.cel.cash/webservice/updateTransactionCard
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"transactionInternalId": "1","cardInternalId": "1"} }
{"type": "true","paymentBillInternalId": "123","transactions": [{"internalId": "123","value": "89.99","payday": "2018-06-21","lastUpdateDate": "2018-06-21 00:00:00","authorizationCode": "123","status": "captured","statusDescription": "Capturada na Operadora"}]}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/updateTransactionInfoÁrea destinada para alteração de informações da transação.Parâmetros
NOTAS82 - Um dos parâmetros, "paymentBillInternalId" ou "paymentBillIntegrationId", é necessario ser informado, logo, os mesmos estão em ordem de relevância.83 - Um dos parâmetros, "transactionInternalId" ou "transactionIntegrationId", é necessario ser informado, logo, os mesmos estão em ordem de relevância. 84 - Caso não enviado os parâmetros "payday","value" e "additionalInfo", estes não serão alterados. |
post
https://app.sandbox.cel.cash/webservice/updateTransactionInfo
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"paymentBillIntegrationId": "1","transactionInternalId": "1","payday": "2020-09-21","value": "80.00"} }
{"type": "true","message": "Transação alterada com sucesso."}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/chargeBackTransactionMétodo utilizado para estornar transações desejadas na operadora que foi realizada a cobrança.Parâmetros
NOTAS85 - O ID da transação para utilizar no parâmetro "transactionInternalId" pode ser obtido utilizando os resultados dos métodos de busca de transações. |
post
https://app.sandbox.cel.cash/webservice/chargeBackTransaction
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"transactionInternalId": "1"} }
{"type": "true","message": "Transação estornada com sucesso."}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/cancelTransactionMétodo utilizado para cancelar uma transação que ainda não foi capturada.Parâmetros
NOTAS86 - É obrigatório o uso de apenas um dos parâmetros citados acima, logo, os mesmos estão em ordem de relevância.87 - O ID da transação para utilizar no parâmetro "transactionInternalId" pode ser obtido utilizando os resultados dos métodos de busca de transações. |
post
https://app.sandbox.cel.cash/webservice/cancelTransaction
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"transactionInternalId": "1"} }
{"type": "true","message": "Transação cancelada com sucesso."}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/payedExternalTransactionMétodo utilizado para alterar o status de uma transação para "Paga fora do sistema".Parâmetros
NOTAS88 - É obrigatório o uso de apenas um dos parâmetros citados acima, logo, os mesmos estão em ordem de relevância.89 - O ID da transação para utilizar no parâmetro "transactionInternalId" pode ser obtido utilizando os resultados dos métodos de busca de transações. |
post
https://app.sandbox.cel.cash/webservice/payedExternalTransaction
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"transactionInternalId": "1"} }
{"type": "true","message": "Status da transação alterado com sucesso."}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/retryTransactionReenvia uma transação utilizando informações do cliente, Contrato/Venda e da transação.Parâmetros
NOTAS90 - Um dos parâmetros, "customerInternalId" ou "customerIntegrationId", é necessario ser informado.91 - Um dos parâmetros, "paymentBillInternalId" ou "paymentBillIntegrationId", é necessario ser informado. 92 - Um dos parâmetros, "transactionInternalId" ou "transactionIntegrationId", é necessario ser informado. |
post
https://app.sandbox.cel.cash/webservice/retryTransaction
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"customerInternalId": "1","paymentBillInternalId": "1","transactionInternalId": "1"} }
{"type": "true", "message": "Transação reenviada com sucesso."}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getAllStatusTransactionRetorna uma lista com todos os possíveis status das transações dentro do seu sistema. Este método não necessita de parâmetros na requisição.
|
post
https://app.sandbox.cel.cash/webservice/getAllStatusTransaction
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
}
{"type":true,"status":[{"name":"captured","displayName":"Capturada na Operadora"},{"name":"denied","displayName":"Negada na Operadora"},{"name":"processError","displayName":"Erro ao processar cobrança"},{"name":"reversed","displayName":"Estornada na Operadora"},{"name":"notSend","displayName":"Ainda não enviada para operadora"},{"name":"cancel","displayName":"Cancelada manualmente"},{"name":"reversedAnotherPlace","displayName":"Estornada fora do sistema "},{"name":"payExternal","displayName":"Paga fora do sistema"},{"name":"cancelByContract","displayName":"Cancelada ao cancelar a cobrança"},{"name":"pendingBoleto","displayName":"Em aberto"},{"name":"payedBoleto","displayName":"Boleto compensado"},{"name":"lessValueBoleto","displayName":"Pago valor menor que o original"},{"name":"moreValueBoleto","displayName":"Pago valor maior que o original"},{"name":"paidDuplicityBoleto","displayName":"Pago em duplicidade"},{"name":"free","displayName":"Isento"},{"name":"authorized","displayName":"Autorizado"},{"name":"notCompensated","displayName":"Boleto baixado por decurso de prazo"},{"name":"pendingAutoDebit","displayName":"Aguardando gerar remessa"},{"name":"inFileAutoDebit","displayName":"Remessa gerada"},{"name":"payedAutoDebit","displayName":"Débito realizado"},{"name":"deniedAutoDebit","displayName":"Débito negado"}]}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getBoletoListRetorna todos os boletos pendentes referente ao cliente desejado, que pode ser filtrado por diferentes parâmetros.Parâmetros
NOTAS93 - É obrigatório apenas um dos quatro parâmetros citados acima94 - Somente um destes parâmetros é considerado, logo, os mesmos estão em ordem de relevância. |
post
https://app.sandbox.cel.cash/webservice/getBoletoList
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"customerInternalId": "1"} }
{"type":"true","boletos":[{"id":"6768","value":"2.55","payday":"2018-05-15","paydayLimit":"2018-06-26","outdated":"true","url":"https://www.urldeboleto.com.br/boleto/424sadaskksakdkasfk6768","bankLine":"03399022070600000000700175601012176650000000255"},{"id":"6769","value":"2.55","payday":"2018-05-15","paydayLimit":"2018-06-26","outdated":"true","url":"https://www.urldeboleto.com.br/boleto/424sadaskksakdkasfk6769","bankLine":"03399022070600000000700175601012176650000000255"},{"id":"6771","value":"2.55","payday":"2018-05-15","paydayLimit":"2018-06-26","outdated":"true","url":"https://www.urldeboleto.com.br/boleto/424sadaskksakdkasfk6771","bankLine":"03399022070600000000700175601012176650000000255"},{"id":"6798","value":"2.55","payday":"2018-05-16","paydayLimit":"2018-05-16","outdated":"true","url":"https://www.urldeboleto.com.br/boleto/424sadaskksakdkasfk6798"},{"id":"6808","value":"2.55","payday":"2018-05-16","paydayLimit":"2018-05-16","outdated":"true","url":"https://www.urldeboleto.com.br/boleto/424sadaskksakdkasfk6808","bankLine":"03399022070600000000700175601012176650000000255"}]}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/captureTransactionCaptura uma transação pré autorizada.Parâmetros
|
post
https://app.sandbox.cel.cash/webservice/captureTransaction
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"transactionInternalId": "1"} }
{"type":"true","message":"Transação capturada com sucesso."}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Campos personalizadosÁrea destinada a busca de informações utilizando campos personalizados. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getPaymentBillInfoCustomFieldsRetorna todas as informações do pagamento e suas transações utilizando os filtros de campos personalizados.Parâmetros
|
post
https://app.sandbox.cel.cash/webservice/getPaymentBillInfoCustomFields
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"CustomFields": {"CP_FILIAL": "Belo horizonte","CP_FILIAL_NUMERO": "21514"},"startDate": "2018-01-10","endDate": "2018-12-15","typeDate": "dateOfLastUpdate"} }
{"type":"true","paymentBill":{"internalId":"9908","integrationId":"","periodicity":"single","quantity":"1","value":"100.50","dateFirst":"2019-02-01","customerInternalId":"806","customerIntegrationId":"1564564","customerName":"ADRIAO FERREIRA CALDEIRA","cardTruncate":"null","status":"active","statusDescription":"Ativa","transactions":[{"internalId":"69246","value":"100.50","payday":"2019-02-01","lastUpdateDate":"2019-02-01 10:11:31","authorizationCode":"","status":"pendingBoleto","statusDescription":"Em aberto","boleto":"null","boletoBankLine":"null","boletoBankNumber":"null","qrCodePix":null,"imageQrCodePix":null,"pageQrCodePix":null}]}}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AntifraudeÁrea destinada a implementação de antifraude. Atenção! Para a transação ser enviada para antifraude é necessário enviar corretamente os campos: Nome completo do cliente E-mail do cliente CPF/CNPJ do cliente Telefone e/ou celular do cliente Endereço completo do cliente |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getFingerPrintJsRetorna a URL do javascript que deverá ser adicionado em todas as páginas de seu e-commerce após o cliente logado.Parâmetros
NOTAS95 - Aconselhamos que o sessionId seja preenchido com a concatenação do seu galaxId, CPF/CNPJ do cliente logado e o número do pedido do cliente em seu e-commerce.96 - O sessionId deverá ter no mínimo 20 caracteres e no máximo 80, permitindo apenas letras e números. |
post
https://app.sandbox.cel.cash/webservice/getFingerPrintJs
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"sessionId": "65a7e35f4a6s7dfa46a78sd"} }
{"type": "true", "link": "https://app.galaxpay.com.br/galaxpay/finger-print/65a7e35f4a6s7dfa46a78sd"}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
WebhooksWebhook é uma maneira de uma aplicação fornecer informações, em tempo real, para outras aplicações.Dentro do sistema será possível configurar o endpoint que irá receber o payload. IMPORTANTE: Verifique se o seu endpoint está disponível para receber requisições. Geralmente as requisições são recebidas via porta 80 (HTTP) ou 443 (HTTPS). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getSendedWebhooksBusca os webhooks enviados de acordo com o período informadoParâmetros
|
post
https://app.sandbox.cel.cash/webservice/getSendedWebhooks
{
"Auth": {
"galaxId": "5473",
"galaxHash": "83Mw5u8988Qj6fZqS4Z8K7LzOo1j28S706R0BeFe"
}
,"Request": {"event": "transaction.status","startDate": "2019-10-15","endDate": "2019-10-26"} }
{"type":"true","data":{"event":"transaction.status","url":"http://app.galaxpay.com/retorno-webhook.php","info":{"billInternalId":"12919","billIntegrationId":"4435121687","transactionInternalId":"82999","customerIntegrationId":"6ee29628-f350-490f-bc65-7eae04dae808","customerInternalId":"6626","value":"10","payday":"2019-10-21","authorizationCode":"141573","status":"captured","statusInsertdate":"2019-10-21 09:14:21","statusDescription":"Capturada na Operadora","transactionIntegrationId":"62174aaf-6e76-4309-bfba-54945317e349","installmentNumber":"1"},"insertdate":"2019-10-21 09:14:21"}}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RetentativasO cel_cash irá efetuar 8 tentativas de comunicação com seu endpoint, até que sua aplicação responda com um código HTTP 2xx.As retentativas são realizadas em intervalos progressivos durante aproximadamente 48 horas até obter a resposta esperada. Caso o seu servidor não responda com o código 2xx em 48 horas, o cel_cash não irá mais processar esta requisição. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EventosAbaixo se encontra a lista de eventos que ao acontecer, o cel_cash irá enviar as informações para seu endpoint.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ExemploO intuito de nossas requisições é fornecer o maior número de informações possiveis para que seu sistema consiga realizar todas as ações necessárias com o que foi recebido.Ao lado, segue um exemplo de informações enviadas no evento "transaction.status". |
{
"webhookId": "23132564564",
"event": "transaction.status",
"company":
{
"id": "20",
"name": "Empresa de teste"
},
"data":
{
"billInternalId": "9",
"billIntegrationId": "45D2A",
"transactionInternalId": "2058",
"value": "55.20",
"payday": "2018-08-10",
"authorizationCode": "TID123423",
"status": "captured",
"statusInsertdate": "2018-08-10 10:08:15",
"statusDescription": "Capturada na operadora"
}
}
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Ao lado, segue um exemplo de informações enviadas no evento "sale.updateTransactions". |
{
"webhookId": "23132564564",
"event": "sale.updateTransactions",
"company":
{
"id": "20",
"name": "Empresa de teste"
},
"data":
{
"billInternalId": "9",
"billIntegrationId": "45D2A",
"totalValue": 100,
"transactions": {
"transactionInternalId": "2058",
"transactionIntegrationId": "AF224A",
"value": "100",
"payday": "2018-08-10",
"authorizationCode": "TID123423",
"status": "captured",
"statusInsertdate": "2018-08-10 10:08:15",
"statusDescription": "Capturada na operadora",
"installmentNumber": 1,
}
}
}
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ParâmetrosAbaixo se encontra a lista dos parâmetros e de suas explicações, que podem ser utilizados no envio do webhook até o endpoint.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Pacote PHP BásicoAbaixo você encontrará o download de um pacote básico de programação com os principais métodos implementados, em uma programação estruturada em PHP de fácil entendimento, para que o desenvolvimento da integração seja o mais fácil possivel.Download AjudaFicou com alguma dúvida sobre a integração? Precisa de suas credenciais de integração ou não possuímos ainda o que deseja?Não deixe de entrar em contato com a gente! Procuramos oferecer as melhores soluções para nossos clientes e estamos abertos a feedbacks, sugestões e considerações sobre nosso produto para fortalecer ainda mais a nossa parceria. |
Entre em contatoConheça nosso atendimento personalizado e surpreenda-se!Estamos prontos para atendê-lo por telefone, e-mail ou skype.
Segunda a sexta de 08h às 18h.
live:equipe.galaxpay
Documentação
06/11/2024
|