Webhooks
Webhooks ou notificações são chamadas que o cel_payments faz na sua aplicação. Ou seja, você prepara um script para ler um conteúdo JSON que enviamos a você e fazer alguma rotina no seu sistema.
Eles são usados para que você possa manter o seu sistema sincronizado com o nosso em caso de mudanças que ocorrem após ou fora do fluxo direto da API.
Exemplo: um boleto gerado pode ser pago a qualquer momento. Para que seu sistema possa atualizar o status de pagamento quando for pago, te enviaremos o webhook
transaction.updateStatus
com as informações atualizadas.
Regras
- Sua url deverá responder em até 5 segundos
- Não seguimos redirecionamentos. Enviamos o conteúdo para url exata que tiver sido cadastrada. Se você possuir https, por exemplo, coloque já a url com https no
webhooks.
- Se sua url não responder com um código 2xx, tentaremos enviar o webhook novamente mais 5 vezes em intervalos progressivos durante aproximadamente 48 horas. Após isso, não tentaremos mais.
- A estrutura da API suporta apenas uma URL de webhook por conjunto de conta e subcontas. A URL de webhook deve ser cadastrada na conta master, e todas as subcontas herdarão essa configuração. Não é possível configurar URLs de webhook distintas por subconta. Para identificar a qual subconta um evento pertence, utilize o campo 'confirmHash', enviado no corpo do webhook.
Segurança
Juntamente com todos os webhooks enviamos um hash para que você possa ter certeza que foi o cel_payments que te enviou a requisição e não um terceiro tentando invadir seu sistema.
O hash de segurança é retornado no campo confirmHash ao alterar a url do webhook pelo endpoint
webhooks
ou caso a alteração seja feita pelas configurações do sistema.
Não confie em webhooks enviados por IPs que não estejam listados abaixo: (Esses IPs podem ser alterados sem aviso prévio)
IPS de produção: 54.232.59.251 e 54.232.204.133
IP de sandbox: 54.207.173.93
POST transaction.updateStatus
Será enviado quando uma transação tiver seu status de pagamento alterado. Vai conter todos os dados da entidade Transaction.
event
string 255 caracteres
Evento do webhook.
webhookId
int 11 dígitos
ID do Webhook.
confirmHash
string 255 caracteres
Hash de confirmação de segurança do webhook.
Transaction
Informação da transação.
Clique para ver os campos.
Clique para ver os campos.
myId
string 255 caracteres
Id referente no seu sistema, para salvar no cel_cash.
galaxPayId
int 11 dígitos
Id no cel_cash
chargeMyId
string 255 caracteres
Charge.myId.
Id da cobrança avulsa no seu sistema.
Id da cobrança avulsa no seu sistema.
chargeGalaxPayId
int 11 dígitos
Charge.galaxPayId.
Id da cobrança avulsa no cel_cash.
Id da cobrança avulsa no cel_cash.
subscriptionGalaxPayId
int 11 dígitos
Subscription.galaxPayId.
Id da assinatura no cel_cash.
Id da assinatura no cel_cash.
subscriptionMyId
string 255 caracteres
Subscription.myId
Id referente da assinatura no seu sistema.
Id referente da assinatura no seu sistema.
value
int 11 dígitos
Preço em centavos.
payday
date
Data de vencimento do pagamento.
payedOutsideGalaxPay
bool
Define se a transação foi paga fora do sistema do cel_cash. Exemplo: dinheiro, transferência.
fee
int
Taxa paga. Valor em centavos, sendo as duas últimas casas decimais. Apenas para transações de boleto e pix.
additionalInfo
text
Texto para informações adicionais sobre a transação. Essa informação é exibida no boleto ao cliente.
installment
int 11 dígitos
Parcela.
paydayDate
date
Data do pagamento.
AbecsReasonDenied
Motivo de negação da transação (Quando houver).
Clique para ver os campos.
Clique para ver os campos.
code
string 4 caracteres
Código do motivo de negativa da ABECS
message
string 255 caracteres
Mensagem do motivo de negativa da ABECS
datetimeLastSentToOperator
datetime
Data de último envio para a operadora
status
string 30 caracteres
Status da transaçao.
Valor
Explicação
Opções válidas para cartão de crédito:
notSend
Ainda não enviada para operadora de Cartão
authorized
Autorizado
captured
Capturada na Operadora de Cartão
denied
Negada na Operadora de Cartão
reversed
Estornada na Operadora de Cartão
chargeback
Estorno por chargeback
Opções válidas para boleto Bancário:
pendingBoleto
Boleto em aberto
payedBoleto
Boleto compensado
notCompensated
Boleto baixado por decurso de prazo
lessValueBoleto
Pago valor menor que o original
moreValueBoleto
Pago valor maior que o original
paidDuplicityBoleto
Pago em duplicidade
Opções válidas para Pix:
pendingPix
Pix em aberto
payedPix
Pix pago
unavailablePix
Pix indisponível para pagamento
Opções válidas para qualquer forma de pagamento:
cancel
Cancelada manualmente
payExternal
Paga fora do sistema
cancelByContract
Cancelada ao cancelar a cobrança
free
Isento
reasonDenied
string 255 caracteres
Motivo de negação da transação (Quando houver).
tid
string
TID: Identificador da transação na operadora.
authorizationCode
string
Código de autorização da transação na operadora.
createdAt
datetime
Data de criação.
Boleto
Dados do boleto atrelado.
Clique para ver os campos.
Clique para ver os campos.
pdf
string 255 caracteres
Link do PDF.
bankLine
string 255 caracteres
Linha digitável do boleto.
Pix
Dados do Pix atrelado.
Clique para ver os campos.
Clique para ver os campos.
qrCode
string 255 caracteres
Conteúdo do QR Code.
reference
string 255 caracteres
Identificador do QR Code que será exibido no app do banco ao realizar o pagamento.
image
string 255 caracteres
Link da imagem do QR Code.
page
string 255 caracteres
Link da página do QR Code.
endToEndId
string 255 caracteres
Identificação única do pagamento do QR Code no Banco Central. Será retornado apenas caso o status da transação seja "payedPix".
Charge
Cobrança avulsa.
Clique para ver os campos.
Clique para ver os campos.
galaxPayId
int
Id no cel_cash
myId
string
Id referente no seu sistema, para salvar no cel_cash.
mainPaymentMethodId
string 30 caracteres
PaymentMethod.id
Id do pagamento principal. Ou seja, quando forem cadastradas novas transações, irá considerar esse pagamento.
Id do pagamento principal. Ou seja, quando forem cadastradas novas transações, irá considerar esse pagamento.
Valor
Explicação
creditcard
Cartão de Crédito
boleto
Boleto Bancário
pix
Pix
value
int
Preço em centavos.
additionalInfo
text
Texto livre dedicado a informações adicionais internas.
status
string 30 caracteres
Status da cobrança avulsa.
Valor
Explicação
active
Ativa
canceled
Cancelada
closed
Encerrada
waitingPayment
Aguardando pagamento
inactive
Inativa
Customer
Informações do cliente.
Clique para ver os campos.
Clique para ver os campos.
galaxPayId
int 11 dígitos
Id no cel_cash
myId
string 255 caracteres
Id referente no seu sistema.
phones
array de int 11 dígitos
Telefones do cliente.
name
string 255 caracteres
Nome ou razão social do cliente.
document
string 14 caracteres
CPF OU CNPJ do cliente. Apenas números.
createdAt
datetime
Data de criação.
updatedAt
datetime
Data de alteração.
Address
Endereço de cobrança do cliente.
Clique para ver os campos.
Clique para ver os campos.
zipCode
string 8 caracteres
CEP
street
string 255 caracteres
Logradouro.
number
string 255 caracteres
Número da conta.
complement
string 255 caracteres
Complemento.
neighborhood
string 255 caracteres
Bairro.
city
string 255 caracteres
Cidade.
state
string 2 caracteres
Estado.
PaymentMethodCreditCard
Configurações do meio de pagamento de cartão.
Clique para ver os campos.
Clique para ver os campos.
Card
Cartão.
Clique para ver os campos.
Clique para ver os campos.
galaxPayId
int 11 dígitos
Id no cel_cash
myId
string 255 caracteres
Id referente no seu sistema.
number
string
Número do cartão truncado.
createdAt
datetime
Data de criação.
updatedAt
datetime
Data de alteração.
expiresAt
string 7 caracteres
Mês e ano da expiração do cartão.
String contendo ano e mês de expiração do cartão.
YYYY-MM
String contendo ano e mês de expiração do cartão.
YYYY-MM
PaymentMethodBoleto
Configurações do meio de pagamento de boleto.
Clique para ver os campos.
Clique para ver os campos.
fine
int 11 dígitos
Percentual de multa, com dois decimais sem o separador.
interest
int 11 dígitos
Percentual de juros, com dois decimais sem o separador.
instructions
string 255 caracteres
Instruções.
PaymentMethodPix
Configurações do meio de pagamento de Pix.
Clique para ver os campos.
Clique para ver os campos.
fine
int 11 dígitos
Percentual de multa, com dois decimais sem o separador.
Caso não informado será utilizado o percentual definido no sistema.
Caso não informado será utilizado o percentual definido no sistema.
interest
int 11 dígitos
Percentual de juros, com dois decimais sem o separador.
Caso não informado será utilizado o percentual definido no sistema.
Caso não informado será utilizado o percentual definido no sistema.
instructions
string 255 caracteres
Instruções do QR Code Pix.
Informação exibida nos detalhes do QR Code.
Caso não informado será utilizado o padrão definido na plataforma.
Informação exibida nos detalhes do QR Code.
Caso não informado será utilizado o padrão definido na plataforma.
Deadline
Expiração do QR Code.
Caso não informado, será utilizado o padrão definido no sistema.
Clique para ver os campos.
Caso não informado, será utilizado o padrão definido no sistema.
Clique para ver os campos.
type
string 255 caracteres
Tipo da expiração do QR Code.
Valor
Explicação
minutes
Minutos
days
Dias
value
int 11 dígitos
Valor da expiração do QR Code (em dias ou minutos).
event
string 255 caracteres
Evento do webhook.
webhookId
int 11 dígitos
ID do Webhook.
confirmHash
string 255 caracteres
Hash de confirmação de segurança do webhook.
Transaction
Informação da transação.
Clique para ver os campos.
Clique para ver os campos.
myId
string 255 caracteres
Id referente no seu sistema, para salvar no cel_cash.
galaxPayId
int 11 dígitos
Id no cel_cash
chargeMyId
string 255 caracteres
Charge.myId.
Id da cobrança avulsa no seu sistema.
Id da cobrança avulsa no seu sistema.
chargeGalaxPayId
int 11 dígitos
Charge.galaxPayId.
Id da cobrança avulsa no cel_cash.
Id da cobrança avulsa no cel_cash.
subscriptionGalaxPayId
int 11 dígitos
Subscription.galaxPayId.
Id da assinatura no cel_cash.
Id da assinatura no cel_cash.
subscriptionMyId
string 255 caracteres
Subscription.myId
Id referente da assinatura no seu sistema.
Id referente da assinatura no seu sistema.
value
int 11 dígitos
Preço em centavos.
payday
date
Data de vencimento do pagamento.
payedOutsideGalaxPay
bool
Define se a transação foi paga fora do sistema do cel_cash. Exemplo: dinheiro, transferência.
fee
int
Taxa paga. Valor em centavos, sendo as duas últimas casas decimais. Apenas para transações de boleto e pix.
additionalInfo
text
Texto para informações adicionais sobre a transação. Essa informação é exibida no boleto ao cliente.
installment
int 11 dígitos
Parcela.
paydayDate
date
Data do pagamento.
AbecsReasonDenied
Motivo de negação da transação (Quando houver).
Clique para ver os campos.
Clique para ver os campos.
code
string 4 caracteres
Código do motivo de negativa da ABECS
message
string 255 caracteres
Mensagem do motivo de negativa da ABECS
datetimeLastSentToOperator
datetime
Data de último envio para a operadora
status
string 30 caracteres
Status da transaçao.
Valor
Explicação
Opções válidas para cartão de crédito:
notSend
Ainda não enviada para operadora de Cartão
authorized
Autorizado
captured
Capturada na Operadora de Cartão
denied
Negada na Operadora de Cartão
reversed
Estornada na Operadora de Cartão
chargeback
Estorno por chargeback
Opções válidas para boleto Bancário:
pendingBoleto
Boleto em aberto
payedBoleto
Boleto compensado
notCompensated
Boleto baixado por decurso de prazo
lessValueBoleto
Pago valor menor que o original
moreValueBoleto
Pago valor maior que o original
paidDuplicityBoleto
Pago em duplicidade
Opções válidas para Pix:
pendingPix
Pix em aberto
payedPix
Pix pago
unavailablePix
Pix indisponível para pagamento
Opções válidas para qualquer forma de pagamento:
cancel
Cancelada manualmente
payExternal
Paga fora do sistema
cancelByContract
Cancelada ao cancelar a cobrança
free
Isento
reasonDenied
string 255 caracteres
Motivo de negação da transação (Quando houver).
tid
string
TID: Identificador da transação na operadora.
authorizationCode
string
Código de autorização da transação na operadora.
createdAt
datetime
Data de criação.
Boleto
Dados do boleto atrelado.
Clique para ver os campos.
Clique para ver os campos.
pdf
string 255 caracteres
Link do PDF.
bankLine
string 255 caracteres
Linha digitável do boleto.
Pix
Dados do Pix atrelado.
Clique para ver os campos.
Clique para ver os campos.
qrCode
string 255 caracteres
Conteúdo do QR Code.
reference
string 255 caracteres
Identificador do QR Code que será exibido no app do banco ao realizar o pagamento.
image
string 255 caracteres
Link da imagem do QR Code.
page
string 255 caracteres
Link da página do QR Code.
endToEndId
string 255 caracteres
Identificação única do pagamento do QR Code no Banco Central. Será retornado apenas caso o status da transação seja "payedPix".
Subscription
Assinatura.
Clique para ver os campos.
Clique para ver os campos.
myId
string 255 caracteres
Id referente no seu sistema.
galaxPayId
int 11 dígitos
Id no cel_cash
planMyId
string 255 caracteres
Plan.myId
ID do plano no seu sistema.
ID do plano no seu sistema.
planGalaxPayId
int 11 dígitos
Plan.galaxPayId
ID do plano no cel_cash.
ID do plano no cel_cash.
value
int 11 dígitos
Preço em centavos.
quantity
int 11 dígitos
Quantidade de pagamentos total. Em caso de indeterminada irá retornar 0.
periodicity
string 255 caracteres
Periodicidade dos pagamentos.
Valor
Explicação
weekly
Semanal
biweekly
Quinzenal
monthly
Mensal
bimonthly
Bimestral
quarterly
Trimestral
biannual
Semestral
yearly
Anual
firstPayDayDate
date
Data do primeiro pagamento.
paymentLink
string 255 caracteres
Link para pagamento.
additionalInfo
text
Texto livre dedicado a informações adicionais internas.
status
string 30 caracteres
Status da assinatura.
Valor
Explicação
active
Ativa
canceled
Cancelada
closed
Encerrada
stopped
Interrompida
waitingPayment
Aguardando pagamento
inactive
Inativa
Customer
Informações do cliente.
Clique para ver os campos.
Clique para ver os campos.
galaxPayId
int 11 dígitos
Id no cel_cash
myId
string 255 caracteres
Id referente no seu sistema.
name
string 255 caracteres
Nome ou razão social do cliente.
document
string 14 caracteres
CPF OU CNPJ do cliente. Apenas números.
emails
array de string
255 caracteres
Emails do cliente.
phones
array de int 11 dígitos
Telefones do cliente.
createdAt
datetime
Data de criação.
updatedAt
datetime
Data de alteração.
Address
Endereço de cobrança do cliente.
Clique para ver os campos.
Clique para ver os campos.
zipCode
string 8 caracteres
CEP
street
string 255 caracteres
Logradouro.
number
string 255 caracteres
Número.
complement
string 255 caracteres
Complemento.
neighborhood
string 255 caracteres
Bairro.
city
string 255 caracteres
Cidade.
state
string 2 caracteres
Estado.
PaymentMethodCreditCard
Configurações do meio de pagamento de cartão.
Clique para ver os campos.
Clique para ver os campos.
Card
Cartão
Clique para ver os campos.
Clique para ver os campos.
myId
string 255 caracteres
Id referente no seu sistema.
galaxPayId
int 11 dígitos
Id no cel_cash
number
string 30 caracteres
Número do cartão truncado.
createdAt
datetime
Data de criação.
updatedAt
datetime
Data de alteração.
expiresAt
string 7 caracteres
Mês e ano da expiração do cartão.
String contendo ano e mês de expiração do cartão.
YYYY-MM
String contendo ano e mês de expiração do cartão.
YYYY-MM
PaymentMethodBoleto
Configurações do meio de pagamento de boleto.
Clique para ver os campos.
Clique para ver os campos.
fine
int 11 dígitos
Percentual de multa, com dois decimais sem o separador.
interest
int 11 dígitos
Percentual de juros, com dois decimais sem o separador.
instructions
string 255 caracteres
Instruções.
PaymentMethodPix
Configurações do meio de pagamento de Pix.
Clique para ver os campos.
Clique para ver os campos.
fine
int 11 dígitos
Percentual de multa, com dois decimais sem o separador.
Caso não informado será utilizado o percentual definido no sistema.
Caso não informado será utilizado o percentual definido no sistema.
interest
int 11 dígitos
Percentual de juros, com dois decimais sem o separador.
Caso não informado será utilizado o percentual definido no sistema.
Caso não informado será utilizado o percentual definido no sistema.
instructions
string 255 caracteres
Instruções do QR Code Pix.
Informação exibida nos detalhes do QR Code.
Caso não informado será utilizado o padrão definido na plataforma.
Informação exibida nos detalhes do QR Code.
Caso não informado será utilizado o padrão definido na plataforma.
Deadline
Expiração do QR Code.
Caso não informado, será utilizado o padrão definido no sistema.
Clique para ver os campos.
Caso não informado, será utilizado o padrão definido no sistema.
Clique para ver os campos.
type
string 255 caracteres
Tipo da expiração do QR Code.
Valor
Explicação
minutes
Minutos
days
Dias
value
int 11 dígitos
Valor da expiração do QR Code (em dias ou minutos).
POST subscription.addTransaction
Será enviado quando uma transação for adicionada em uma assinatura. Vai conter todos os dados da entidade Transaction.
event
string 255 caracteres
Evento do webhook.
webhookId
int 11 dígitos
ID do Webhook.
confirmHash
string 255 caracteres
Hash de confirmação de segurança do webhook.
Transaction
Informação da transação.
Clique para ver os campos.
Clique para ver os campos.
myId
string 255 caracteres
Id referente no seu sistema, para salvar no cel_cash.
galaxPayId
int 11 dígitos
Id no cel_cash
chargeMyId
string 255 caracteres
Charge.myId.
Id da cobrança avulsa no seu sistema.
Id da cobrança avulsa no seu sistema.
chargeGalaxPayId
int 11 dígitos
Charge.galaxPayId.
Id da cobrança avulsa no cel_cash.
Id da cobrança avulsa no cel_cash.
subscriptionGalaxPayId
int 11 dígitos
Subscription.galaxPayId.
Id da assinatura no cel_cash.
Id da assinatura no cel_cash.
subscriptionMyId
string 255 caracteres
Subscription.myId
Id referente da assinatura no seu sistema.
Id referente da assinatura no seu sistema.
value
int 11 dígitos
Preço em centavos.
payday
date
Data de vencimento do pagamento.
payedOutsideGalaxPay
bool
Define se a transação foi paga fora do sistema do cel_cash. Exemplo: dinheiro, transferência.
fee
int
Taxa paga. Valor em centavos, sendo as duas últimas casas decimais. Apenas para transações de boleto e pix.
additionalInfo
text
Texto para informações adicionais sobre a transação. Essa informação é exibida no boleto ao cliente.
installment
int 11 dígitos
Parcela.
paydayDate
date
Data do pagamento.
authorizationCode
string
Código de autorização da transação na operadora.
tid
string
TID: Identificador da transação na operadora.
AbecsReasonDenied
Motivo de negação da transação (Quando houver).
Clique para ver os campos.
Clique para ver os campos.
code
string 4 caracteres
Código do motivo de negativa da ABECS
message
string 255 caracteres
Mensagem do motivo de negativa da ABECS
datetimeLastSentToOperator
datetime
Data de último envio para a operadora
statusDescription
string 255 caracteres
Mais informações sobre o status da transação.
reasonDenied
string 255 caracteres
Motivo de negação da transação (Quando houver).
status
string 30 caracteres
Status da transaçao.
Valor
Explicação
Opções válidas para cartão de crédito:
notSend
Ainda não enviada para operadora de Cartão
authorized
Autorizado
captured
Capturada na Operadora de Cartão
denied
Negada na Operadora de Cartão
reversed
Estornada na Operadora de Cartão
chargeback
Estorno por chargeback
Opções válidas para boleto Bancário:
pendingBoleto
Boleto em aberto
payedBoleto
Boleto compensado
notCompensated
Boleto baixado por decurso de prazo
lessValueBoleto
Pago valor menor que o original
moreValueBoleto
Pago valor maior que o original
paidDuplicityBoleto
Pago em duplicidade
Opções válidas para Pix:
pendingPix
Pix em aberto
payedPix
Pix pago
unavailablePix
Pix indisponível para pagamento
Opções válidas para qualquer forma de pagamento:
cancel
Cancelada manualmente
payExternal
Paga fora do sistema
cancelByContract
Cancelada ao cancelar a cobrança
free
Isento
createdAt
datetime
Data de criação.
Boleto
Dados do boleto atrelado.
Clique para ver os campos.
Clique para ver os campos.
pdf
string 255 caracteres
Link do PDF.
bankLine
string 255 caracteres
Linha digitável do boleto.
Pix
Dados do Pix atrelado.
Clique para ver os campos.
Clique para ver os campos.
qrCode
string 255 caracteres
Conteúdo do QR Code.
reference
string 255 caracteres
Identificador do QR Code que será exibido no app do banco ao realizar o pagamento.
image
string 255 caracteres
Link da imagem do QR Code.
page
string 255 caracteres
Link da página do QR Code.
Subscription
Assinatura.
Clique para ver os campos.
Clique para ver os campos.
myId
string 255 caracteres
Id referente no seu sistema.
galaxPayId
int 11 dígitos
Id no cel_cash
planMyId
string 255 caracteres
Plan.myId
ID do plano no seu sistema.
ID do plano no seu sistema.
planGalaxPayId
int 11 dígitos
Plan.galaxPayId
ID do plano no cel_cash.
ID do plano no cel_cash.
value
int 11 dígitos
Preço em centavos.
quantity
int 11 dígitos
Quantidade de pagamentos total. Em caso de indeterminada irá retornar 0.
periodicity
string 255 caracteres
Periodicidade dos pagamentos.
Valor
Explicação
weekly
Semanal
biweekly
Quinzenal
monthly
Mensal
bimonthly
Bimestral
quarterly
Trimestral
biannual
Semestral
yearly
Anual
firstPayDayDate
date
Data do primeiro pagamento.
paymentLink
string 255 caracteres
Link para pagamento.
additionalInfo
text
Texto livre dedicado a informações adicionais internas.
status
string 30 caracteres
Status da assinatura.
Valor
Explicação
active
Ativa
canceled
Cancelada
closed
Encerrada
stopped
Interrompida
waitingPayment
Aguardando pagamento
inactive
Inativa
Customer
Informações do cliente.
Clique para ver os campos.
Clique para ver os campos.
galaxPayId
int 11 dígitos
Id no cel_cash
myId
string 255 caracteres
Id referente no seu sistema.
name
string 255 caracteres
Nome ou razão social do cliente.
document
string 14 caracteres
CPF OU CNPJ do cliente. Apenas números.
emails
array de string
255 caracteres
Emails do cliente.
phones
array de int 11 dígitos
Telefones do cliente.
createdAt
datetime
Data de criação.
updatedAt
datetime
Data de alteração.
Address
Endereço de cobrança do cliente.
Clique para ver os campos.
Clique para ver os campos.
zipCode
string 8 caracteres
CEP
street
string 255 caracteres
Logradouro.
number
string 255 caracteres
Número.
complement
string 255 caracteres
Complemento.
neighborhood
string 255 caracteres
Bairro.
city
string 255 caracteres
Cidade.
state
string 2 caracteres
Estado.
PaymentMethodCreditCard
Configurações do meio de pagamento de cartão.
Clique para ver os campos.
Clique para ver os campos.
Card
Cartão
Clique para ver os campos.
Clique para ver os campos.
myId
string 255 caracteres
Id referente no seu sistema.
galaxPayId
int 11 dígitos
Id no cel_cash
number
string 30 caracteres
Número do cartão truncado.
createdAt
datetime
Data de criação.
updatedAt
datetime
Data de alteração.
expiresAt
string 7 caracteres
Mês e ano da expiração do cartão.
String contendo ano e mês de expiração do cartão.
YYYY-MM
String contendo ano e mês de expiração do cartão.
YYYY-MM
PaymentMethodBoleto
Configurações do meio de pagamento de boleto.
Clique para ver os campos.
Clique para ver os campos.
fine
int 11 dígitos
Percentual de multa, com dois decimais sem o separador.
interest
int 11 dígitos
Percentual de juros, com dois decimais sem o separador.
instructions
string 255 caracteres
Instruções.
PaymentMethodPix
Configurações do meio de pagamento de Pix.
Clique para ver os campos.
Clique para ver os campos.
fine
int 11 dígitos
Percentual de multa, com dois decimais sem o separador.
Caso não informado será utilizado o percentual definido no sistema.
Caso não informado será utilizado o percentual definido no sistema.
interest
int 11 dígitos
Percentual de juros, com dois decimais sem o separador.
Caso não informado será utilizado o percentual definido no sistema.
Caso não informado será utilizado o percentual definido no sistema.
instructions
string 255 caracteres
Instruções do QR Code Pix.
Informação exibida nos detalhes do QR Code.
Caso não informado será utilizado o padrão definido na plataforma.
Informação exibida nos detalhes do QR Code.
Caso não informado será utilizado o padrão definido na plataforma.
Deadline
Expiração do QR Code.
Caso não informado, será utilizado o padrão definido no sistema.
Clique para ver os campos.
Caso não informado, será utilizado o padrão definido no sistema.
Clique para ver os campos.
type
string 255 caracteres
Tipo da expiração do QR Code.
Valor
Explicação
minutes
Minutos
days
Dias
value
int 11 dígitos
Valor da expiração do QR Code (em dias ou minutos).
POST company.cashOut
Será enviado quando um pagamento Pix ou um Saque/Transferência for realizado no sistema.
POST company.verifyDocuments
Informações de atualização do status de aprovação de conta
POST chargeback.update
Será enviado quando uma abertura de disputa for criada no sistema. Vai conter todos os dados da entidade Chargeback, além de conter alguns dados da entidade Transaction e PaymentBill.
event
string
webhookId
int
ID do Webhook.
confirmHash
string
Hash de confirmação de segurança do webhook.
Chargeback
Informações do chargeback
Clique para ver os campos.
Clique para ver os campos.
galaxPayId
int 32 dígitos
ID do chargeback no sistema cel_cash
openDate
datetime
Data de abertura do chargeback no sistema cel_cash
expireDate
datetime
data até o limite de envio de documentação.
processNumber
string
Número do processo
value
int
Valor do chargeback.
description
text
Descrição do chargeback.
status
string
Status da disputa aberta
Valor
Explicação
awaitingDocumentation
A disputa de chargeback está aguardando a documentação ser enviada.
lostDispute
A disputa de chargeback foi perdida.
winsDispute
disputa de chargeback foi ganha.
inAnalysis
A disputa de chargeback está em análise pelo cel_cash.
canceledDispute
A disputa de chargeback foi cancelada.
sendDocumentsDate
datetime
Data de envio dos documentos
Transaction
Objeto da Transação do chargeback
Clique para ver os campos.
Clique para ver os campos.
galaxPayId
int
ID da transação no sistema cel_cash
myId
string
ID da transação no sistema do cliente
PaymentBill
Objeto da cobrança vinculada ao chargeback
Clique para ver os campos.
Clique para ver os campos.
galaxPayId
int
ID da cobrança no sistema cel_cash
myId
string
ID da cobrança no sistema do cliente
event
string
webhookId
int
ID do Webhook.
confirmHash
string
Hash de confirmação de segurança do webhook.
Chargeback
Informações do chargeback
Clique para ver os campos.
Clique para ver os campos.
galaxPayId
int 32 dígitos
ID do chargeback no sistema cel_cash
openDate
datetime
Data de abertura do chargeback no sistema cel_cash
expireDate
datetime
data até o limite de envio de documentação.
processNumber
string
Número do processo
value
int
Valor do chargeback.
description
text
Descrição do chargeback.
status
string
Status da disputa aberta
Valor
Explicação
awaitingDocumentation
A disputa de chargeback está aguardando a documentação ser enviada.
lostDispute
A disputa de chargeback foi perdida.
winsDispute
disputa de chargeback foi ganha.
inAnalysis
A disputa de chargeback está em análise pelo cel_cash.
canceledDispute
A disputa de chargeback foi cancelada.
sendDocumentsDate
datetime
Data de envio dos documentos
Transaction
Objeto da Transação do chargeback
Clique para ver os campos.
Clique para ver os campos.
galaxPayId
int
ID da transação no sistema cel_cash
myId
string
ID da transação no sistema do cliente
PaymentBill
Objeto da cobrança vinculada ao chargeback
Clique para ver os campos.
Clique para ver os campos.
galaxPayId
int
ID da cobrança no sistema cel_cash
myId
string
ID da cobrança no sistema do cliente
POST company.internalTransfer
event
string 255 caracteres
Evento do webhook.
confirmHash
string 255 caracteres
Hash de confirmação de segurança do webhook.
webhookId
int 11 dígitos
ID do Webhook.
status
string 30 caracteres
Status da transferência
Valor
Explicação
confirmed
Transferência realizada com sucesso.
error
A transferência falhou
info
Clique para ver os campos.
InternalTransfer
Dados da tranferência interna.
Clique para ver os campos.
Clique para ver os campos.
clientId
string 255 caracteres
value
int 11 dígitos
Valor da transferência.
tax
int 11 dígitos
Valor da taxa.
status
string 11 caracteres
Status da transferência
Valor
Explicação
confirmed
Transferência realizada com sucesso.
error
A transferência falhou
createdAt
datetime
Data de criação.
Receiver
Recebedor da transferência interna.
Clique para ver os campos.
Clique para ver os campos.
companyAccount
int 11 dígitos
ID cel_cash da empresa que receberá a transferência.
document
string 14 caracteres
CPF ou CNPJ do cliente. Apenas números.
event
string 255 caracteres
Evento do webhook.
confirmHash
string 255 caracteres
Hash de confirmação de segurança do webhook.
webhookId
int 11 dígitos
ID do Webhook.
status
string 30 caracteres
Status da transferência
Valor
Explicação
confirmed
Transferência realizada com sucesso.
error
A transferência falhou
info
Clique para ver os campos.
InternalTransfer
Dados da tranferência interna.
Clique para ver os campos.
Clique para ver os campos.
clientId
string 255 caracteres
value
int 11 dígitos
Valor da transferência.
tax
int 11 dígitos
Valor da taxa.
status
string 11 caracteres
Status da transferência
Valor
Explicação
confirmed
Transferência realizada com sucesso.
error
A transferência falhou
createdAt
datetime
Data de criação.
Receiver
Recebedor da transferência interna.
Clique para ver os campos.
Clique para ver os campos.
companyAccount
int 11 dígitos
ID cel_cash da empresa que receberá a transferência.
document
string 14 caracteres
CPF ou CNPJ do cliente. Apenas números.