DocumentaçãoAPIStatusSuporteFAQscelcoin.com

Verifica o Status de uma transação Pix

Suggest Edits

Essa funcionalidade permite que os clientes da Celcoin consigam verificar o status de algum Pix realizado em suas 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é 4 tipos de status diferentes:

Status 0: INITIATED: Transação Pix iniciada;

Status 1: PROCESSING: Transação ainda em processamento;
Status 2: CONFIRMED: Transação confirmada com sucesso;
Status 3: 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. clientCode
      3. endToEndId

Fluxo de integração

Consultar Pix

cURL da chamada

curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/baas-wallet-transactions-webservice/v1/pix/payment/status?id={{id}}' \
--header 'accept: application/json' \
--header 'Authorization: Bearer {{token}}'

Exemplo de retorno

👍

Sucesso 200

{
    "status": "CONFIRMED",
    "version": "1.0.0",
    "body": {
        "id": "60ec4471-71dd-43a3-a848-efe7a314d76f",
        "amount": 50,
        "clientCode": "1458856889",
        "transactionIdentification": null,
        "endToEndId": "E1393589320221110144001306556986",
        "initiationType": "MANUAL",
        "paymentType": "IMMEDIATE",
        "urgency": "HIGH",
        "transactionType": "TRANSFER",
        "debitParty": {
            "account": "30053913714179",
            "branch": "0001",
            "taxId": "77859635097",
            "name": "Hernani  Conrado",
            "accountType": "TRAN"
        },
        "creditParty": {
            "bank": "30306294",
            "key": null,
            "account": "42161",
            "branch": "20",
            "taxId": "12312312300",
            "name": "Fulano de Tal",
            "accountType": "CACC"
        },
        "remittanceInformation": "Texto de mensagem",
        "error": null
    }
}

❗

Error 400

{
  "version": "1.0.0",
  "status": "ERROR",
  "error": {
    "errorCode": "CBE150",
    "message": "É necessário informar pelo menos um dos campos: id, clientCode, ou endtoendId."
  }
}

Tabela de errorCode

CodeMessage
CBE150É necessário informar pelo menos um dos campos: id, clientCode, ou endtoendId.

Updated about 2 months ago