Consulta status da uma transferência entre contas

Essa funcionalidade permite que os clientes da Celcoin consigam verificar o status de alguma transferência entre contas BaaS, a consulta de status pode ser feita posterior ao recebimento de webhook ou em caso de muita demora para o recebimento da confirmação via webhook.

No resultado, serão apresentado até 3 tipos de status diferentes:

PROCESSING: Transação ainda em processamento;
CONFIRMED: Transação confirmada com sucesso;
ERROR: Transação com erro.Vide nó 'error' do payload de response para detalhes sobre o erro.


Passos para Integrar

  1. Realizar autenticação na API - [API Reference]
  2. Realiza a consulta na API - [API Reference]
    1. Você pode realizar a consulta utilizando 3 campos:
      1. id
      2. ClientRequestId
      3. EndToEndId

Fluxo de integração

Consultar TED

cURL da chamada

curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/baas-wallet-transactions-webservice/v1/wallet/internal/transfer/status?Id=ea88d9f7-94a6-4e94-8381-4d98d2ce8a63&ClientRequestId=d4e1798f-33d7-4ff3-97d2-4ba27cc72a27&EndToEndId=14900436-a81d-497e-b2bc-3178e0ecdd78' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data-raw ''

Exemplo de retorno

👍

Sucesso 200

{
  "status": "PROCESSING",
  "version": "1.0.0",
  "body": {
    "id": "34fee7bc-4d40-4605-9af8-398ed7d0d6b5",
    "amount": 0,
    "clientRequestId": "1458854",
    "endToEndId": "string",
    "debitParty": {
      "account": "444444",
      "taxId": "11122233344",
      "name": "string",
      "branch": "string",
      "bank": "string"
    },
    "creditParty": {
      "account": "10545584",
      "taxId": "11122233344",
      "name": "string",
      "branch": "string",
      "bank": "string"
    },
    "description": "transferencia para o churrasco"
  }
}

Error 400

{
  "version": "1.0.0",
  "status": "ERROR",
  "error": {
    "errorCode": "CIE999",
    "message": "Ocorreu um erro interno durante a chamada da api."
  }
}

Tabela de errorCode

CodeMessage
CBE094amount é obrigatório.
CBE095amount invalido.Favor verificar a formatação do campo e deve ser maior que 0.
CBE100Existe um lançamento idêntico pendente.Favor aguarde para realizar esta operação para evitar duplicidade.
CBE101Já existe um lançamento com o mesmo clientCode. Favor realizar uma nova operação.
CBE102Lançamento de debito não permitido.Valor ultrapassa o limite maximo permitido por operação.
CBE107debitParty é obrigatório.
CBE108debitparty.account é obrigatório.
CBE109debitparty.account invalido.
CBE110debitparty.account possui tamanho maximo de 20 caracteres.
CBE115creditParty é obrigatório.
CBE116creditparty.account é obrigatório.
CBE117creditparty.account invalido.
CBE118creditparty.account possui tamanho maximo de 20 caracteres.
CBE123Transação não permitida.Conta com saldo insuficiente.
CBE124Lançamento não permitido. debit.account esta encerrada.
CBE125Lançamento não permitido. credit.account esta encerrada.
CBE147Lançamento não permitido. debit.account esta bloqueada.
CBE148Lançamento não permitido. credit.account esta bloqueada.
CBE261clientRequestId é obrigatório.
CBE308clientRequestId possui tamanho máximo de 200 caracteres.
CBE312Não é permitido enviar TEF para a mesma conta.
CBE314debitparty.account não encontrada.
CBE315creditparty.account não encontrada.
CBE328Cliente da conta de credito não esta ativo para utilizar a Api.
CBE329É necessário informar pelo menos um dos campos: id ou clientrequestid.
CBE332Parametro Id ultrapassou o limite maximo de 36 caracteres.