Listar assinaturas/contratos
GET /subscriptions
Para utilizar esse método, o access_token deve conter o scope subscriptions.read
Retorna todas as informações das assinaturas/contratos de acordo com o filtro informado.
URL da Requisição
https://api.sandbox.cel.cash/v2/subscriptions
Código da resposta
---
Tempo de resposta
---
Body da Resposta
{
"totalQtdFoundInPage": 1,
"Subscriptions": [
{
"myId": "pay-664ae25c96dbc3.87932828",
"galaxPayId": 1,
"planMyId": "pay-664ae25c98f469.34307632",
"planGalaxPayId": 1,
"value": 12999,
"quantity": 12,
"periodicity": "monthly",
"firstPayDayDate": "2024-05-20",
"mainPaymentMethodId": "creditcard",
"paymentLink": "https://app.celcoin.com.br/link-payment",
"additionalInfo": "Lorem ipsum dolor sit amet.",
"status": "active",
"Customer": {
"galaxPayId": 1,
"myId": "pay-664ae25cadef72.60891497",
"name": "Lorem ipsum dolor sit amet.",
"document": "57770493978",
"emails": [
"[email protected]",
"[email protected]"
],
"phones": [
3140201512,
31983890110
],
"createdAt": "2020-06-02 10:10:00",
"updatedAt": "2020-06-02 10:10:00",
"Address": {
"zipCode": "30411330",
"street": "Rua platina",
"number": "1330",
"complement": "2º andar",
"neighborhood": "Prado",
"city": "Belo Horizonte",
"state": "MG"
}
},
"Transactions": [
{
"galaxPayId": 1,
"myId": "pay-664ae25cc5c223.84594045",
"value": 12999,
"payday": "2024-05-20",
"payedOutsideGalaxPay": false,
"additionalInfo": "Lorem ipsum dolor sit amet.",
"installment": 3,
"statusDate": "2024-05-20 02:40:44",
"datetimeLastSentToOperator": "2024-05-20 02:40:44",
"status": "captured",
"fee": 300,
"statusDescription": "Capturada na Operadora",
"tid": "pay-664ae25cd9c6c6.53434396",
"authorizationCode": "pay-664ae25cdaf008.70267823",
"reasonDenied": "Limite do cartão insuficiente.",
"AbecsReasonDenied": {
"code": "51",
"message": "Saldo/limite insuficiente"
},
"Boleto": {
"pdf": "https://app.celcoin.com.br/link-pdf",
"bankLine": "23312323232323232323232323232",
"bankAgency": "0001",
"bankAccount": "12345"
},
"Pix": {
"qrCode": "ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123",
"reference": "E202405200240443E775027DAB39C62537E33712B21484F",
"image": "https://app.celcoin.com.br/link-image-qrcode",
"page": "https://app.celcoin.com.br/link-page-qrcode",
"endToEnd": "E202405200240443E775027DAB39C62537E33712B21484F"
},
"CreditCard": {
"Card": {
"myId": "pay-664ae25cea2836.11891787",
"galaxPayId": 1,
"number": "5451*********1515",
"createdAt": "2020-06-02 10:10:00",
"updatedAt": "2020-06-02 10:10:00",
"Brand": {
"id": "mastercard",
"name": "MasterCard",
"maxInstallment": 12,
"operatorIds": "pagseguro,rede"
},
"expiresAt": "2024-05"
}
}
}
],
"PaymentMethodCreditCard": {
"Card": {
"myId": "pay-664ae25d05f6b4.20359624",
"galaxPayId": 1,
"number": "5451*********1515",
"createdAt": "2020-06-02 10:10:00",
"updatedAt": "2020-06-02 10:10:00",
"Brand": {
"id": "mastercard",
"name": "MasterCard",
"maxInstallment": 12,
"operatorIds": "cielo,getnet"
},
"expiresAt": "2024-05"
}
},
"PaymentMethodBoleto": {
"fine": 100,
"interest": 200,
"instructions": "Lorem ipsum dolor sit amet."
},
"PaymentMethodPix": {
"fine": 100,
"interest": 200,
"instructions": "Lorem ipsum dolor sit amet.",
"Deadline": {
"type": "days",
"value": 60
}
}
}
]
}
Nome
Tipo
Explicação
totalQtdFoundInPage
int 11 dígitos
Quantidade total de registros do retorno da busca na página atual.
Subscriptions
Array de assinaturas.
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.
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
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.
Transactions
Transações da assinatura.
Ou seja, cada pagamento da assinatura.
Clique para ver os campos.
Ou seja, cada pagamento da assinatura.
Clique para ver os campos.
galaxPayId
int 11 dígitos
Id no cel_cash
myId
string 255 caracteres
Id referente 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.
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.
statusDate
datetime
Data do status
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
fee
int 30 dígitos
Taxa paga. Valor em centavos, sendo as duas últimas casas decimais.
statusDescription
string 255 caracteres
Mais informações sobre o status da transação.
tid
string 255 caracteres
TID: Identificador da transação na operadora.
authorizationCode
string 255 caracteres
Código de autorização da transação na operadora.
reasonDenied
string 255 caracteres
Motivo de negação da transação (Quando houver).
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
Boleto
Dados do boleto atrelado.
Clique para ver os campos.
Clique para ver os campos.
pdf
string 255 caracteres
URL do PDF
bankLine
string 255 caracteres
Linha digitável do boleto.
bankAgency
string 255 caracteres
Agência do banco emissor do boleto
bankAccount
string 255 caracteres
Conta do banco emissor 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.
endToEnd
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".
CreditCard
Dados do cartão de crédito da transaçã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, para salvar no cel_cash.
galaxPayId
int 11 dígitos
Id no cel_cash
number
string 30 caracteres
Número truncado do cartão.
createdAt
datetime
Data de criação.
updatedAt
datetime
Data de alteração.
Brand
Bandeira do cartão da transação.
Clique para ver os campos.
Clique para ver os campos.
id
string 255 caracteres
Id da bandeira de cartão.
name
string 255 caracteres
Nome da bandeira.
maxInstallment
int 11 dígitos
Máximo de vezes que pode ser parcelado.
operatorIds
text
Operadoras que aceitam a bandeira, separados por vírgula.
CardOperator.id
CardOperator.id
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
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.
Brand
Bandeira do cartão da transação.
Clique para ver os campos.
Clique para ver os campos.
id
string 255 caracteres
Id da bandeira de cartão.
name
string 255 caracteres
Nome da bandeira.
maxInstallment
int 11 dígitos
Máximo de vezes que pode ser parcelado.
operatorIds
text
Operadoras que aceitam a bandeira, separados por vírgula.
CardOperator.id
CardOperator.id
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
days
Dias
value
int 11 dígitos
Valor da expiração do QR Code (em dias ou minutos).
error
Nó de erros, caso haja.
Clique para ver os campos.
Clique para ver os campos.
message
string 255 caracteres
Mensagem que indica qual o erro.
details
Objeto com detalhes sobre o erro, mostrando qual o campo referente e qual o erro.
Clique para ver os campos.
Clique para ver os campos.
Entity.field
array de string
Array cuja chave é Entidade.campo onde deu o erro e cada valor é uma descrição sobre o problema.
Código
Explicação
200
Sucesso.
400
Erros de validação.
401
Falha ao autenticar.
403
Validação de segurança.
404
Nenhuma assinatura encontrada com os parâmtros utilizados.