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
Operadora Cartão Validade Resultado
Cielo 4556 4181 2420 6784 12/2018 Capturado
Cielo 4024 0071 5039 4517 12/2018 Negado
Bin 4556 4181 2420 6784 12/2018 Capturado
Bin 4024 0071 5039 4517 12/2023 Negado
GetNet 5155 9012 2228 0001 12/2018 Capturado
GetNet 4024 0071 5039 4517 12/2018 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
Obrigatorio
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
Obrigatorio
Telefone de 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".
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 - 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.
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 de 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".
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

3 - É 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.
4 - O parâmetro "customerInternalId" não irá ser alterado caso informado, o restante sim.
5 - 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

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

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

9 - 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

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

/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

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

13 - 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".
customerIntegrationId
string
255 caracteres
Obrigatorio
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 "typeBill".
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".
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
255 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 - O nome da operadora para utilizar no parâmetro "operator" pode ser obtido utilizando o resultado do método "/getOperatorList".
15 - A bandeira do cartão para utilizar no parâmetro "brand" pode ser obtido utilizando o resultado do método "/getCardBrandsByOperator".
16 - 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".
17 - Caso sejam informados algum dos parâmetros do plano(planInternalId, planIntegrationId) somente um será considerado.
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."}

/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
Obrigatorio
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".
planInternalId
string
ID interno do plano no sistema.
Exemplo: "1".
planIntegrationId
string
ID para integração do plano.
Exemplo: "12321A".
fineBoleto
decimal
36 caracteres
Multa por atraso.
Exemplo: "2.50".
interestBoleto
decimal
36 caracteres
Juros ao mês.
Exemplo: "1.25".

NOTAS

18 - Caso sejam informados algum dos parâmetros do plano(planInternalId, planIntegrationId) somente um será considerado.
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."}

/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

19 - É 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.
20 - 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","value": "65.50","dateFirst": "2018-06-21","customerIntegrationId": "321","customerInternalId": "123","customerName": "Cliente de Teste","cardTruncate": "44444444****1111","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"}]}}

/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

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".
paymentBillInternalId
integer
11 caracteres
ID do Contrato/Venda no Galax Pay.
Exemplo: "1".

NOTAS

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

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".
paymentBillInternalId
integer
11 caracteres
ID do Contrato/Venda 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".
customerInternalId
integer
11 caracteres
ID do cliente no Galax Pay.
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
255 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

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

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.

/getTransaction

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

Parâmetros

transactionInternalId
integer
11 caracteres
Obrigatorio
ID da transação dentro do sistema
Exemplo: "1".
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

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".
internalId
integer
11 caracteres
ID do Contrato/Venda no Galax Pay.
Exemplo: "1".

NOTAS

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

27 - 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
Obrigatorio
ID da transação no Galax Pay.
Exemplo: "1".

NOTAS

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

/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 que é utilizado para relacionar seu sistema com o Galax Pay.
ID do Contrato/Venda no seu sistema.
Exemplo: "1".
paymentBillIntegrationId
integer
11 caracteres
ID do Contrato/Venda no Galax Pay.
Exemplo: "1".
transactionInternalId
integer
11 caracteres
ID do Contrato/Venda no Galax Pay.
Exemplo: "1".

NOTAS

29 - Um dos parâmetros, "customerInternalId" ou "customerIntegrationId", é necessario ser informado.
30 - Um dos parâmetros, "paymentBillInternalId" ou "paymentBillIntegrationId", é necessario ser informado.
31 - 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

32 - É obrigatório apenas um dos quatro parâmetros citados acima
33 - 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":"R$ 2,55","payday":"2018-05-15","paydayLimit":"2018-06-26","outdated":"true","url":"https://www.urldeboleto.com.br/boleto/424sadaskksakdkasfk6768"},{"id":"6769","value":"R$ 2,55","payday":"2018-05-15","paydayLimit":"2018-06-26","outdated":"true","url":"https://www.urldeboleto.com.br/boleto/424sadaskksakdkasfk6769"},{"id":"6771","value":"R$ 2,55","payday":"2018-05-15","paydayLimit":"2018-06-26","outdated":"true","url":"https://www.urldeboleto.com.br/boleto/424sadaskksakdkasfk6771"},{"id":"6798","value":"R$ 2,55","payday":"2018-05-16","paydayLimit":"2018-05-16","outdated":"true","url":"https://www.urldeboleto.com.br/boleto/424sadaskksakdkasfk6798"},{"id":"6808","value":"R$ 2,55","payday":"2018-05-16","paydayLimit":"2018-05-16","outdated":"true","url":"https://www.urldeboleto.com.br/boleto/424sadaskksakdkasfk6808"}]}

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

08/08/2018