v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Verificar o status de um pagamento Pix - Versão Enriquecida (V2)

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/pix/v1/payment/v2/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

vlcpAmountnumber

vldnAmountinteger

withdrawalServiceProviderstring

withdrawalAgentModestring

transactionIdentificationstring

endToEndIdstring

initiationTypestring

remittanceInformationstring

paymentTypestring

urgencystring

transactionTypestring

clientCodestring

amountnumber

statusstring

transactionIdinteger

Example response

{
  "vlcpAmount": 15.55,
  "vldnAmount": 10,
  "withdrawalServiceProvider": "13935893",
  "withdrawalAgentMode": "AGTEC",
  "transactionIdentification": "dc8cf02b81b54bd59323453b207e704a",
  "endToEndId": "E3030629420200808185300887639654",
  "debitParty": {
    "account": "3794245",
    "branch": 30,
    "bank": "13935893",
    "taxId": "13935893000109",
    "accountType": "CACC",
    "name": "IS2B - Integrated Solutions to Business S.A"
  },
  "creditParty": {
    "key": "5244f4e-15ff-413d-808d-7837652ebdc2",
    "bank": "30306294",
    "account": "10545584",
    "taxId": "11122233344",
    "accountType": "CACC",
    "name": "Celcoin"
  },
  "initiationType": "DICT",
  "remittanceInformation": "Texto de mensagem",
  "paymentType": "IMMEDIATE",
  "urgency": "HIGH",
  "transactionType": "TRANSFER",
  "clientCode": "1458854",
  "amount": 25.55,
  "status": "CONFIRMED",
  "error": {
    "code": "PBE150",
    "description": "General reject operation."
  },
  "transactionId": 234123543
}