Listar transações

GET /transactions

Para utilizar esse método, o access_token deve conter o scope transactions.read

Retorna todas as informações das transações de acordo com o filtro informado.

Dados da requisição

Nome

Tipo

Obrigatório

Explicação

myIds

string

Não

Ids das transações no seu sistema.
Separe cada id por vírgula.

galaxPayIds

string

Não

Ids das transações no cel_cash.
Separe cada id por vírgula.

subscriptionGalaxPayIds

string

Não

Subscription.galaxPayId.
Id da assinatura no cel_cash.
Separe cada id por vírgula.

chargeMyIds

string

Não

Charge.myId.
Id da cobrança avulsa no seu sistema.
Separe cada id por vírgula.

customerMyIds

string

Não

Customer.myId
Id do cliente no seu sistema.
Separe cada id por vírgula.

customerGalaxPayIds

string

Não

Customer.galaxPayId
Id do cliente no cel_cash.
Separe cada id por vírgula.

chargeGalaxPayIds

string

Não

Charge.galaxPayId.
Id da cobrança avulsa no seu sistema.
Separe cada id por vírgula.

createdAtFrom

date

Não

Data de criação inicial

createdAtTo

date

Não

Data de criação final.

payDayFrom

date

Não

Data de vencimento inicial

payDayTo

date

Não

Data de vencimento final

updateStatusFrom

date

Não

Data de atualização do status da transação inicial

updateStatusTo

date

Não

Data de atualização do status da transação final

status

string

Não

Status da transação.
Separe cada valor por vírgula

Valor	Explicação
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
pendingBoleto	Boleto em aberto
chargeback	Estorno por Chargeback
payedBoleto	Boleto compensado
notCompensated	Boleto baixado por decurso de prazo
pendingPix	Pix em aberto
payedPix	Pix pago
unavailablePix	Pix indisponível para pagamento
cancel	Cancelada manualmente
payExternal	Paga fora do sistema
cancelByContract	Cancelada ao cancelar a cobrança
free	Isento

startAt

int

Sim

Ponteiro inicial para trazer os registros.

limit

int

Sim

Qtd máxima de registros para trazer.

order

string

Não

Ordenação do resultado. String que deverá ser montada da seguinte maneira:
campoDaEntidade.tipoDeOrdem

Caso queira passar mais de uma ordenação, separar por vírgula:
campoDaEntidade.tipoDeOrdem, campoDaEntidade2.tipoDeOrdem

Valor	Explicação
createdAt.asc	Transação criada em - Ordem crescente
createdAt.desc	Transação criada em - Ordem descrescente
payday.asc	Vencimento da transação - Ordem crescente
payday.desc	Vencimento da transação - Ordem decrescente

URL da Requisição

https://api.sandbox.cel.cash/v2/transactions

Código da resposta

---

Tempo de resposta

---

Body da Resposta

{
    "totalQtdFoundInPage": 1,
    "Transactions": [
        {
            "myId": "pay-664ad2c9eada26.76333121",
            "galaxPayId": 1,
            "chargeGalaxPayId": 2,
            "subscriptionGalaxPayId": 1,
            "chargeMyId": "12ASD",
            "value": 12999,
            "payday": "2024-05-20",
            "payedOutsideGalaxPay": false,
            "additionalInfo": "Lorem ipsum dolor sit amet.",
            "installment": 3,
            "paydayDate": "2024-05-20",
            "reasonDenied": "Limite do cartão insuficiente.",
            "authorizationCode": "pay-664ad2ca0358f2.88802742",
            "tid": "pay-664ad2ca046f01.94478525",
            "statusDate": "2024-05-20 01:34:18",
            "AbecsReasonDenied": {
                "code": "51",
                "message": "Saldo/limite insuficiente"
            },
            "datetimeLastSentToOperator": "2024-05-20 01:34:18",
            "status": "captured",
            "fee": 300,
            "statusDescription": "Capturada na Operadora",
            "Boleto": {
                "pdf": "https://app.celcoin.com.br/link-pdf",
                "bankLine": "23312323232323232323232323232",
                "bankAgency": "0001",
                "bankAccount": "12345"
            },
            "Pix": {
                "qrCode": "ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123",
                "reference": "E202405200134182133233F57E731078D43B06A1195FB70",
                "image": "https://app.celcoin.com.br/link-image-qrcode",
                "page": "https://app.celcoin.com.br/link-page-qrcode",
                "endToEnd": "E202405200134182133233F57E731078D43B06A1195FB70"
            },
            "Charge": [
                {
                    "galaxPayId": 1,
                    "myId": "pay-664ad2ca1f2b48.73542084",
                    "planMyId": "pay-664ad2ca232480.38031346",
                    "planGalaxPayId": 1,
                    "paymentLink": "https://app.celcoin.com.br/link-payment",
                    "mainPaymentMethodId": "creditcard",
                    "additionalInfo": "Lorem ipsum dolor sit amet.",
                    "value": 12999,
                    "status": "active",
                    "Customer": {
                        "galaxPayId": 1,
                        "myId": "pay-664ad2ca328d25.50581303",
                        "name": "Lorem ipsum dolor sit amet.",
                        "document": "39688848255",
                        "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"
                        }
                    },
                    "PaymentMethodCreditCard": {
                        "qtdInstallments": 12,
                        "Card": {
                            "myId": "pay-664ad2ca4968e9.15235497",
                            "galaxPayId": 1,
                            "number": "5451*********1515",
                            "createdAt": "2020-06-02 10:10:00",
                            "updatedAt": "2020-06-02 10:10:00",
                            "expiresAt": "2024-05"
                        }
                    },
                    "PaymentMethodBoleto": {
                        "fine": 100,
                        "interest": 200,
                        "instructions": "Lorem ipsum dolor sit amet.",
                        "deadlineDays": 1
                    }
                }
            ],
            "CreditCard": {
                "Card": {
                    "myId": "pay-664ad2ca55c034.13773425",
                    "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": "bin,rede"
                    },
                    "expiresAt": "2024-05"
                }
            }
        }
    ]
}

Nome

Tipo

Explicação

totalQtdFoundInPage

int 11 dígitos

Quantidade total de registros do retorno da busca na página atual.

Transactions

Array de transações.
Clique para ver os campos.

myId

string 255 caracteres

Id referente no seu sistema.

galaxPayId

int 11 dígitos

Id no cel_cash

chargeGalaxPayId

int 11 dígitos

Charge.galaxPayId.
Id da cobrança avulsa no cel_cash.
Só será retornado quando a transação for referente a uma cobrança avulsa.

subscriptionGalaxPayId

int 11 dígitos

Subscription.galaxPayId.
Id da assinatura no cel_cash. Só será retornado quando a transação for referente a uma assinatura.

subscriptionMyId

string 255 caracteres

Subscription.myId.
Id da assinatura referente no seu sistema. Só será retornado quando a transação for referente a uma assinatura.

chargeMyId

string 255 caracteres

Charge.myId.
Id da cobrança avulsa no seu sistema.
Só será retornado quando a transação for referente a uma cobrança avulsa.

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.

paydayDate

date

Data do pagamento.

reasonDenied

string 255 caracteres

Motivo de negação da transação (Quando houver).

authorizationCode

string 255 caracteres

Código de autorização da transação na operadora.

tid

string 255 caracteres

TID: Identificador da transação na operadora.

statusDate

datetime

Data do status

AbecsReasonDenied

Motivo de negação da transação (Quando houver).
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

fee

int 11 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.

Boleto

Dados do boleto atrelado.
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.

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

Charge

Dados da cobrança avulsa.
Clique para ver os campos.

galaxPayId

int 11 dígitos

Id no cel_cash

myId

string 255 caracteres

Id referente no seu sistema.

planMyId

string 255 caracteres

Plan.myId
ID do plano no seu sistema.

planGalaxPayId

int 11 dígitos

Plan.galaxPayId
ID do plano no cel_cash.

planMyId

string 255 caracteres

Plan.myId
ID do plano no seu sistema.

planGalaxPayId

int 11 dígitos

Plan.galaxPayId
ID do plano no cel_cash.

paymentLink

string 255 caracteres

Link para pagamento.

mainPaymentMethodId

string 30 caracteres

PaymentMethod.id
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

additionalInfo

text

Texto livre dedicado a informações adicionais internas.

value

int 11 dígitos

Preço em centavos.

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.

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.

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.

qtdInstallments

int 11 dígitos

Quantidade de parcelas.

Card

Cartão
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

PaymentMethodBoleto

Configurações do meio de pagamento de boleto.
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.

deadlineDays

int 11 dígitos

Quantidade de dias que o boleto pode ser pago após o vencimento.

Subscription

Dados da assinatura.
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.

planGalaxPayId

int 11 dígitos

Plan.galaxPayId
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.

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.

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.

Card

Cartão
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.

PaymentMethodBoleto

Configurações do meio de pagamento de boleto.
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.

CreditCard

Dados do cartão de crédito da transação.
Clique para ver os campos.

Card

Cartão.
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.

string 30 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

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

error

Nó de erros, caso haja.
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.

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 transação encontrada com os parâmetros utilizados.