get https://sandbox.auth.flowfinance.com.br/v1/accounts//statement//status
Esse endpoint é responsável por retornar o status e detalhamento de uma transação do extrato.
Parâmetros da Requisição
account_id
(string): ID de cadastro para identificação da conta a ser consultada.
client_code
(string): Identificador único gerado pelo cliente.
Resposta
Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato:
id
(string): ID da transação.
amount
(float): Valor da transação
clientCode
(string): Identificador único gerado pelo cliente.
debitParty
(object): Objeto contendo os dados da conta de origem (quem irá pagar).
creditParty
(object): Objeto contendo os dados da conta de destino (quem irá receber).
transactionIdentification
(string): Protocolo de identificação da operação.
endToEndId
(string): Identificador ponta-a-ponta associado ao pagamento. Se initiationType igual a MANUAL, esse campo não deve ser informado pois o mesmo sera gerado pela plataforma Celcoin.
initiationType
(string): Tipo de iniciação do pagamento. Possíveis valores:- 'MANUAL': Pagamento via dados transacionais da conta (creditParty.key, endToEndId, e transactionIdentification, não devem ser enviados).
- 'DICT': Pagamento PIX via chave. (Campos obrigatórios : creditParty.key, e endToEndId.transactionIdentification não deve ser informado).
- 'STATIC_QRCODE': Pagamento PIX via BRCode estatico. (Campos obrigatórios : creditParty.key, endToEndId, e transactionIdentification).
- 'DYNAMIC_QRCODE': Pagamento PIX via BRCode dinamico. (Campos obrigatórios : creditParty.key, endToEndId, e transactionIdentification).
- 'MANUAL': Pagamento via dados transacionais da conta (creditParty.key, endToEndId, e transactionIdentification, não devem ser enviados).
paymentType
(string): Tipo de pagamento. Possíveis valores: IMMEDIATE: Usado para pagamentos imediatos; FRAUD: Usado para pagamento por suspeita de fraude; SCHEDULED: Usado apenas para pagamentos agendados.
urgency
(string): Determina a urgência do pagamento. Possíveis valores:- 'HIGH' - Usado para pagamentos imediatos.
- 'NORMAL' - Usado para pagamentos agendados.
- 'HIGH' - Usado para pagamentos imediatos.
transactionType
(string): Tipo da transação de PIX. Possíveis valores: TRANSFER.
remittanceInformation
(string): Informação da remessa. Texto a ser informado na transação.
Objeto 'debitParty'
bank
(string): Código do banco.
account
(string): Número da conta
branch
(string): Número da agência.
taxId
(string): Número do documento (CPF ou CNPJ) da conta de origem.
name
(string): Nome do titular da conta.
accountType
(string): Tipo da conta. Possíveis valores: CC - Conta Corrente; CI - Conta Investimento; PG - Conta de Pagamento; PP - Conta Poupança.
key
(string): Chave PIX
Objeto 'creditParty'
bank
(string): Código do banco.
account
(string): Número da conta
branch
(string): Número da agência.
taxId
(string): Número do documento (CPF ou CNPJ) da conta de destino.
name
(string): Nome do titular da conta.
accountType
(string): Tipo da conta. Possíveis valores: CC - Conta Corrente; CI - Conta Investimento; PG - Conta de Pagamento; PP - Conta Poupança.
key
(string): Chave PIX
Exemplo de JSON:
{
"id": "<string>",
"amount": "<number>",
"clientCode": "<string>",
"debitParty": {
"account": "<string>",
"branch": "<string>",
"taxId": "<string>",
"name": "<string>",
"accountType": "<string>"
},
"creditParty": {
"bank": "<string>",
"account": "<string>",
"branch": "<string>",
"taxId": "<string>",
"name": "<string>",
"accountType": "<string>",
"key": "<string>"
},
"transactionIdentification": "<string>",
"endToEndId": "<string>",
"initiationType": "<string>",
"paymentType": "<string>",
"urgency": "<string>",
"transactionType": "<string>",
"remittanceInformation": "<string>"
}