API REFERENCE
...
Payments
Instant payment

Get a Payment Initiation

3min
Get a payment initiation inform
GET
Request
Path Params
id
required
String
ayment initiation id, it will be returned when POST /payments is called
Header Parameters
Authorization
required
String
JWT bearer token
Curl
Node.js
JS
Python
Ruby
Responses
200
409


Request example

Curl


Response

Just added the following fields on the basis of Get a Payment Initiation's response:

Attribute

Type

Description

endToEndId

String

It is a unique identifier, generated in the initiating payment institution and received in the account holding institution, permeating the entire payment journey Pix.

minLength: 32 maxLength: 32 pattern: ^([E])([0-9]{8})([0-9]{4})(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])(2[0-3]|[01][0-9])([0-5][0-9])([a-zA-Z0-9]{11})$ example: E9040088820210128000800123873170

consentId

String

Unique identifier of the consent created for the initiation of the requested payment

maxLength: 256 pattern: ^urn:[a-zA-Z0-9][a-zA-Z0-9\-]{0,31}:[a-zA-Z0-9()+,\-.:=@;$_!*'%\/?#]+$ example: urn:bancoex:C1DD33123

paymentId

String

Unique code or identifier provided by the account holding institution to represent the initiation of individual payment. The paymentId must be different from endToEndId. This is the identifier that should be used to query the status of the payment initiation made.

minLength: 1 maxLength: 100 pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$ example: TXpRMU9UQTROMWhZV2xSU1FUazJSMDl