DocumentaçãoAPIStatusSuporteFAQscelcoin.com

Consultar Status de uma devolução Pix

Suggest Edits

Com essa chamada você realizará uma consulta de devolução Pix.

Passos para Integrar

  1. Realizar autenticação na API - [API Reference]
  2. Consultar uma devolução Pix -[API Reference]

Parâmetros para realizar busca

StatusDescrição
idIdentificador da transação retornado na requisição de payment.
clientCodeIdentificador único gerado pelo cliente.
returnIdentificationIdentificador ponta-a-ponta associado a devolução pix.

cURL da chamada

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

Status

StatusDescrição
PROCESSINGTransação ainda em processamento;
CONFIRMEDTransação confirmada com sucesso;
ERRORTransação com erro.Vide nó 'error' do payload de response para detalhes sobre o erro.

Exemplo de retorno

👍

Sucesso 200

{
  "status": "PROCESSING",
  "version": "1.0.0",
  "body": {
    "id": "34fee7bc-4d40-4605-9af8-398ed7d0d6b4",
    "amount": 25.55,
    "clientCode": "1458854",
    "originalPaymentId": "34fee7bc-4d40-4605-9af8-398ed7d0d6b5",
    "endToEndId": "E3030629420200808185300887639654",
    "returnIdentification": "D3030629420200808185300887639654",
    "reason": "MD06",
    "reversalDescription": "Devolução do churrasco"
  }
}

❗

Error 400

{
  "version": "1.0.0",
  "status": "ERROR",
  "error": {
    "errorCode": "CBE001",
    "message": "ClientCode é obrigatório."
  }
}

Tabela de errorCode

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

❗

Error 401 | Error 404 | Error 500 | Error 504

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

Updated 5 months ago