API REFERENCE
...
Orders
Get all payment initiation orders
1 min
Get all payment initiation orders
GET
Request
Response
Path Params
appId
String
required
App ID
Query Parameters
pageSize
String
optional
Page size(default:20, Max: 200)
cursor
String
optional
page cursor
startDate
String
optional
Start date
for example: 2025-06-01
endDate
String
optional
End date
for example: 2025-06-01
Header Parameters
Authorization
String
required
Bearer access token, it returned by the /auth
Curl
Node.js
JS
Python
Ruby
1require "uri"
2require "json"
3require "net/http"
4
5url = URI("https://api-sandbox.klavi.ai/payment/management/v1/merchants/{appId}/orders")
6
7https = Net::HTTP.new(url.host, url.port)
8https.use_ssl = true
9
10request = Net::HTTP::Get.new(url)
11request["Accept"] = "application/json"
12request["Content-Type"] = "application/json"
13
14response = https.request(request)
15puts response.read_body
16
Responses
200
1{
2 "data": [{
3 "id": "fcb72e3a-b346-4f71-b044-971dc23232c9", // Required
4 "appId": "0b59d801-08e0-4e84-9ecd-569f34e32279", // Required
5 "clientRequestId": "fcb72e3a-b346-4f71-b044-dsndsnmnkdsmk", // Required
6 "institutionId": "c8f0bf49-4744-4933-8960-7add6e590841", // Required
7 "customer": {
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
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 "ispb": "00000000", // Required, ISPB (Brazilian Payment System Identifier) of the SPI (Instant Payment System)
28 "issuer": "0001", // Optional, Code of the issuing Agency of the account without digit.
29 "number": "324223", // Required, account number
30 "accountType": "CACC" // Required, CACC(Current Account)|SVGS(Savings Account)|TRAN(TransactingAccount)
31 }, // Optinal, payer's account
32 "creditorAccount": {
33 "ispb": "00000000", // Required
34 "issuer": "0001", // Optional
35 "number": "324223", // Required
36 "accountType": "CACC", // Required
37 "holder": {
38 "identifier": "76109277673", // Required
39 "name": "John Doe", // Required
40 "identifierType": "CPF" // Required
41 } // Required
42 }, // Required if mthod = PIX_MANU
43 "externalInfo": {
44 "key": "value"
45 }, // Optional
46 "cancellation": {
47 "cancelledFrom": "MERCHANT", // Required, the cancellation source, MERCHANT|INITIATOR|INSTITUTION
48 "cancelledAt": "2021-05-21T08:30:00Z", // Required
49 "cancelledBy": {
50 "identifier": "11111111111", // Required
51 "identifierType": "CPF" // Required
52 } // Required
53 }, // Required if the status is CANCELED
54 "status": "CANCELED", // Required
55 "statusReason": {
56 "code": "NAO_INFORMADO", // Required
57 "message": "Erro não informado na iniciadora ou detentora de conta." // Required
58 }, // Optional
59 "createAt": "2023-01-23T14:17:06.45Z", // Required
60 "statusUpdateAt": "2023-01-23T14:17:06.45Z" // Required
61 }],
62 "paging": {
63 "nextCursor": "eyJjcmVhdGVkX2F0IjnBheW1lbnRfaWQiOiJwYXlfMTIzIn0", // Optional
64 "prevCursor": "eyJjcmVhdGVkX2F0IjnBheW1lbnRfaWQiOiJwYXlfMTEwIn0", // Optional
65 "hasNext": true, // Required
66 "hasPrev": true // Required
67 }
68}
Updated 03 Jul 2025
Did this page help you?