Introdução

Bem-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.

Funcionalidades

Com 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 teste

Chaves 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.

Operadora Cartão Validade Cvv Resultado
Cielo 4556 4181 2420 6784 12/2019 Qualquer Capturado
Cielo 4024 0071 5039 4517 12/2019 Qualquer Negado
Bin 4556 4181 2420 6784 12/2019 Qualquer Capturado
Bin 4024 0071 5039 4517 12/2023 Qualquer Negado
GetNet 5155 9012 2228 0001 12/2019 Qualquer Capturado
GetNet 4024 0071 5039 4517 12/2019 Qualquer Negado
Global Payments 4548 8120 4940 0004 12/2019 Qualquer Capturado
Global Payments 4916 9296 2589 6753 12/2019 Qualquer Negado
Rede 4761 1200 0000 0148 01/2020 123 Aprovado
Rede 4761 1200 0000 0148 12/2019 Qualquer Negado

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

integrationId
string
255 caracteres
ID de integração utilizado para relacionar seu sistema com o Galax Pay.
ID do cliente no seu sistema
Exemplo: "1".
document
string
255 caracteres
Obrigatorio
Documento (CPF ou CNPJ)
Exemplo: "012.345.678-90".
name
string
255 caracteres
Obrigatorio
Nome
Exemplo: "Teste cliente do Galax Pay".
email
string
255 caracteres
Obrigatorio
E-mail de contato
Exemplo: "suporte.integracao@galaxpay.com.br".
phone
string
13 caracteres
Telefone ou celular para contato
Exemplo: "(31)4020-1512".
cellphone
string
14 caracteres
Celular
Exemplo: "(31)98585-8585".
password
string
255 caracteres
Senha do cliente para login externo
Exemplo: "123456".
holdIss
bool
Retém ISS?
Apenas quando ativo o módulo de "Nota fiscal" e o documento CNPJ.
Exemplo: "true".
municipalInscription
string
255 caracteres
Inscrição Municipal
Apenas quando ativo o módulo de "Nota fiscal" e o documento CNPJ.
Exemplo: "123456".
Address
Endereço de cobrança do cliente.
zipCode
string
8 caracteres
CEP
Exemplo: "30411-325".
street
string
255 caracteres
Logradouro
Exemplo: "Rua platina".
number
integer
255 caracteres
Número
Exemplo: "1375".
neighborhood
string
255 caracteres
Bairro
Exemplo: "Prado".
city
string
255 caracteres
Cidade
Exemplo: "Belo Horizonte".
state
string
2 caracteres
Estado
Exemplo: "MG".
complement
string
255 caracteres
Complemento
Exemplo: "2º andar".

NOTAS

1 - Os parâmetros "municipalInscription" e "holdIss" são obrigatórios se o módulo de Nota fiscal estiver ativo.
2 - O parametro "password" é obrigatório caso o módulo de senha para cliente externo esteja ativo.
3 - Caso informado o parametro "Address", todos os campos de endereço, exceto o "complement", serão obrigatorios.
4 - Para cadastrar Contratos/Vendas de boleto para o cliente, informe o endereço completo.
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"}

/updateCustomer

Atualiza os dados enviados do cliente.

Parâmetros

customerInternalId
string
255 caracteres
ID do cliente no Galax Pay.
Exemplo: "1".
customerIntegrationId
string
255 caracteres
ID de integração utilizado para relacionar seu sistema com o Galax Pay.
ID do cliente no seu sistema.
Exemplo: "1".
document
string
255 caracteres
Obrigatorio
Documento, podendo ser CPF ou CNPJ.
Exemplo: "012.345.678-90".
name
string
255 caracteres
Obrigatorio
Nome.
Exemplo: "Teste cliente do Galax Pay".
email
string
255 caracteres
Obrigatorio
E-mail de contato.
Exemplo: "suporte.integracao@galaxpay.com.br".
phone
string
13 caracteres
Obrigatorio
Telefone ou celular para contato
Exemplo: "(31)4020-1512".
cellphone
string
14 caracteres
Celular,com o nono digito.
Exemplo: "(31)98585-8585".
password
string
255 caracteres
Senha do cliente para login externo.
Exemplo: "123456".
integrationId
string
255 caracteres
ID de integração utilizado para relacionar seu sistema com o Galax Pay.
ID do cliente no seu sistema.
Exemplo: "1".
Address
Endereço de cobrança do cliente.
zipCode
string
8 caracteres
Obrigatorio
CEP.
Exemplo: "30411-325".
street
string
255 caracteres
Obrigatorio
Logradouro.
Exemplo: "Rua platina".
number
integer
255 caracteres
Obrigatorio
Número.
Exemplo: "1375".
neighborhood
string
255 caracteres
Obrigatorio
Bairro.
Exemplo: "Prado".
city
string
255 caracteres
Obrigatorio
Cidade.
Exemplo: "Belo Horizonte".
state
string
2 caracteres
Obrigatorio
Estado.
Exemplo: "MG".
complement
string
255 caracteres
Complemento.
Exemplo: "2º andar".

NOTAS

5 - É 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"}

/getCustomerInfo

Retorna todas as informações referente ao cliente desejado, que pode ser filtrado por diferentes parâmetros.

Parâmetros

customerInternalId
integer
11 caracteres
ID do cliente no Galax Pay.
Exemplo: "1".
customerIntegrationId
string
255 caracteres
ID de integração informado ao cadastrar o cliente pelo parâmetros "integrationId".
ID do cliente no seu sistema.
Exemplo: "1".
customerDocument
string
16 caracteres
CPF/CNPJ do cliente.
Exemplo: "012.345.678-90".
customerEmail
string
255 caracteres
Email do cliente.
Exemplo: "teste@email.com".

NOTAS

8 - É 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"}}}

/verifyPasswordCustomer

Retorna 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

customerInternalId
integer
11 caracteres
ID do cliente no Galax Pay.
Exemplo: "1".
customerIntegrationId
string
255 caracteres
ID de integração, informado ao cadastrar o cliente pelo parâmetros "integrationId".
ID do cliente no seu sistema.
Exemplo: "1".
customerEmail
string
255 caracteres
Email do cliente.
Exemplo: "teste@email.com".
password
string
Obrigatorio
Senha do cliente para verificação.
Exemplo: "123456".

NOTAS

10 - É 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

integrationId
string
255 caracteres
Obrigatorio
ID do plano utilizado para relacionar seu sistema com o Galax Pay.
ID do plano no seu sistema.
Exemplo: "1".
name
string
255 caracteres
Obrigatorio
Nome do plano
Exemplo: "Plano mensal básico".
periodicity
string
Obrigatorio
Periodicidade do Plano.
Exemplo: "monthly".

Opções

Opções disponiveis para uso em "periodicity"
Valor Descrição
single Única(Venda)
weekly Semanal
biweekly Quinzenal
monthly Mensal
bimonthly Bimestral
quarterly Trimestral
biannual Semestral
yearly Anual
quantity
string
Quantidade de parcelas.
Para parcelas indeterminadas informe "indeterminated".
Informar apenas quando o campo "periodicity" não for igual "single".

Exemplo: "12".
values
Obrigatorio
Valores de cada método de pagamento
debit
string
255 caracteres
Valor do débito para o plano.
Válido somente quando a "periodicity" for "single".
Exemplo: "50.00".
boleto
string
255 caracteres
Valor do boleto para o plano
Exemplo: "45.00".
credit
string
255 caracteres
Valor do cŕedito para o plano.
Exemplo para valor único:
"50.00".
Exemplo para valores diferentes por parcela:
{"1": "51.00","2": "52.00","3": "53.00"}

Exemplo: "50.00".
contract
string
Contrato digital a ser aceito pelo cliente ao contratar o plano.
Para o cliente aceitar este contrato deverá estar ativo o módulo de
"Contrato digital" em seu sistema.
additionalInfo
string
Observações sobre o plano, apenas para controle interno no sistema.

NOTAS

11 - 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."}

/getAllPlansActive

Retorna 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"}]}}]}

/getPlansByIds

Retorna uma lista contendo todos os planos ativos e seus preços filtrados pelos IDs que foram informados.Os índices "credit" e "boleto"

Parâmetros

ids
string
IDs dos planos no Galax Pay
Exemplo: "11,52,63".
integrationIds
string
IDs de integração dos planos no Galax Pay
Exemplo: "120C,541T,636R".

NOTAS

12 - É 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

customerInternalId
string
255 caracteres
ID do cliente no Galax Pay.
Exemplo: "1".
customerIntegrationId
string
255 caracteres
ID de integração informado ao cadastrar o cliente pelo parâmetros "integrationId".
ID do cliente no seu sistema.
Exemplo: "1".
Card
Dados do cartão do cliente.
integrationId
string
255 caracteres
ID de integração informado ao cadastrar um cartão.
ID do cartão no seu sistema.
Exemplo: "1".
number
string
255 caracteres
Obrigatorio
Número do cartão.
Exemplo: "4716 0248 9944 1650".
holder
string
30 caracteres
Obrigatorio
Nome do portador do cartão (Nome no cartão).
Exemplo: "Cliente de exemplo Galax Pay".
expiryMonth
integer
2 caracteres
Obrigatorio
Mês de expiração do cartão.
Exemplo: "04".
expiryYear
integer
4 caracteres
Obrigatorio
Ano de expiração do cartão.
Exemplo: "2023".
cvv
integer
4 caracteres
Obrigatorio
Código de segurança do cartão.
Exemplo: "541".
brand
string
36 caracteres
Obrigatorio
Bandeira do cartão
Exemplo: "visa".

NOTAS

14 - 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"}

/getCardsByCustomer

Retorna uma lista contendo as informações de todos os cartões cadastrados para determinado cliente, podendo ser filtrado por diferentes parâmetros.

Parâmetros

customerIntegrationId
string
255 caracteres
ID de integração informado ao cadastrar o cliente pelo parâmetro "integrationId".
ID do cliente no seu sistema.
Exemplo: "1".
customerInternalId
integer
11 caracteres
ID do cliente no Galax Pay.
Exemplo: "1".

NOTAS

15 - É 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"}]}

/getCardBrandsByOperator

Retorna 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

operatorName
string
255 caracteres
Obrigatorio
Nome da operadora que deseja coletar as bandeiras disponíveis.
Exemplo: "cielo".

NOTAS

16 - 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"}]}

/getBrandCard

Retorna a bandeira do cartão.

Parâmetros

cardNumber
string
255 caracteres
Obrigatorio
Número do cartão
Exemplo: "4539 4044 6689 9859".
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"}]}

/getAllBrandsEnabled

Retorna 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"}]}

/getMaxInstallmentByBrand

Retorna o limite máximo de vezes disponível para determinada bandeira.

Parâmetros

brandInternalName
string
255 caracteres
Obrigatorio
Nome interno da bandeira
Exemplo: "visa".
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.

/getOperatorList

Retorna 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"}]}

/getPaymentTypesEnabled

Retorna 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

integrationId
string
255 caracteres
ID do Contrato/Venda utilizado para relacionar seu sistema com o Galax Pay.
ID do contrato/venda no seu sistema.
Exemplo: "1".
customerInternalId
integer
11 caracteres
ID do cliente no Galax Pay.
Exemplo: "1".
customerIntegrationId
string
255 caracteres
ID de integração informado ao cadastrar o cliente pelo parâmetro "integrationId".
Exemplo: "1".
planInternalId
string
ID interno do plano no sistema.
Exemplo: "1".
planIntegrationId
string
ID para integração do plano.
Exemplo: "12321A".
typeBill
string
Obrigatorio
Tipo da cobrança a ser cadastrada.
Exemplo: "sale".

Opções

Opções disponiveis para uso em "typeBill"
Valor Descrição
contract Contrato
sale Venda
periodicity
string
Periodicidade do Contrato.
Utilizada somente quando o typeBill ser "contract".
Exemplo: "monthly".

Opções

Opções disponiveis para uso em "periodicity"
Valor Descrição
weekly Semanal
biweekly Quinzenal
monthly Mensal
bimonthly Bimestral
quarterly Trimestral
biannual Semestral
yearly Anual
payday
date
YYYY-mm-dd
Obrigatorio
Data de pagamento da 1ª transação.
Exemplo: "2018-06-21".
value
decimal
Obrigatorio
Valor do Contrato/Venda.
Exemplo: "80.00".
numberOfInstallments
integer
11 caracteres
Obrigatorio
Número de parcelas.
Utilizada somente quando o typeBill ser "sale".
Exemplo: "2".
quantity
string
Quantidade de transações. Caso a cobrança seja indeterminada informe "indeterminated".
Utilizada somente quando o typeBill ser "contract".
Exemplo: "4".
paymentType
string
Obrigatorio
Ação para realizar o cadastro de "Contrato/Venda".
Exemplo: "newCard".

Opções

Opções disponiveis para uso em "paymentType"
Valor Descrição
newCard Para pagamento com um cartão novo, informe dentro de “Card” os dados do cartão.
existingCard Para pagamento com um cartão existente, informe dentro de "Card" o "integrationId".
link Para pagamento com link externo não é necessário informar "Card" pois o mesmo não será considerado.
operator
string
Nome da operadora que deseja realizar a cobrança.
Exemplo: "cielo".
additionalInfo
string
255 caracteres
Observações sobre o Contrato/Venda, apenas para controle interno no sistema.
Exemplo: "Contrato/Venda X5A2145A".
integrationIds
ID de cada transação utilizado para relacionar seu sistema com o Galax Pay.
Irá ser aplicado o integrationId somente nas transações informadas, as demais transações irão ficar vazias.

Informe a transação que deseja aplicar o desconto pelo número da parcela.
Exemplo: se quer informar o integrationId na terceira transação informe "3"
Válido para ser utilizado apenas com o campo "typeBill" igual a "contract".
1
string
255 caracteres
ID da primeira transação no seu sistema.
Exemplo: "{"integrationId": "123456@"}".
2
string
255 caracteres
ID da segunda transação no seu sistema.
Exemplo: "{"integrationId": "9875a8@"}".
discounts
Valor de desconto para cada transação. Irá ser aplicado o desconto somente nas transações informadas, as demais transações irão ficar com o valor do Contratos.

Informe a transação que deseja aplicar o desconto pelo número da parcela.
Exemplo: se quer aplicar desconto na terceira transação informe "3".
1
string
255 caracteres
Informações sobre o desconto da primeira transação.
Exemplo: "{"valueDiscount": "10.00", "info": "Desconto da primeira mensalidade"}".
2
string
255 caracteres
Informações sobre o desconto da segunda transação.
Exemplo: "{"valueDiscount": "10.00"}".
Card
Dados do cartão do cliente.
integrationId
string
255 caracteres
ID de integração informado ao cadastrar um cartão.
ID do cartão no seu sistema.
Exemplo: "1".
number
string
255 caracteres
Obrigatorio
Número do cartão.
Exemplo: "4716 0248 9944 1650".
holder
string
30 caracteres
Obrigatorio
Nome do portador do cartão (Nome no cartão).
Exemplo: "Cliente de exemplo Galax Pay".
expiryMonth
integer
2 caracteres
Obrigatorio
Mês de expiração do cartão.
Exemplo: "04".
expiryYear
integer
4 caracteres
Obrigatorio
Ano de expiração do cartão.
Exemplo: "2023".
cvv
integer
4 caracteres
Obrigatorio
Código de segurança do cartão.
Exemplo: "541".
brand
string
36 caracteres
Obrigatorio
Bandeira do cartão
Exemplo: "visa".
Invoice
Informações necessárias a serem informadas para a geração de nota fiscal
isToGenerate
bool
Obrigatorio
Utilizado para informar se é para gerar nota fiscal.
Exemplo: "true".
type
string
255 caracteres
Obrigatorio
Utilizado para informar como as notas fiscais irão ser geradas.
Exemplo: "uniqueNf".

Opções

Opções disponiveis para uso em "type"
Valor Descrição
uniqueNf Gerar uma única nota fiscal para a venda.
transactionsNf Gerar uma nota fiscal para cada parcela (transação).
Obrigatorio
descriptions
Descrição das transações para a geração de nota fiscal.
Caso não seja informado a descrição especifica da transação, iremos aplicar a ela o que foi informado na última descrição.
1
string
255 caracteres

Exemplo: "{"info": "NF primeira mensalidade"}".
2
string
255 caracteres

Exemplo: "{"info": "NF segunda mensalidade"}".
CustomFields
Informações para serem salvas dentro dos campos personalizados configurados dentro do sistema.
Deve ser utilizado a TAG gerada para campo personalizado dentro do sistema.
CP_FILIAL
string
Valor correspondente a ser salvo no campo personalizado de filial.
Exemplo: "Belo horizonte".
CP_FILIAL_NUMERO
string
Valor correspondente a ser salvo no campo personalizado de número da filial.
Exemplo: "21514".

NOTAS

17 - 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.
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

integrationId
string
255 caracteres
ID do Contrato/Venda utilizado para relacionar seu sistema com o Galax Pay.
ID do contrato/venda no seu sistema.
Exemplo: "1".
planInternalId
string
ID interno do plano no sistema.
Exemplo: "1".
planIntegrationId
string
ID para integração do plano.
Exemplo: "12321A".
typeBill
string
Obrigatorio
Tipo da cobrança a ser cadastrada.
Exemplo: "sale".

Opções

Opções disponiveis para uso em "typeBill"
Valor Descrição
contract Contrato
sale Venda
periodicity
string
Periodicidade do Contrato.
Utilizada somente quando o typeBill ser "contract".
Exemplo: "monthly".

Opções

Opções disponiveis para uso em "periodicity"
Valor Descrição
weekly Semanal
biweekly Quinzenal
monthly Mensal
bimonthly Bimestral
quarterly Trimestral
biannual Semestral
yearly Anual
payday
date
YYYY-mm-dd
Obrigatorio
Data de pagamento da 1ª transação.
Exemplo: "2018-06-21".
value
decimal
Obrigatorio
Valor do Contrato/Venda.
Exemplo: "80.00".
numberOfInstallments
integer
11 caracteres
Obrigatorio
Número de parcelas.
Utilizada somente quando o typeBill ser "sale".
Exemplo: "2".
quantity
string
Quantidade de transações. Caso a cobrança seja indeterminada informe "indeterminated".
Utilizada somente quando o typeBill ser "contract".
Exemplo: "4".
paymentType
string
Obrigatorio
Ação para realizar o cadastro de "Contrato/Venda".
Exemplo: "newCard".

Opções

Opções disponiveis para uso em "paymentType"
Valor Descrição
newCard Para pagamento com um cartão novo, informe dentro de “Card” os dados do cartão.
existingCard Para pagamento com um cartão existente, informe dentro de "Card" o "integrationId".
link Para pagamento com link externo não é necessário informar "Card" pois o mesmo não será considerado.
operator
string
Nome da operadora que deseja realizar a cobrança.
Exemplo: "cielo".
additionalInfo
string
255 caracteres
Observações sobre o Contrato/Venda, apenas para controle interno no sistema.
Exemplo: "Contrato/Venda X5A2145A".
integrationIds
ID de cada transação utilizado para relacionar seu sistema com o Galax Pay.
Irá ser aplicado o integrationId somente nas transações informadas, as demais transações irão ficar vazias.

Informe a transação que deseja aplicar o desconto pelo número da parcela.
Exemplo: se quer informar o integrationId na terceira transação informe "3"
Válido para ser utilizado apenas com o campo "typeBill" igual a "contract".
1
string
255 caracteres
ID da primeira transação no seu sistema.
Exemplo: "{"integrationId": "123456@"}".
2
string
255 caracteres
ID da segunda transação no seu sistema.
Exemplo: "{"integrationId": "9875a8@"}".
discounts
Valor de desconto para cada transação. Irá ser aplicado o desconto somente nas transações informadas, as demais transações irão ficar com o valor do Contratos.

Informe a transação que deseja aplicar o desconto pelo número da parcela.
Exemplo: se quer aplicar desconto na terceira transação informe "3".
1
string
255 caracteres
Informações sobre o desconto da primeira transação.
Exemplo: "{"valueDiscount": "10.00", "info": "Desconto da primeira mensalidade"}".
2
string
255 caracteres
Informações sobre o desconto da segunda transação.
Exemplo: "{"valueDiscount": "10.00"}".
Customer
Informações do cliente a ser cadastrado ou alterado e que possuirá o Contrato/Venda.
integrationId
string
255 caracteres
ID de integração utilizado para relacionar seu sistema com o Galax Pay.
ID do cliente no seu sistema
Exemplo: "1".
document
string
255 caracteres
Obrigatorio
Documento (CPF ou CNPJ)
Exemplo: "012.345.678-90".
name
string
255 caracteres
Obrigatorio
Nome
Exemplo: "Teste cliente do Galax Pay".
email
string
255 caracteres
Obrigatorio
E-mail de contato
Exemplo: "suporte.integracao@galaxpay.com.br".
phone
string
13 caracteres
Telefone ou celular para contato
Exemplo: "(31)4020-1512".
cellphone
string
14 caracteres
Celular
Exemplo: "(31)98585-8585".
password
string
255 caracteres
Senha do cliente para login externo
Exemplo: "123456".
holdIss
bool
Retém ISS?
Apenas quando ativo o módulo de "Nota fiscal" e o documento CNPJ.
Exemplo: "true".
municipalInscription
string
255 caracteres
Inscrição Municipal
Apenas quando ativo o módulo de "Nota fiscal" e o documento CNPJ.
Exemplo: "123456".
Address
Endereço de cobrança do cliente.
zipCode
string
8 caracteres
CEP
Exemplo: "30411-325".
street
string
255 caracteres
Logradouro
Exemplo: "Rua platina".
number
integer
255 caracteres
Número
Exemplo: "1375".
neighborhood
string
255 caracteres
Bairro
Exemplo: "Prado".
city
string
255 caracteres
Cidade
Exemplo: "Belo Horizonte".
state
string
2 caracteres
Estado
Exemplo: "MG".
complement
string
255 caracteres
Complemento
Exemplo: "2º andar".
Card
Dados do cartão do cliente.
integrationId
string
255 caracteres
ID de integração informado ao cadastrar um cartão.
ID do cartão no seu sistema.
Exemplo: "1".
number
string
255 caracteres
Obrigatorio
Número do cartão.
Exemplo: "4716 0248 9944 1650".
holder
string
30 caracteres
Obrigatorio
Nome do portador do cartão (Nome no cartão).
Exemplo: "Cliente de exemplo Galax Pay".
expiryMonth
integer
2 caracteres
Obrigatorio
Mês de expiração do cartão.
Exemplo: "04".
expiryYear
integer
4 caracteres
Obrigatorio
Ano de expiração do cartão.
Exemplo: "2023".
cvv
integer
4 caracteres
Obrigatorio
Código de segurança do cartão.
Exemplo: "541".
brand
string
36 caracteres
Obrigatorio
Bandeira do cartão
Exemplo: "visa".
Invoice
Informações necessárias a serem informadas para a geração de nota fiscal
isToGenerate
bool
Obrigatorio
Utilizado para informar se é para gerar nota fiscal.
Exemplo: "true".
type
string
255 caracteres
Obrigatorio
Utilizado para informar como as notas fiscais irão ser geradas.
Exemplo: "uniqueNf".

Opções

Opções disponiveis para uso em "type"
Valor Descrição
uniqueNf Gerar uma única nota fiscal para a venda.
transactionsNf Gerar uma nota fiscal para cada parcela (transação).
Obrigatorio
descriptions
Descrição das transações para a geração de nota fiscal.
Caso não seja informado a descrição especifica da transação, iremos aplicar a ela o que foi informado na última descrição.
1
string
255 caracteres

Exemplo: "{"info": "NF primeira mensalidade"}".
2
string
255 caracteres

Exemplo: "{"info": "NF segunda mensalidade"}".
CustomFields
Informações para serem salvas dentro dos campos personalizados configurados dentro do sistema.
Deve ser utilizado a TAG gerada para campo personalizado dentro do sistema.
CP_FILIAL
string
Valor correspondente a ser salvo no campo personalizado de filial.
Exemplo: "Belo horizonte".
CP_FILIAL_NUMERO
string
Valor correspondente a ser salvo no campo personalizado de número da filial.
Exemplo: "21514".

NOTAS

25 - O nome da operadora para utilizar no parâmetro "operator" pode ser obtido utilizando o resultado do método "/getOperatorList".
26 - A bandeira do cartão para utilizar no parâmetro "brand" pode ser obtido utilizando o resultado do método "/getCardBrandsByOperator".
27 - 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".
28 - Caso sejam informados algum dos parâmetros do plano(planInternalId, planIntegrationId) somente um será considerado.
29 - O campo "discounts" é aplicado somente a Contratos do typo "contract".
30 - É 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.
31 - O parametro "password" é obrigatório caso o módulo de senha para cliente externo esteja ativo.
32 - Caso informado o parametro "Address", todos os campos de endereço, exceto o "complement", serão obrigatorios.
33 - O parâmetro "Invoice" deverá ser informado apenas quando desejar gerar notas fiscais.
34 - O parâmetro "CustomFields" deverá ser informado apenas quando deseja registrar informações nos campos personalizados dos sistema.
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": "2","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

integrationId
string
255 caracteres
ID do Contrato/Venda utilizado para relacionar seu sistema com o Galax Pay.
ID do contrato/venda no seu sistema.
Exemplo: "1".
typeBill
string
Obrigatorio
Tipo da cobrança a ser cadastrada.
Exemplo: "contract".

Opções

Opções disponiveis para uso em "typeBill"
Valor Descrição
contract Contrato
sale Venda
periodicity
string
Periodicidade do Contrato.
Exemplo: "monthly".

Opções

Opções disponiveis para uso em "periodicity"
Valor Descrição
weekly Semanal
biweekly Quinzenal
monthly Mensal
bimonthly Bimestral
quarterly Trimestral
biannual Semestral
yearly Anual
payday
date
YYYY-mm-dd
Obrigatorio
Data de pagamento da 1ª transação.
Exemplo: "2018-06-21".
value
decimal
Obrigatorio
Valor do Contrato/Venda.
Exemplo: "80.00".
quantity
string
Obrigatorio
Quantidade de transações. Caso a cobrança seja indeterminada informe "indeterminated".
Exemplo: "4".
customerIntegrationId
string
255 caracteres
Obrigatorio
ID de integração informado ao cadastrar o cliente pelo parâmetro "integrationId".
ID do cliente no seu sistema.
Exemplo: "1".
integrationIds
ID de cada transação utilizado para relacionar seu sistema com o Galax Pay.
Irá ser aplicado o integrationId somente nas transações informadas, as demais transações irão ficar vazias.

Informe a transação que deseja aplicar o desconto pelo número da parcela.
Exemplo: se quer informar o integrationId na terceira transação informe "3"
Válido para ser utilizado apenas com o campo "typeBill" igual a "contract".
1
string
255 caracteres
ID da primeira transação no seu sistema.
Exemplo: "{"integrationId": "123456@"}".
2
string
255 caracteres
ID da segunda transação no seu sistema.
Exemplo: "{"integrationId": "9875a8@"}".
discounts
Valor de desconto para cada transação. Irá ser aplicado o desconto somente nas transações informadas, as demais transações irão ficar com o valor do Contratos.

Informe a transação que deseja aplicar o desconto pelo número da parcela.
Exemplo: se quer aplicar desconto na terceira transação informe "3".
1
string
255 caracteres
Informações sobre o desconto da primeira transação.
Exemplo: "{"valueDiscount": "10.00", "info": "Desconto da primeira mensalidade"}".
2
string
255 caracteres
Informações sobre o desconto da segunda transação.
Exemplo: "{"valueDiscount": "10.00"}".
planInternalId
string
ID interno do plano no sistema.
Exemplo: "1".
planIntegrationId
string
ID para integração do plano.
Exemplo: "12321A".
fineBoleto
decimal
36 caracteres
Porcentagem de multa por atraso.
Exemplo: "2.50".
interestBoleto
decimal
36 caracteres
Porcentagem de juros ao mês.
Exemplo: "1.25".
infoBoleto
string
255 caracteres
Observações do boleto, irá ser acrescentado na área de "Instruções" do boleto. Para quebrar linha utilize "\n", sendo que será exibido no máximo 3 linhas.
Exemplo: "Cobrança referente ao servico de manutenção de computadores".
typeConditionalDiscount
decimal
36 caracteres
Tipo do desconto condicional a ser aplicado
Exemplo: "percent".

Opções

Opções disponiveis para uso em "typeConditionalDiscount"
Valor Descrição
percent Percentual (%)
fixed Valor Fixo (R$)
daysBeforePayDayDiscount
decimal
36 caracteres
Quantidade de dias que o desconto será válido
Exemplo: "5".

Opções

Opções disponiveis para uso em "daysBeforePayDayDiscount"
Valor Descrição
0 Até a data de vencimento
1 Até 1 dia antes da data de vencimento
2 Até 2 dias antes da data de vencimento
3 Até 3 dias antes da data de vencimento
4 Até 4 dias antes da data de vencimento
5 Até 5 dias antes da data de vencimento
6 Até 6 dias antes da data de vencimento
7 Até 7 dias antes da data de vencimento
8 Até 8 dias antes da data de vencimento
9 Até 9 dias antes da data de vencimento
10 Até 10 dias antes da data de vencimento
11 Até 11 dias antes da data de vencimento
12 Até 12 dias antes da data de vencimento
13 Até 13 dias antes da data de vencimento
14 Até 14 dias antes da data de vencimento
15 Até 15 dias antes da data de vencimento
conditionalDiscount
decimal
36 caracteres
Desconto a ser aplicado
Exemplo: "R$ 75,00 ou 75,50%".
Invoice
Informações necessárias a serem informadas para a geração de nota fiscal
isToGenerate
bool
Obrigatorio
Utilizado para informar se é para gerar nota fiscal.
Exemplo: "true".
type
string
255 caracteres
Obrigatorio
Utilizado para informar como as notas fiscais irão ser geradas.
Exemplo: "uniqueNf".

Opções

Opções disponiveis para uso em "type"
Valor Descrição
uniqueNf Gerar uma única nota fiscal para a venda.
transactionsNf Gerar uma nota fiscal para cada parcela (transação).
Obrigatorio
descriptions
Descrição das transações para a geração de nota fiscal.
Caso não seja informado a descrição especifica da transação, iremos aplicar a ela o que foi informado na última descrição.
1
string
255 caracteres

Exemplo: "{"info": "NF primeira mensalidade"}".
2
string
255 caracteres

Exemplo: "{"info": "NF segunda mensalidade"}".
CustomFields
Informações para serem salvas dentro dos campos personalizados configurados dentro do sistema.
Deve ser utilizado a TAG gerada para campo personalizado dentro do sistema.
CP_FILIAL
string
Valor correspondente a ser salvo no campo personalizado de filial.
Exemplo: "Belo horizonte".
CP_FILIAL_NUMERO
string
Valor correspondente a ser salvo no campo personalizado de número da filial.
Exemplo: "21514".

NOTAS

35 - Caso sejam informados algum dos parâmetros do plano(planInternalId, planIntegrationId) somente um será considerado.
36 - Os parâmetros "typeConditionalDiscount", "daysBeforePayDayDiscount" e "conditionalDiscount" serão utilizados apenas se o módulo "Desconto condicional por boleto" esteja ativo dentro do sistema.
37 - O campo "discounts" é aplicado somente a Contratos do typo "contract".
38 - O parâmetro "Invoice" deverá ser informado apenas quando desejar gerar notas fiscais.
39 - O parâmetro "CustomFields" deverá ser informado apenas quando deseja registrar informações nos campos personalizados dos sistema.
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

integrationId
string
255 caracteres
ID do Contrato/Venda utilizado para relacionar seu sistema com o Galax Pay.
ID do contrato/venda no seu sistema.
Exemplo: "1".
typeBill
string
Obrigatorio
Tipo da cobrança a ser cadastrada.
Exemplo: "contract".

Opções

Opções disponiveis para uso em "typeBill"
Valor Descrição
contract Contrato
sale Venda
periodicity
string
Periodicidade do Contrato.
Exemplo: "monthly".

Opções

Opções disponiveis para uso em "periodicity"
Valor Descrição
weekly Semanal
biweekly Quinzenal
monthly Mensal
bimonthly Bimestral
quarterly Trimestral
biannual Semestral
yearly Anual
payday
date
YYYY-mm-dd
Obrigatorio
Data de pagamento da 1ª transação.
Exemplo: "2018-06-21".
value
decimal
Obrigatorio
Valor do Contrato/Venda.
Exemplo: "80.00".
quantity
string
Obrigatorio
Quantidade de transações. Caso a cobrança seja indeterminada informe "indeterminated".
Exemplo: "4".
integrationIds
ID de cada transação utilizado para relacionar seu sistema com o Galax Pay.
Irá ser aplicado o integrationId somente nas transações informadas, as demais transações irão ficar vazias.

Informe a transação que deseja aplicar o desconto pelo número da parcela.
Exemplo: se quer informar o integrationId na terceira transação informe "3"
Válido para ser utilizado apenas com o campo "typeBill" igual a "contract".
1
string
255 caracteres
ID da primeira transação no seu sistema.
Exemplo: "{"integrationId": "123456@"}".
2
string
255 caracteres
ID da segunda transação no seu sistema.
Exemplo: "{"integrationId": "9875a8@"}".
discounts
Valor de desconto para cada transação. Irá ser aplicado o desconto somente nas transações informadas, as demais transações irão ficar com o valor do Contratos.

Informe a transação que deseja aplicar o desconto pelo número da parcela.
Exemplo: se quer aplicar desconto na terceira transação informe "3".
1
string
255 caracteres
Informações sobre o desconto da primeira transação.
Exemplo: "{"valueDiscount": "10.00", "info": "Desconto da primeira mensalidade"}".
2
string
255 caracteres
Informações sobre o desconto da segunda transação.
Exemplo: "{"valueDiscount": "10.00"}".
planInternalId
string
ID interno do plano no sistema.
Exemplo: "1".
planIntegrationId
string
ID para integração do plano.
Exemplo: "12321A".
fineBoleto
decimal
36 caracteres
Porcentagem de multa por atraso.
Exemplo: "2.50".
interestBoleto
decimal
36 caracteres
Porcentagem de juros ao mês.
Exemplo: "1.25".
infoBoleto
string
255 caracteres
Observações do boleto, irá ser acrescentado na área de "Instruções" do boleto. Para quebrar linha utilize "\n", sendo que será exibido no máximo 3 linhas.
Exemplo: "Cobrança referente ao servico de manutenção de computadores".
typeConditionalDiscount
decimal
36 caracteres
Tipo do desconto condicional a ser aplicado
Exemplo: "percent".

Opções

Opções disponiveis para uso em "typeConditionalDiscount"
Valor Descrição
percent Percentual (%)
fixed Valor Fixo (R$)
daysBeforePayDayDiscount
decimal
36 caracteres
Quantidade de dias que o desconto será válido
Exemplo: "5".

Opções

Opções disponiveis para uso em "daysBeforePayDayDiscount"
Valor Descrição
0 Até a data de vencimento
1 Até 1 dia antes da data de vencimento
2 Até 2 dias antes da data de vencimento
3 Até 3 dias antes da data de vencimento
4 Até 4 dias antes da data de vencimento
5 Até 5 dias antes da data de vencimento
6 Até 6 dias antes da data de vencimento
7 Até 7 dias antes da data de vencimento
8 Até 8 dias antes da data de vencimento
9 Até 9 dias antes da data de vencimento
10 Até 10 dias antes da data de vencimento
11 Até 11 dias antes da data de vencimento
12 Até 12 dias antes da data de vencimento
13 Até 13 dias antes da data de vencimento
14 Até 14 dias antes da data de vencimento
15 Até 15 dias antes da data de vencimento
conditionalDiscount
decimal
36 caracteres
Desconto a ser aplicado
Exemplo: "R$ 75,00 ou 75,50%".
Invoice
Informações necessárias a serem informadas para a geração de nota fiscal
isToGenerate
bool
Obrigatorio
Utilizado para informar se é para gerar nota fiscal.
Exemplo: "true".
type
string
255 caracteres
Obrigatorio
Utilizado para informar como as notas fiscais irão ser geradas.
Exemplo: "uniqueNf".

Opções

Opções disponiveis para uso em "type"
Valor Descrição
uniqueNf Gerar uma única nota fiscal para a venda.
transactionsNf Gerar uma nota fiscal para cada parcela (transação).
Obrigatorio
descriptions
Descrição das transações para a geração de nota fiscal.
Caso não seja informado a descrição especifica da transação, iremos aplicar a ela o que foi informado na última descrição.
1
string
255 caracteres

Exemplo: "{"info": "NF primeira mensalidade"}".
2
string
255 caracteres

Exemplo: "{"info": "NF segunda mensalidade"}".
Customer
Informações do cliente a ser cadastrado ou alterado e que possuirá o Contrato/Venda.
integrationId
string
255 caracteres
ID de integração utilizado para relacionar seu sistema com o Galax Pay.
ID do cliente no seu sistema
Exemplo: "1".
document
string
255 caracteres
Obrigatorio
Documento (CPF ou CNPJ)
Exemplo: "012.345.678-90".
name
string
255 caracteres
Obrigatorio
Nome
Exemplo: "Teste cliente do Galax Pay".
email
string
255 caracteres
Obrigatorio
E-mail de contato
Exemplo: "suporte.integracao@galaxpay.com.br".
phone
string
13 caracteres
Telefone ou celular para contato
Exemplo: "(31)4020-1512".
cellphone
string
14 caracteres
Celular
Exemplo: "(31)98585-8585".
password
string
255 caracteres
Senha do cliente para login externo
Exemplo: "123456".
holdIss
bool
Retém ISS?
Apenas quando ativo o módulo de "Nota fiscal" e o documento CNPJ.
Exemplo: "true".
municipalInscription
string
255 caracteres
Inscrição Municipal
Apenas quando ativo o módulo de "Nota fiscal" e o documento CNPJ.
Exemplo: "123456".
Address
Endereço de cobrança do cliente.
zipCode
string
8 caracteres
CEP
Exemplo: "30411-325".
street
string
255 caracteres
Logradouro
Exemplo: "Rua platina".
number
integer
255 caracteres
Número
Exemplo: "1375".
neighborhood
string
255 caracteres
Bairro
Exemplo: "Prado".
city
string
255 caracteres
Cidade
Exemplo: "Belo Horizonte".
state
string
2 caracteres
Estado
Exemplo: "MG".
complement
string
255 caracteres
Complemento
Exemplo: "2º andar".
CustomFields
Informações para serem salvas dentro dos campos personalizados configurados dentro do sistema.
Deve ser utilizado a TAG gerada para campo personalizado dentro do sistema.
CP_FILIAL
string
Valor correspondente a ser salvo no campo personalizado de filial.
Exemplo: "Belo horizonte".
CP_FILIAL_NUMERO
string
Valor correspondente a ser salvo no campo personalizado de número da filial.
Exemplo: "21514".

NOTAS

40 - Os parâmetros "municipalInscription" e "holdIss" são obrigatórios se o módulo de Nota fiscal estiver ativo.
41 - Caso sejam informados algum dos parâmetros do plano(planInternalId, planIntegrationId) somente um será considerado.
42 - Os parâmetros "typeConditionalDiscount", "daysBeforePayDayDiscount" e "conditionalDiscount" serão utilizados apenas se o módulo "Desconto condicional por boleto" esteja ativo dentro do sistema.
43 - O campo "discounts" é aplicado somente a Contratos do typo "contract".
44 - O parâmetro "Invoice" deverá ser informado apenas quando desejar gerar notas fiscais.
45 - O parâmetro "CustomFields" deverá ser informado apenas quando deseja registrar informações nos campos personalizados dos sistema.
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."}

/getPaymentBillInfo

Retorna todas as informações do pagamento e suas transações.

Parâmetros

internalId
integer
11 caracteres
ID do Contrato/Venda no Galax Pay.
Exemplo: "1".
integrationId
string
255 caracteres
ID do Contrato/Venda que é utilizado para relacionar seu sistema com o Galax Pay.
ID do Contrato/Venda no seu sistema.
Exemplo: "1".

NOTAS

46 - É obrigatório o uso de apenas um dos parâmetros citados acima.
47 - 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"}]}}

/getPaymentBillsByCustomer

Retorna todas as informações dos pagamentos e transações de um determinado cliente em um período de tempo específico.

Parâmetros

customerInternalId
string
255 caracteres
ID do cliente no Galax Pay.
Exemplo: "1".
customerIntegrationId
string
255 caracteres
ID de integração informado ao cadastrar o cliente pelo parâmetro "integrationId".
ID do cliente no seu sistema.
Exemplo: "1".
customerDocument
string
255 caracteres
Documento, podendo ser CPF ou CNPJ, do cliente.
Exemplo: "012.345.678-90".
customerEmail
string
255 caracteres
E-mail de contato do cliente.
Exemplo: "suporte.integracao@galaxpay.com.br".
startDate
date
YYYY-mm-dd
Data inicial que deseja filtrar os resultados.
Exemplo: "2018-01-10".
endDate
date
YYYY-mm-dd
Data final que deseja filtrar os resultados.
Exemplo: "2018-12-15".
typeDate
string
Tipo de data a filtrar.
Exemplo: "dateOfLastUpdate".

Opções

Opções disponiveis para uso em "typeDate"
Valor Descrição
dateOfLastUpdate Data em que a transação foi capturada ou negada.
expirationDateOfTransaction Data de vencimento da transação.

NOTAS

48 - É 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.
49 - 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"}]}}

/getPaymentsWithCustomers

Retorna todas as informações do cliente, de seus pagamentos e transações em um período de tempo específico.

Parâmetros

startDate
date
YYYY-mm-dd
Obrigatorio
Data inicial que deseja filtrar os resultados.
Exemplo: "2018-01-10".
endDate
date
YYYY-mm-dd
Obrigatorio
Data final que deseja filtrar os resultados.
Exemplo: "2018-12-15".
typeDate
string
Obrigatorio
Tipo de data a filtrar.
Exemplo: "dateOfLastUpdate".

Opções

Opções disponiveis para uso em "typeDate"
Valor Descrição
dateOfLastUpdate Data em que a transação foi capturada ou negada.
expirationDateOfTransaction Data de vencimento da transação.
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

paymentBillInternalId
integer
11 caracteres
ID do Contrato/Venda no Galax Pay.
Exemplo: "1".
paymentBillIntegrationId
string
255 caracteres
ID de integração informado ao cadastrar o Contrato/Venda pelo parâmetro "integrationId".
ID do contrato/venda no seu sistema.
Exemplo: "1".

NOTAS

50 - É obrigatório o uso de apenas um dos parâmetros citados acima.
51 - 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

paymentBillInternalId
integer
11 caracteres
ID do Contrato/Venda no Galax Pay.
Exemplo: "1".
paymentBillIntegrationId
string
255 caracteres
ID de integração informado ao cadastrar o Contrato/Venda pelo parâmetro "integrationId".
ID do contrato/venda no seu sistema.
Exemplo: "1".
customerInternalId
integer
11 caracteres
ID do cliente no Galax Pay.
Exemplo: "1".
customerIntegrationId
string
255 caracteres
ID de integração informado ao cadastrar o cliente pelo parâmetro "integrationId".
ID do cliente no seu sistema.
Exemplo: "1".
Card
Dados do cartão do cliente.
integrationId
string
255 caracteres
Obrigatorio
ID de integração informado ao cadastrar um cartão.
ID do cartão no seu sistema.
Exemplo: "1".
number
string
255 caracteres
Obrigatorio
Número do cartão.
Exemplo: "4716 0248 9944 1650".
holder
string
30 caracteres
Obrigatorio
Nome do portador do cartão (Nome no cartão).
Exemplo: "Cliente de exemplo Galax Pay".
expiryMonth
integer
2 caracteres
Obrigatorio
Mês de expiração do cartão.
Exemplo: "04".
expiryYear
integer
4 caracteres
Obrigatorio
Ano de expiração do cartão.
Exemplo: "2023".
cvv
integer
4 caracteres
Obrigatorio
Código de segurança do cartão.
Exemplo: "541".
brand
string
36 caracteres
Obrigatorio
Bandeira do cartão
Exemplo: "visa".

NOTAS

52 - Um dos parâmetros, "paymentBillIntegrationId" ou "paymentBillInternalId", é necessário ser informado.
53 - Um dos parâmetros, "customerIntegrationId" ou "customerInternalId", é necessário ser informado.
54 - 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."}

/getCarneList

Mé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

billInternalIds
string
IDs dos Contratos/Vendas no Galax Pay
Exemplo: "11,52,63".
billIntegrationIds
string
IDs de integração dos Contratos/Vendas no Galax Pay
Exemplo: "120C,541T,636R".

NOTAS

55 - É 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.
56 - Separe o IDs por vírgula, conforme o exemplo.
57 - 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."}

/getCarneCustom

Mé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

billInternalIds
string
IDs dos Contratos/Vendas no Galax Pay
Exemplo: "11,52,63".
billIntegrationIds
string
IDs de integração dos Contratos/Vendas no Galax Pay
Exemplo: "120C,541T,636R".
transactionInternalIds
string
IDs das transações no Galax Pay.
Exemplo: "1".
transactionIntegrationIds
string
IDs das transações que são utilizadas para relacionar seu sistema com o Galax Pay.
IDs das transações no seu sistema.
Exemplo: "1A".

NOTAS

58 - O carnê personalizado somente irá ser gerado se todas as transações estiverem válidas para serem acrescentadas no carnê.
59 - É 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.
60 - Separe o IDs por vírgula, conforme o exemplo.
61 - 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.

/addTransactionContract

Acrescenta uma transação em um Contrato já existente.

Parâmetros

paymentBillInternalId
integer
11 caracteres
ID do Contrato/Venda no Galax Pay.
Exemplo: "1".
paymentBillIntegrationId
string
255 caracteres
ID de integração informado ao cadastrar o Contrato/Venda pelo parâmetro "integrationId".
ID do contrato/venda no seu sistema.
Exemplo: "1".
payday
date
YYYY-mm-dd
Obrigatorio
Data de vencimento da transação.
Exemplo: "2019-02-07".
value
decimal
Obrigatorio
Valor da transação
Exemplo: "80.00".
integrationId
integer
11 caracteres
ID da transação que é utilizado para relacionar seu sistema com o Galax Pay.
ID da transação no seu sistema.
Exemplo: "1".
additionalInfo
string
Observações sobre a transação, apenas para controle interno no sistema.
Exemplo: "Transação referente ao mês de janeiro.".
descriptionInvoice
string
255 caracteres
Descrição da transação para a geração de nota fiscal.
Caso não seja informado a descrição especifica da transação, iremos aplicar a ela o que esta salvo no Contrato.
Exemplo: "NF primeira mensalidade".

NOTAS

62 - Um dos parâmetros, "paymentBillInternalId" ou "paymentBillIntegrationId", é necessario ser informado, logo, os mesmos estão em ordem de relevância.
63 - Caso o Contrato/Venda esteja encerrado, irá ser ativado novamente.
64 - 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"}}

/getTransaction

Retorna informações sobre uma determinada transação.

Parâmetros

transactionInternalId
integer
11 caracteres
ID da transação dentro do sistema
Exemplo: "1".
transactionIntegrationId
integer
11 caracteres
ID da transação que é utilizado para relacionar seu sistema com o Galax Pay.
ID da transação no seu sistema.
Exemplo: "1".
transactionTid
integer
11 caracteres
TID da transação
Exemplo: "1AABBCC4CC".

NOTAS

65 - É 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"}}

/getTransactionsByPaymentBill

Retorna uma lista com todas as transações de um Contrato/Venda com informações necessárias, como o status e valor.

Parâmetros

internalId
integer
11 caracteres
ID do Contrato/Venda no Galax Pay.
Exemplo: "1".
integrationId
string
255 caracteres
ID do Contrato/Venda que é utilizado para relacionar seu sistema com o Galax Pay.
ID do Contrato/Venda no seu sistema.
Exemplo: "1".
startDate
date
YYYY-mm-dd
Data de vencimento (payDay) inicial que deseja filtrar os resultados.
Exemplo: "2018-01-10".
endDate
date
YYYY-mm-dd
Data de vencimento (payDay) final que deseja filtrar os resultados.
Exemplo: "2018-12-15".

NOTAS

66 - É obrigatório o uso de apenas um dos parâmetros citados acima, logo, os mesmos estão em ordem de relevância.
67 - 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"}]}

/getTransactions

Retorna uma lista contendo transações de diferentes Contratos/Vendas filtradas por uma data específica.

Parâmetros

startDate
date
YYYY-mm-dd
Obrigatorio
Data inicial que deseja filtrar os resultados.
Exemplo: "2018-01-10".
endDate
date
YYYY-mm-dd
Obrigatorio
Data final que deseja filtrar os resultados.
Exemplo: "2018-12-15".
typeDate
string
Obrigatorio
Tipo de data a filtrar.
Exemplo: "dateOfLastUpdate".

Opções

Opções disponiveis para uso em "typeDate"
Valor Descrição
dateOfLastUpdate Data em que a transação foi capturada ou negada.
expirationDateOfTransaction Data de vencimento da transação.
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"}]}]}

/getTransactionsByIds

Retorna uma lista contendo transações de diferentes Contratos/Vendas filtradas.

Parâmetros

ids
string
IDs das transações no Galax Pay
Exemplo: "73991, 74002".
integrationIds
string
IDs de integração das transações no Galax Pay
Exemplo: "120C,541T,636R".

NOTAS

68 - É 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

transactionInternalId
integer
11 caracteres
ID da transação dentro do sistema
Exemplo: "1".
transactionIntegrationId
integer
11 caracteres
ID da transação que é utilizado para relacionar seu sistema com o Galax Pay.
ID da transação no seu sistema.
Exemplo: "1".
cardInternalId
integer
11 caracteres
ID do cartão no Galax Pay.
Exemplo: "1".
cardIntegrationId
string
255 caracteres
ID do cartão que é utilizado para relacionar seu sistema com o Galax Pay.
ID do cartão no seu sistema.
Exemplo: "1".
cardBill
bool
Parâmetro que define que deseja utilizar o cartão da cobrança.
Exemplo: "true".

NOTAS

69 - Um dos parâmetros, "transactionInternalId" ou "transactionIntegrationId", é necessario ser informado, logo, os mesmos estão em ordem de relevância.
70 - 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"}]}

/chargeBackTransaction

Método utilizado para estornar transações desejadas na operadora que foi realizada a cobrança.

Parâmetros

transactionInternalId
integer
11 caracteres
Obrigatorio
ID da transação no Galax Pay.
Exemplo: "1".

NOTAS

71 - 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."}

/cancelTransaction

Método utilizado para cancelar uma transação que ainda não foi capturada.

Parâmetros

transactionInternalId
integer
11 caracteres
ID da transação no Galax Pay.
Exemplo: "1".
transactionIntegrationId
string
255 caracteres
ID da transação que é utilizado para relacionar seu sistema com o Galax Pay.
ID da transação no seu sistema.
Exemplo: "1A".

NOTAS

72 - É obrigatório o uso de apenas um dos parâmetros citados acima, logo, os mesmos estão em ordem de relevância.
73 - 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."}

/payedExternalTransaction

Método utilizado para alterar o status de uma transação para "Paga fora do sistema".

Parâmetros

transactionInternalId
integer
11 caracteres
ID da transação no Galax Pay.
Exemplo: "1".
transactionIntegrationId
integer
11 caracteres
ID da transação que é utilizado para relacionar seu sistema com o Galax Pay.
ID da transação no seu sistema.
Exemplo: "1A".

NOTAS

74 - É obrigatório o uso de apenas um dos parâmetros citados acima, logo, os mesmos estão em ordem de relevância.
75 - 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."}

/retryTransaction

Reenvia uma transação utilizando informações do cliente, Contrato/Venda e da transação.

Parâmetros

customerInternalId
string
255 caracteres
ID do cliente no Galax Pay.
Exemplo: "1".
customerIntegrationId
string
255 caracteres
ID de integração utilizado para relacionar seu sistema com o Galax Pay.
ID do cliente no seu sistema.
Exemplo: "1".
paymentBillInternalId
string
255 caracteres
ID do Contrato/Venda no Galax Pay.
Exemplo: "1".
paymentBillIntegrationId
integer
11 caracteres
ID do Contrato/Venda que é utilizado para relacionar seu sistema com o Galax Pay.
ID do Contrato/Venda no seu sistema.
Exemplo: "1".
transactionInternalId
integer
11 caracteres
ID da transação no Galax Pay.
Exemplo: "1".
transactionIntegrationId
string
255 caracteres
ID da transação que é utilizado para relacionar seu sistema com o Galax Pay.
ID da transação no seu sistema.
Exemplo: "1A".

NOTAS

76 - Um dos parâmetros, "customerInternalId" ou "customerIntegrationId", é necessario ser informado.
77 - Um dos parâmetros, "paymentBillInternalId" ou "paymentBillIntegrationId", é necessario ser informado.
78 - 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"}]}

/getAllStatusTransaction

Retorna 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"}]}

/getBoletoList

Retorna todos os boletos pendentes referente ao cliente desejado, que pode ser filtrado por diferentes parâmetros.

Parâmetros

customerInternalId
integer
11 caracteres
ID do cliente no Galax Pay.
Exemplo: "1".
customerIntegrationId
string
255 caracteres
ID de integração, informado ao cadastrar o cliente pelo parâmetros "integrationId".
ID do cliente no seu sistema.
Exemplo: "1".
customerDocument
string
16 caracteres
CPF/CNPJ do cliente.
Exemplo: "012.345.678-90".
customerEmail
string
255 caracteres
Email do cliente.
Exemplo: "teste@email.com".
paymentBillInternalId
string
255 caracteres
ID interno do Contrato/Venda.
Exemplo: "123".
paymentBillIntegrationId
string
255 caracteres
ID interno, informado ao cadastrar o Contrato/Venda pelo parâmetro "integrationId".
ID do Contrato/Venda no seu sistema.
Exemplo: "123A".

NOTAS

79 - É obrigatório apenas um dos quatro parâmetros citados acima
80 - 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.

/getPaymentBillInfoCustomFields

Retorna todas as informações do pagamento e suas transações utilizando os filtros de campos personalizados.

Parâmetros

CustomFields
Obrigatorio
Informações para serem pesquisadas dentro dos campos personalizados dos Contratos/Venda.
Deve ser utilizado a TAG gerada para campo personalizado dentro do sistema.
CP_FILIAL
string
Valor a ser pesquisado no campo personalizado de filial.
Exemplo: "Belo horizonte".
CP_FILIAL_NUMERO
string
Valor a ser pesquisado no campo personalizado de filial.
Exemplo: "21514".
startDate
date
YYYY-mm-dd
Obrigatorio
Data inicial que deseja filtrar os resultados.
Exemplo: "2018-01-10".
endDate
date
YYYY-mm-dd
Obrigatorio
Data final que deseja filtrar os resultados.
Exemplo: "2018-12-15".
typeDate
string
Obrigatorio
Tipo de data a filtrar.
Exemplo: "dateOfLastUpdate".

Opções

Opções disponiveis para uso em "typeDate"
Valor Descrição
dateOfLastUpdate Data em que a transação foi capturada ou negada.
expirationDateOfTransaction Data de vencimento da transação.
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"}]}}

Webhooks

Webkook é 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).

Retentativas

O 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.

Eventos

Abaixo se encontra a lista de eventos que ao acontecer, o Galax Pay irá enviar as informações para seu endpoint.
transaction.status
Ao atualizar o status da transação.
bill.generatePaper
Ao termino da geração do carnê utilizando o método "/getCarneList".
bill.generatePaperCustom
Ao termino da geração do carnê personalizado utilizando o método "/getCarneCustom".

Exemplo

O 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âmetros

Abaixo se encontra a lista dos parâmetros e de suas explicações, que podem ser utilizados no envio do webhook até o endpoint.
webhookId
ID único do webhook, este ID não se repete.
event
Evento utilizado para disparar o webhook
company.id
ID da empresa
company.name
Nome da empresa
data.billInternalId
ID do Contrato/Venda dentro do Galax Pay
data.billIntegrationId
ID de integração do Contrato/Venda
data.customerInternalId
ID do cliente dentro do Galax Pay
data.customerIntegrationId
ID de integração do cliente
data.transactionInternalId
ID da transação no Galax Pay
data.transactionIntegrationId
ID de integração da transação
data.value
Valor da transação
data.payday
Data de vencimento da transação
data.authorizationCode
Código de autorização da transação
data.status
Status da transação
data.statusInsertdate
Data que o status foi cadastrado na transação
data.statusDescription
Descrição do status da transação
data.boleto
URL do boleto
data.boletoBankLine
Linha digitável do boleto
data.boletoBankNumber
Nosso número do boleto

Pacote PHP Básico

Abaixo 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

Ajuda

Ficou 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 contato

Conheça nosso atendimento personalizado e surpreenda-se! Estamos prontos para atendê-lo por telefone, e-mail ou presencialmente.

Documentação

17/06/2019