Consultar Extrato
GET /company/balance/movements
Para utilizar esse método, o access_token deve conter o scope balance.read
Retorna todas as informações do extrato de acordo com o filtro informado.
URL da Requisição
https://api.sandbox.cel.cash/v2/company/balance/movements
Código da resposta
---
Tempo de resposta
---
Body da Resposta
{
"type": true,
"Balances": [
{
"galaxPayId": 1,
"value": 129.99,
"createdAt": "2020-06-02 10:10:00",
"friendlyDescription": "\"Boleto Recebido - Transação 347616065\"",
"groupPaymentType": "boleto",
"paymentType": "credit",
"transactionGalaxPayId": 347616065
}
],
"Totals": [
{
"initial": 10000,
"final": 20000
}
]
}
Nome
Tipo
Explicação
type
bool
Sucesso ou não da ação.
Balances
Array de movimentações.
Clique para ver os campos.
Clique para ver os campos.
galaxPayId
int 11 dígitos
Id do saldo no cel_cash.
value
decimal
Valor da movimentação realizada.
createdAt
datetime
Data de criação.
friendlyDescription
string 255 caracteres
Descrição da movimentação realizada.
groupPaymentType
string 255 caracteres
Grupo da movimentação realizada.
Valor
Explicação
phoneRecharge
Recarga de Celular
returnPix
Pix recebido por Chave
returnTransactionPix
Pix recebido por QRCode dinâmico
notificationWhatsapp
Notificação whatsapp
inactiveTax
Tarifa de conta inativa
purchaseModule
Compra de módulo
paymentPix
Pix enviado
mensality
Mensalidade
devolutionPix
Devolução de Pix
specialDevolution
Mecanismo de devolução especial do pix
antecipationBlockedToEnabled
Tarifa de Antecipação de Saldo de Boleto
reverseValue
Estorno em Conta
subacquirer
Cartão de Crédito
debitValue
Débito em Conta
notificationSms
Notificação SMS
blockedBalance
Bloqueio de Saldo
comission
Comissão
withdraw
Saque/Transferências
billPayment
Pagamento de conta
boleto
Boleto
paymentType
string 255 caracteres
Tipo de movimentação realizada.
Valor
Explicação
Opções válidas para boleto:
debitSplit
Débito de valor que foi realizado o Split
creditSplit
Crédito de valor que foi recebido por Split
credit
Crédito de Boleto Pago
creditPix
Crédito de Boleto Pago via Pix
debitTaxPix
Débito da Taxa de Boleto Pago via Pix
debitTax
Débito da Taxa de Boleto Pago
Opções válidas para blockedBalance:
debitValueEnabledMed
Débito do valor bloqueado pelo MED
creditValueEnabledMed
Crédito do valor recebido por MED
Opções válidas para comission:
boletoCreditEnabled
Crédito do valor da comissão
Opções válidas para withdraw:
creditValueEnabledCancel
Crédito do valor da transferência cancelada
creditTaxNormalEnabledCancel
Crédito da tarifa de transferência cancelada
creditTaxAntecipationEnabledCancel
Crédito da tarifa de transferência antecipada
creditValueEnabled
Crédito do valor de transferência devolvida por erro
debitValueEnabled
Débito do valor da transferência
debitTaxNormalEnabled
Débito da tarifa de transferência
debitTaxAntecipationEnabled
Débito da tarifa de transferência antecipada
Opções válidas para billPayment:
creditValueCancel
Crédito do valor de pagamento cancelado
debitValue
Débito do valor do pagamento
debitTax
Débito da tarifa de pagamento
Opções válidas para subacquirer:
debitSplit
Débito de valor que foi realizado o Split
creditSplit
Crédito de valor que foi recebido por Split
debitCardSubacquirerChargeback
Estorno por chargeback para transações no cartão de débito
debitCardSubacquirerCredit
Crédito do recebimento por cartão de débito
debitCardSubacquirerDebitTax
Débito da tarifa por cartão de débito
debitCardDebitSplit
Débito de valor que foi realizado o Split
debitCardCreditSplit
Crédito de valor que foi recebido por Split
subacquirerChargeback
Estorno por chargeback para transações no cartão de crédito
subacquirerReversal
Estorno
subacquirerCredit
Crédito do recebimento por cartão de crédito
subacquirerDebitTax
Débito da tarifa por cartão de crédito
subacquirerDebitTaxAntecipation
Débito da tarifa de antecipação
Opções válidas para returnTransactionPix:
debitSplit
Débito de valor que foi realizado o Split
creditSplit
Crédito de valor que foi recebido por Split
credit
Crédito de QR Code Pago
debitTax
Débito da Taxa de QR Code Pago
Opções válidas para paymentPix:
creditGrossValueEnabledError
Crédito do valor de Pix devolvido por erro
creditTaxEnabledError
Crédito da tarifa de Pix devolvido por erro
debitGrossValueEnabled
Débito do valor de Pix Realizado
debitTaxEnabled
Débito da taxa de Pix Realizado
Opções válidas para notificationSms:
debitTax
Débito da tarifa de notificação SMS
Opções válidas para notificationWhatsapp:
debitTax
Débito da Taxa de Notificação WhatsApp
Opções válidas para inactiveTax:
debitTax
Débito da Taxa de Inativação da Conta
Opções válidas para purchaseModule:
debit
Débito de valor da Compra de Módulo
Opções válidas para mensality:
debitNotificationWhatsApp
Débito da Mensalidade do Módulo: Notificações WhatsApp
debitSplit
Débito da Mensalidade do Módulo: Split de Pagamentos
Opções válidas para devolutionPix:
creditReceived
Crédito para Devolução Pix Recebida
debitEnabledSended
Débito para Devolução Pix Enviada
Opções válidas para specialDevolution:
creditReceivedEnabled
Crédito para Devolução Pix Recebida via MED (Mecanismo Especial de Devolução)
debitEnabled
Débito para Devolução Pix Enviada via MED (Mecanismo Especial de Devolução)
Opções válidas para antecipationBlockedToEnabled:
debitTax
Débito da Taxa de Antecipação de Saldo Bloqueado de Boleto
Opções válidas para reverseValue:
credit
Crédito do estorno
Opções válidas para debitValue:
debit
Débito
Opções válidas para phoneRecharge:
debit
Débito de valor realizado recarga
transactionGalaxPayId
int 11 dígitos
Id da transação no cel_cash.
Totals
Array resumo de saldo das movimentações.
Clique para ver os campos.
Clique para ver os campos.
initial
decimal
Saldo inicial.
final
decimal
Saldo final.
Código
Explicação
200
Sucesso.
400
Erros de validação.
401
Falha ao autenticar.
403
Validação de segurança.
404
Nenhum extrato encontrado com os parâmetros utilizados.