API REFERENCE
...
Payments
Instant payment
Get a payment initiation
1 min
Get a payment initiation inform
GET
Request
Response
Path Params
id
String
required
ayment initiation id, it will be returned when POST /payments is called
Header Parameters
Authorization
String
required
JWT bearer token
Curl
Node.js
JS
Python
Ruby
1curl --location --globoff 'https://api-testing.klavi.ai/payment/customer/v1/payments/{id}' \
2--header 'Accept: application/json' \
3--header 'Content-Type: application/json'
Responses
200
409
1{
2 "id": "fcb72e3a-b346-4f71-b044-971dc23232c9", // Required
3 "appId": "0b59d801-08e0-4e84-9ecd-569f34e32279", // Required
4 "clientRequestId": "fcb72e3a-b346-4f71-b044-dsndsnmnkdsmk", // Required
5 "institutionId": "c8f0bf49-4744-4933-8960-7add6e590841", // Required
6 "customer":
7 {
8 "identifierType": "CPF", // Required, CPF | CNPJ
9 "identifier": "76109277673", // Required
10 "name": "João Silva", // Optional
11 "phone": "12345", // Optional
12 "email": "123@123.com" // Optional
13 }, // Required
14 "date": "2023-01-23", // Required, utc -3
15 "consentId": "yyt72e3a-b846-i771-b044-971dc232ujd8", // Required
16 "endToEndId": "E9040088820210128000800123873170", // Required after the status CONSENT_AUTHORIZED
17 "transactionIdentification": "cxf0bf49-4744-4933-8960-7add6e5908cc", // Optional
18 "loggedUserCpf": "76109277673", // required if customer.identifierType = CNPJ
19 "ibgeTownCode": "5300108", // Optional
20 "proxy": "xxxxx", // Required if method = PIX_DICT or if method = PIX_INIC
21 "qrCode": "xxxxx", // Required if method = PIX_QRCODE
22 "initType": "PIX_INIC", // Required
23 "amount": "1333.04", // Required
24 "currency": "BRL", // Required
25 "remittanceInformation": "Any description", // Optinal, payment description
26 "debtorAccount":
27 {
28 "ispb": "00000000", // Required, ISPB (Brazilian Payment System Identifier) of the SPI (Instant Payment System)
29 "issuer": "0001", // Optional, Code of the issuing Agency of the account without digit.
30 "number": "324223", // Required, account number
31 "accountType": "CACC" // Required, CACC(Current Account)|SVGS(Savings Account)|TRAN(TransactingAccount)
32 }, // Optinal, payer's account
33 "creditorAccount":
34 {
35 "ispb": "00000000", // Required
36 "issuer": "0001", // Optional
37 "number": "324223", // Required
38 "accountType": "CACC", // Required
39 "holder":
40 {
41 "identifier": "76109277673", // Required
42 "name": "John Doe", // Required
43 "identifierType": "CPF" // Required
44 } // Required
45 }, // Required if mthod = PIX_MANU
46 "externalInfo":
47 {
48 "key": "value"
49 }, // Optional
50 "cancellation":
51 {
52 "cancelledFrom": "MERCHANT", // Required, the cancellation source, MERCHANT|INITIATOR|INSTITUTION
53 "cancelledAt": "2021-05-21T08:30:00Z", // Required
54 "cancelledBy":
55 {
56 "identifier": "11111111111", // Required
57 "identifierType": "CPF" // Required
58 } // Required
59 }, // Required if the status is CANCELED
60 "status": "CANCELED", // Required
61 "statusReason": {
62 "code": "NAO_INFORMADO", // Required
63 "message": "Erro não informado na iniciadora ou detentora de conta." // Required
64 }, // Optional
65 "createAt": "2023-01-23T14:17:06.45Z", // Required
66 "statusUpdateAt": "2023-01-23T14:17:06.45Z" // Required
67}
Updated 19 Jun 2025
Did this page help you?