IntroduçãoBem-vindo ao Galax Pay!São muitas as vantagens que o Galax Pay 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 Galax Pay 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 Galax Pay 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 Galax Pay. 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 Galax Pay 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. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Dados de testeChaves de autenticação de teste:galaxId: 20 galaxHash: 14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y Após a finalização da integração utilizando as chaves de autenticação de teste, entre dentro do sistema do Galax Pay, e solicite pelo formulário de "Ajuda" as chaves de autenticações de produçã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 nas chaves informadas para teste. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.galaxpay.com.br/webservice/createCustomer
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"Request": {"integrationId": "1","document": "012.345.678-90","name": "Teste cliente do Galax Pay","email": "suporte.integracao@galaxpay.com.br","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.galaxpay.com.br/webservice/updateCustomer
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"Request": {"customerIntegrationId": "1","document": "012.345.678-90","name": "Teste cliente do Galax Pay","email": "suporte.integracao@galaxpay.com.br","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"}} }
{"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. |
get
https://app.galaxpay.com.br/webservice/getCustomerInfo
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"Request": {"customerInternalId": "1"} }
{"type": "true","customer": {"internalId": "123","integrationId": "123","document": "01234567890","name": "Testes Construsite","email": "email@email.com","phone": "(23)4234-23423","cellphone": "(23)9423-23423","Address": {"street": "Rua Platina","number": "1375","complement": "2° Andar","neighborhood": "Prado","city": "Belo Horizonte","state": "MG","zipCode": "30411325"}}}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/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. |
get
https://app.galaxpay.com.br/webservice/verifyPasswordCustomer
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"Request": {"customerEmail": "teste@email.com","password": "123456"} }
{"type":"true","message":"Senha correta."}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 - 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.galaxpay.com.br/webservice/createPlan
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"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.
|
get
https://app.galaxpay.com.br/webservice/getAllPlansActive
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
}
{"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
NOTAS12 - É 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. 13 - Separe o IDs por vírgula, conforme o exemplo. |
get
https://app.galaxpay.com.br/webservice/getPlansByIds
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"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
NOTAS14 - A bandeira do cartão para utilizar no parâmetro "brand" pode ser obtido utilizando o resultado do método "/getCardBrandsByOperator". |
post
https://app.galaxpay.com.br/webservice/createCard
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"Request": {"customerInternalId": "1","Card": {"integrationId": "1","number": "4716 0248 9944 1650","holder": "Cliente de exemplo Galax Pay","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
NOTAS15 - É obrigatório o uso de apenas um dos parâmetros citados acima. |
get
https://app.galaxpay.com.br/webservice/getCardsByCustomer
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"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
NOTAS16 - O nome da operadora para utilizar no parâmetro "operatorName" pode ser obtido utilizando o resultado do método "/getOperatorList". |
get
https://app.galaxpay.com.br/webservice/getCardBrandsByOperator
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"Request": {"operatorName": "cielo"} }
{"type": "true","brands": [{"name": "visa","displayName": "Visa","maxNumberOfInstallments": "12"}]}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getBrandCardRetorna a bandeira do cartão.Parâmetros
|
get
https://app.galaxpay.com.br/webservice/getBrandCard
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"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.
|
get
https://app.galaxpay.com.br/webservice/getAllBrandsEnabled
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
}
{"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
|
get
https://app.galaxpay.com.br/webservice/getMaxInstallmentByBrand
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"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.
|
get
https://app.galaxpay.com.br/webservice/getOperatorList
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
}
{"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.
|
get
https://app.galaxpay.com.br/webservice/getPaymentTypesEnabled
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
}
{"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
NOTAS17 - O nome da operadora para utilizar no parâmetro "operator" pode ser obtido utilizando o resultado do método "/getOperatorList".18 - A bandeira do cartão para utilizar no parâmetro "brand" pode ser obtido utilizando o resultado do método "/getCardBrandsByOperator". 19 - 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". 20 - Caso sejam informados algum dos parâmetros do plano(planInternalId, planIntegrationId) somente um será considerado. 21 - O campo "discounts" é aplicado somente a Contratos do typo "contract". 22 - É 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. 23 - O parâmetro "Invoice" deverá ser informado apenas quando desejar gerar notas fiscais. 24 - O parâmetro "CustomFields" deverá ser informado apenas quando deseja registrar informações nos campos personalizados dos sistema. 25 - 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.galaxpay.com.br/webservice/createPaymentBill
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"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 Galax Pay","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
NOTAS26 - O nome da operadora para utilizar no parâmetro "operator" pode ser obtido utilizando o resultado do método "/getOperatorList".27 - A bandeira do cartão para utilizar no parâmetro "brand" pode ser obtido utilizando o resultado do método "/getCardBrandsByOperator". 28 - 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". 29 - Caso sejam informados algum dos parâmetros do plano(planInternalId, planIntegrationId) somente um será considerado. 30 - O campo "discounts" é aplicado somente a Contratos do typo "contract". 31 - É 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. 32 - O parametro "password" é obrigatório caso o módulo de senha para cliente externo esteja ativo. 33 - Caso informado o parametro "Address", todos os campos de endereço, exceto o "complement", serão obrigatorios. 34 - O parâmetro "Invoice" deverá ser informado apenas quando desejar gerar notas fiscais. 35 - O parâmetro "CustomFields" deverá ser informado apenas quando deseja registrar informações nos campos personalizados dos sistema. 36 - 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. 37 - 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.galaxpay.com.br/webservice/createPaymentBillAndCustomer
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"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 Galax Pay","email": "suporte.integracao@galaxpay.com.br","phone": "(31)4020-1512","Address": {"zipCode": "30411-325","street": "Rua platina","number": "1375","neighborhood": "Prado","city": "Belo Horizonte","state": "MG","complement": "2º andar"}},"Card": {"integrationId": "1","number": "4716 0248 9944 1650","holder": "Cliente de exemplo Galax Pay","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
NOTAS38 - Caso sejam informados algum dos parâmetros do plano(planInternalId, planIntegrationId) somente um será considerado.39 - Os parâmetros "typeConditionalDiscount", "daysBeforePayDayDiscount" e "conditionalDiscount" serão utilizados apenas se o módulo "Desconto condicional por boleto" esteja ativo dentro do sistema. 40 - O campo "discounts" é aplicado somente a Contratos do typo "contract". 41 - O parâmetro "Invoice" deverá ser informado apenas quando desejar gerar notas fiscais. 42 - O parâmetro "CustomFields" deverá ser informado apenas quando deseja registrar informações nos campos personalizados dos sistema. 43 - 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.galaxpay.com.br/webservice/createPaymentBillBoleto
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"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
NOTAS44 - Caso sejam informados algum dos parâmetros do plano(planInternalId, planIntegrationId) somente um será considerado.45 - Os parâmetros "typeConditionalDiscount", "daysBeforePayDayDiscount" e "conditionalDiscount" serão utilizados apenas se o módulo "Desconto condicional por boleto" esteja ativo dentro do sistema. 46 - O campo "discounts" é aplicado somente a Contratos do typo "contract". 47 - O parâmetro "Invoice" deverá ser informado apenas quando desejar gerar notas fiscais. 48 - O parâmetro "CustomFields" deverá ser informado apenas quando deseja registrar informações nos campos personalizados dos sistema. 49 - 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. 50 - 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.galaxpay.com.br/webservice/createPaymentBillBoletoAndCustomer
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"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 Galax Pay","email": "suporte.integracao@galaxpay.com.br","phone": "(31)4020-1512","Address": {"zipCode": "30411-325","street": "Rua platina","number": "1375","neighborhood": "Prado","city": "Belo Horizonte","state": "MG","complement": "2º andar"}}} }
{"type": "true","paymentBillInternalId":"1245","message": "Contrato/Venda cadastrado com sucesso."}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getPaymentBillInfoRetorna todas as informações do pagamento e suas transações.Parâmetros
NOTAS51 - É obrigatório o uso de apenas um dos parâmetros citados acima.52 - Caso a transação seja do tipo de boleto o RESPONSE do método retornará a URL do boleto e a linha digitável. |
get
https://app.galaxpay.com.br/webservice/getPaymentBillInfo
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"Request": {"internalId": "1"} }
{"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"}]}}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getPaymentBillsByCustomerRetorna todas as informações dos pagamentos e transações de um determinado cliente em um período de tempo específico.Parâmetros
NOTAS53 - É 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.54 - Caso sejam utilizados os filtros por data, todos estes parâmetros (typeDate, startDate, endDate) serão obrigatórios. |
get
https://app.galaxpay.com.br/webservice/getPaymentBillsByCustomer
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"Request": {"customerInternalId": "1"} }
{"type": "true","paymentBills": {"internalId": "123","integrationId": "523","periodicity": "single","quantity": "1","value": "65.50","dateFirst": "2018-06-21","customerIntegrationId": "321","customerInternalId": "123","customerName": "Cliente de Teste","cardTruncate": "44444444****1111","status": "active","statusDescription": "Ativa","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"}]}}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getPaymentsWithCustomersRetorna todas as informações do cliente, de seus pagamentos e transações em um período de tempo específico.Parâmetros
|
get
https://app.galaxpay.com.br/webservice/getPaymentsWithCustomers
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"Request": {"startDate": "2018-01-10","endDate": "2018-12-15","typeDate": "dateOfLastUpdate"} }
{"type":"true","customers":[{"internalId":"3","integrationId":"PHPUNIT3171781","document":"06988994000182","name":"Cliente de Teste para Boleto(Não exclua)","email":"testeboleto@construsitebrasil.com.br","phone":"(31) 9999-9999","cellphone":"null","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"},"paymentBills":[{"internalId":"1438","integrationId":"","periodicity":"weekly","quantity":"2","dateFirst":"2018-10-19","status":"active","statusDescription":"Ativa","value":"125.00","cardTruncate":"null","customerInternalId":"3","customerIntegrationId":"PHPUNIT3171781","customerName":"Cliente de Teste para Boleto(Não exclua)","operator":"boletoGalaxPay","operatorName":"Boleto Galax Pay","transactions":[{"internalId":"5508","integrationId":"null","payday":"2018-10-19","installmentNumber":"1","paymentBillInternalId":"1438","paymentBillIntegrationId":"null","value":"125.00","lastUpdateDate":"2018-10-19 15:29:29","status":"pendingBoleto","statusDescription":"Em aberto","boleto":"http://192.168.1.250/new/construs/boleto/8ZE41SEBMNLGKHPEXNADVMK8V","boletoBankLine":"03399022070600000000700435001011476820000012500","boletoBankNumber":"TESTE-4350"},{"internalId":"5509","integrationId":"null","payday":"2018-10-26","installmentNumber":"2","paymentBillInternalId":"1438","paymentBillIntegrationId":"null","value":"125.00","lastUpdateDate":"2018-10-19 15:29:32","status":"pendingBoleto","statusDescription":"Em aberto","boleto":"http://192.168.1.250/new/construs/boleto/FROI9VHPLMKXOJDA5OFTD3P8F","boletoBankLine":"03399022070600000000700435001011276890000012500","boletoBankNumber":"TESTE-4350"}]}]},{"internalId":"196","integrationId":"798789456","document":"73647349534","name":"Cliente de Teste","email":"teste@cliente.com.br","phone":"(31) 3333-3333","cellphone":"(31) 99999-9999","insertdate":"2019-01-25 16:26:50","Address":{"street":"Rua Platina","number":"1375","complement":"null","neighborhood":"Calafate","city":"Belo Horizonte","state":"MG","zipCode":"30411330"},"paymentBills":[{"internalId":"1429","integrationId":"","periodicity":"monthly","quantity":"1","dateFirst":"2018-10-19","status":"active","statusDescription":"Ativa","value":"50.00","cardTruncate":"4024********1311","customerInternalId":"196","customerIntegrationId":"798789456","customerName":"Cliente de Teste","operator":"cielo","operatorName":"Cielo","transactions":[{"internalId":"5490","integrationId":"null","payday":"2018-10-19","installmentNumber":"1","paymentBillInternalId":"1429","paymentBillIntegrationId":"null","value":"50.00","authorizationCode":"null","lastUpdateDate":"2018-10-19 08:59:43","status":"processError","statusDescription":"Erro ao processar cobrança","truncatedNumber":"4024********1311","cardInternalId":"1457"}]}]},{"internalId":"502","integrationId":"","document":"38886217048","name":"Amanda","email":"amanda1@galaxpay.com.br","phone":"null","cellphone":"(31) 99886-0885","insertdate":"2018-10-15 17:30:36","Address":{"street":"Cornélio Procópio","number":"1","complement":"null","neighborhood":"Nova Vista","city":"Belo Horizonte","state":"MG","zipCode":"31070060"},"paymentBills":[{"internalId":"1436","integrationId":"","periodicity":"monthly","quantity":"5","dateFirst":"2018-10-19","status":"active","statusDescription":"Ativa","value":"125.63","cardTruncate":"5449********1284","customerInternalId":"502","customerIntegrationId":"","customerName":"Amanda","operator":"cielo","operatorName":"Cielo","transactions":[{"internalId":"5502","integrationId":"null","payday":"2018-10-19","installmentNumber":"1","paymentBillInternalId":"1436","paymentBillIntegrationId":"null","value":"125.63","authorizationCode":"816827","lastUpdateDate":"2018-10-19 14:41:16","status":"captured","statusDescription":"Capturada na Operadora","truncatedNumber":"5449********1284","cardInternalId":"1459"}]}]},{"internalId":"374","integrationId":"PHPUNIT374222592","document":"87584555071","name":"Nícolas Ferreira Paiva","email":"nicolas@construsitebrasil.com.br","phone":"null","cellphone":"null","insertdate":"2018-09-21 16:54:43","Address":{"street":"asdasd","number":"1375","complement":"null","neighborhood":"asdasd","city":"São João de Pirabas","state":"PA","zipCode":"68719000"},"paymentBills":[{"internalId":"1434","integrationId":"","periodicity":"single","quantity":"1","dateFirst":"2018-10-19","status":"closed","statusDescription":"Encerrada","value":"15.00","cardTruncate":"4532********6621","customerInternalId":"374","customerIntegrationId":"PHPUNIT374222592","customerName":"Nícolas Ferreira Paiva","operator":"cielo","operatorName":"Cielo","transactions":[{"internalId":"5499","integrationId":"null","payday":"2018-10-19","installmentNumber":"1","paymentBillInternalId":"1434","paymentBillIntegrationId":"null","value":"15.00","authorizationCode":"737916","lastUpdateDate":"2018-10-19 13:33:36","status":"captured","statusDescription":"Capturada na Operadora","truncatedNumber":"4532********6621","cardInternalId":"1458"}]}]}]}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/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
NOTAS55 - É obrigatório o uso de apenas um dos parâmetros citados acima.56 - Somente um destes parâmetros será considerado e por isso, estão citados acima por ordem de relevância. |
post
https://app.galaxpay.com.br/webservice/cancelPaymentBill
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"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
NOTAS57 - Um dos parâmetros, "paymentBillIntegrationId" ou "paymentBillInternalId", é necessário ser informado.58 - Um dos parâmetros, "customerIntegrationId" ou "customerInternalId", é necessário ser informado. 59 - A bandeira do cartão para utilizar no parâmetro "brand" pode ser obtida utilizando o resultado do método "/getCardBrandsByOperator". |
post
https://app.galaxpay.com.br/webservice/updatePaymentBillCard
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"Request": {"paymentBillIntegrationId": "1","customerIntegrationId": "1","Card": {"integrationId": "1","number": "4716 0248 9944 1650","holder": "Cliente de exemplo Galax Pay","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
NOTAS60 - É 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. 61 - Separe o IDs por vírgula, conforme o exemplo. 62 - O evento "bill.generatePaper", informado nos eventos de Webhook, é responsavel em informar o termino da geração do carnê. |
get
https://app.galaxpay.com.br/webservice/getCarneList
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"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
NOTAS63 - O carnê personalizado somente irá ser gerado se todas as transações estiverem válidas para serem acrescentadas no carnê.64 - É 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. 65 - Separe o IDs por vírgula, conforme o exemplo. 66 - O evento "bill.generatePaperCustom", informado nos eventos de Webhook, é responsavel em informar o termino da geração do carnê. |
get
https://app.galaxpay.com.br/webservice/getCarneCustom
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"Request": {"billInternalIds": "11,52,63"} }
{"type":"true","message":"A geração do carnê foi iniciada. Assim que finalizado, você irá receber o webhook."}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
NOTAS67 - Um dos parâmetros, "paymentBillInternalId" ou "paymentBillIntegrationId", é necessario ser informado, logo, os mesmos estão em ordem de relevância.68 - Caso o Contrato/Venda esteja encerrado, irá ser ativado novamente. 69 - O parâmetro "descriptionInvoice" deverá ser informado apenas quando desejar acrescentar uma descrição especifica à transação do Contrato que irá gerar nota fiscal por transação. |
post
https://app.galaxpay.com.br/webservice/addTransactionContract
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"Request": {"paymentBillIntegrationId": "1","payday": "2019-02-07","value": "80.00"} }
{"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
NOTAS70 - É obrigatório o uso de apenas um dos parâmetros citados acima, logo, os mesmos estão em ordem de relevância. |
get
https://app.galaxpay.com.br/webservice/getTransaction
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"Request": {"transactionInternalId": "1"} }
{"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"}}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getTransactionsByPaymentBillRetorna uma lista com todas as transações de um Contrato/Venda com informações necessárias, como o status e valor.Parâmetros
NOTAS71 - É obrigatório o uso de apenas um dos parâmetros citados acima, logo, os mesmos estão em ordem de relevância.72 - Caso a transação seja do tipo de boleto o RESPONSE do método retornará a URL do boleto e a linha digitável. |
get
https://app.galaxpay.com.br/webservice/getTransactionsByPaymentBill
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"Request": {"integrationId": "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"}]}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getTransactionsRetorna uma lista contendo transações de diferentes Contratos/Vendas filtradas por uma data específica.Parâmetros
|
get
https://app.galaxpay.com.br/webservice/getTransactions
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"Request": {"startDate": "2018-01-10","endDate": "2018-12-15","typeDate": "dateOfLastUpdate"} }
{"type": "true","paymentBills": [{"internalId": "123","integrationId": "523","value": "65.50","dateFirst": "2018-06-21","customerIntegrationId": "321","customerInternalId": "123","customerName": "Cliente de Teste","cardTruncate": "44444444****1111","status": "active","statusDescription": "Ativa","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"}]}]}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getTransactionsByIdsRetorna uma lista contendo transações de diferentes Contratos/Vendas filtradas.Parâmetros
NOTAS73 - É obrigatório o uso de apenas um dos parâmetros citados acima, logo, os mesmos estão em ordem de relevância. |
get
https://app.galaxpay.com.br/webservice/getTransactionsByIds
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"Request": {"ids": "73991, 74002"} }
{"type":"true","transactions":[{"internalId":"73991","integrationId":"null","payday":"2018-06-11","installmentNumber":"1","paymentBillInternalId":"9","paymentBillIntegrationId":"null","value":"25.00","authorizationCode":"null","lastUpdateDate":"","status":"notSend","statusDescription":"Ainda não enviada para operadora","truncatedNumber":"4539********0454","cardInternalId":"2"},{"internalId":"74002","integrationId":"null","payday":"2018-06-11","installmentNumber":"1","paymentBillInternalId":"9","paymentBillIntegrationId":"null","value":"25.00","authorizationCode":"null","lastUpdateDate":"","status":"notSend","statusDescription":"Ainda não enviada para operadora","truncatedNumber":"4539********0454","cardInternalId":"2"}]}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/updateTransactionCardÁrea destinada para atualizar o cartão de uma transação.Parâmetros
NOTAS74 - Um dos parâmetros, "transactionInternalId" ou "transactionIntegrationId", é necessario ser informado, logo, os mesmos estão em ordem de relevância.75 - Um dos parâmetros, "cardInternalId", "cardIntegrationId" ou "cardBill", é necessario ser informado, logo, os mesmos estão em ordem de relevância. |
post
https://app.galaxpay.com.br/webservice/updateTransactionCard
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"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"}]}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/chargeBackTransactionMétodo utilizado para estornar transações desejadas na operadora que foi realizada a cobrança.Parâmetros
NOTAS76 - 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.galaxpay.com.br/webservice/chargeBackTransaction
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"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
NOTAS77 - É obrigatório o uso de apenas um dos parâmetros citados acima, logo, os mesmos estão em ordem de relevância.78 - 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.galaxpay.com.br/webservice/cancelTransaction
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"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
NOTAS79 - É obrigatório o uso de apenas um dos parâmetros citados acima, logo, os mesmos estão em ordem de relevância.80 - 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.galaxpay.com.br/webservice/payedExternalTransaction
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"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
NOTAS81 - Um dos parâmetros, "customerInternalId" ou "customerIntegrationId", é necessario ser informado.82 - Um dos parâmetros, "paymentBillInternalId" ou "paymentBillIntegrationId", é necessario ser informado. 83 - Um dos parâmetros, "transactionInternalId" ou "transactionIntegrationId", é necessario ser informado. |
post
https://app.galaxpay.com.br/webservice/retryTransaction
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"Request": {"customerInternalId": "1","paymentBillInternalId": "1","transactionInternalId": "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"}]}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/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.
|
get
https://app.galaxpay.com.br/webservice/getAllStatusTransaction
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
}
{"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":"pendingBoleto","displayName":"Em aberto"},{"name":"payedBoleto","displayName":"Boleto pago"},{"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"}]}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/getBoletoListRetorna todos os boletos pendentes referente ao cliente desejado, que pode ser filtrado por diferentes parâmetros.Parâmetros
NOTAS84 - É obrigatório apenas um dos quatro parâmetros citados acima85 - Somente um destes parâmetros é considerado, logo, os mesmos estão em ordem de relevância. |
get
https://app.galaxpay.com.br/webservice/getBoletoList
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"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"}]}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
|
get
https://app.galaxpay.com.br/webservice/getPaymentBillInfoCustomFields
{
"Auth": {
"galaxId": "20",
"galaxHash": "14IRgYOkGm0AVQQBobhT9mySuEwj5v29LeEA039y"
}
,"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"}]}}
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
WebhooksWebkook é 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). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RetentativasO Galax Pay 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 Galax Pay não irá mais processar esta requisição. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EventosAbaixo se encontra a lista de eventos que ao acontecer, o Galax Pay 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"
}
}
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 presencialmente.Documentação
05/08/2019
|