v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Verificar o status de um pagamento Pix

Endpoint destinado a consulta de status posterior ao recebimento de webhook, ou em caso de muita demora para o recebimento da confirmação.

A consulta receberá o parâmetro gerado na requisição de pagamento, como parâmetro de entrada para realizar a consulta.

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;

As consultas de status realizadas neste endpoint, só terão um status válido a partir de 2 minutos após o recebimento da resposta de sucesso da requisição de pagamento.

get/payment/pi/status

Query parameters

transactionIdinteger

Identificador da transação retornado na requisição de payment

endtoendIdstring

End-to-end identificador ponta-a-ponta da transação. O mesmo utilizando no DICT GET.

clientCodestring

Identificador unico fornecido pelo cliente durante a requisição de payment.

Response

200

transactionIdinteger
clientCodestring
endToEndIdstring
statusstring

Example response

{
  "transactionId": 9193070,
  "clientCode": "312312312",
  "endToEndId": "E1393589320220322182401415343541",
  "status": "ERROR",
  "error": {
    "code": "PBE343",
    "description": "Settlement of the transaction has failed."
  }
}