Consultar status de um saque solicitado na conta

Esse endpoint permite consultar o status de uma solicitação de saque realizada.

Parâmetros da URL

  • id_withdraw (string/uuid v4): ID da solicitação de saque realizada.

Parâmetros da Requisição

Não é necessário o envio de nenhum dado no corpo da requisição.

Resposta

Em caso de sucesso será retornado um status 200 e um arquivo JSON no seguinte formato:

  • status (string): Status da solicitação de saque realizada.
  • receipt (string): Descrição/recibo da solicitação de saque.
  • body (object): Objeto contendo os detalhes da solicitação de saque.
Objeto "body"
  • id (string/uuid v4): ID do saque realizado.
  • amount (float); Valor do saque.
  • client_code (string): Código do cliente.
  • transaction_identification (string): Protocolo de identificação da operação.
  • end_to_end_id (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.
  • initiation_type (string):
  • payment_type (string):
  • urgency (string):
  • transaction_type (string): Tipo da transação.
  • 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).
  • remittance_information(string): Informação da remessa. Texto informado na transação.
  • error (string): Mensagem de erro, se aplicável
Objeto "debit_party"
  • bank (string): Código do banco.
  • account (string): Número da conta
  • branch (string): Número da agência.
  • tax_id (string): Número do documento (CPF ou CNPJ) da conta de origem.
  • name (string): Nome do titular da conta.
  • account_type (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 "credit_party"
  • bank (string): Código do banco.
  • account (string): Número da conta
  • branch (string): Número da agência.
  • tax_id (string): Número do documento (CPF ou CNPJ) da conta de destino.
  • name (string): Nome do titular da conta.
  • account_type (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:
{
    "status": "",
    "receipt": "",
    "body": {
        "id": "",
        "amount": "",
        "client_code": "",
        "transaction_identification": "",
        "end_to_end_id": "",
        "initiation_type": "",
        "payment_type": "",
        "urgency": "",
        "transaction_type": "",
        "debit_party": {
            "account": "",
            "branch": "",
            "tax_id": "",
            "name": "",
            "account_type": ""
        },
        "credit_party": {
            "bank": "",
            "key": "",
            "account": "",
            "branch": "",
            "tax_id": "",
            "name": "",
            "account_type": ""
        },
        "remittance_information": "",
        "error": ""
    }
}

Language
URL
Click Try It! to start a request and see the response here!