Get all orders from an consent

1 min

Returns the paged list of the orders created through the given automatic PIX consent

GET

https://api-sandbox.klavi.ai/payment/management/v1/merchants/automatic/{appId}/consents/{consentId}/orders

Path Parameters

appIdstringrequired
Description
ID of application for partner
consentIdstringrequired
Description
ID of consent

Query Parameters

startDatestring
Description
Start date for example: 2025-06-01
endDatestring
Description
End date for example: 2025-06-01
pageSizestring
Description
Page size(default:20, Max: 200)
cursorstring
Description
Page cursor

Header Parameters

Authorizationstringrequired
Description
Bearer access token, it returned by the /auth

Response

dataobject
- idstring
- appIdstring
  Description
  App ID for partner
- clientRequestIdstring
  Description
  Your internal orderId. Only can be used for once. you can use it to associate a payment and you can use UUID generation algorithm to generate it
- institutionIdstring
  Description
  Id from the bank chosen by the user
- customerobject
  Description
  Id from the bank chosen by the user
  - identifierTypestring
    Description
    Type of the user identification document: CNPJ or CPF If value is CPF: maxLength: 3 example: CPF pattern: ^[A-Z]{3}$ If value is CNPJ maxLength: 4 example: CNPJ pattern: ^[A-Z]{4}$
  - identifierstring
    Description
    The number of the user identification document If identifierType value is CPF: maxLength: 11 example: 11111111111 pattern: ^\d{11}$ If identifierType value is CNPJ: maxLength: 14 example: 11111111111111 pattern: ^\d{14}$
  - namestring
    Description
    Username
  - phonestring
    Description
    User's phone number
  - emailstring
    Description
    User's email
- datestring
  Description
  maxLength: 10 pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$ example: 2021-01-01 Date of payment creation
- consentIdstring
  Description
  pattern: ^urn:[a-zA-Z0-9][a-zA-Z0-9\-]{0,31}:[a-zA-Z0-9()+,\-.:=@;$_!*'%\/?#]+$ maxLength: 256 Consent Id
- endToEndIdstring
  Description
  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: E9040088820241225150000123873170 It should be filled in the default format ExxxxxxxxyyyyMMddHHmmkkkkkkkkk (32 characters; "case sensitive", i.e., case sensitive)
- ibgeTownCodestring
  Description
  ibge town code minLength: 7 maxLength: 7 pattern: ^\d{7}$ example: 5300108
- amountstring
  Description
  Amount that will be paid by the user minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ example: 100000.12 [Restriction] The value with 2 decimal places.
- currencystring
  Description
  maxLength: 3 pattern: ^([A-Z]{3})$ example: BRL National currency code according to ISO-4217, i.e., 'BRL'. All reported monetary values are represented with the current currency of Brazil.
- remittanceInformationstring
  Description
  Payment description maxLength: 140 pattern: [\w\W\s]* example: Pagamento da nota XPTO035-002. It must be filled in whenever the paying user enters some additional information in a payment, to be sent to the recipient.
- debtorAccountobject
  Description
  Payer's origin account information
  - ispbstring
    Description
    minLength: 8 maxLength: 8 pattern: ^[0-9]{8}$ example: 12345678 It must be filled in with the ISPB (Brazilian Payment System Identifier) of the SPI participant (Instant Payment System) with numbers only.
  - issuerstring
    Description
    minLength: 1 maxLength: 4 pattern: ^[0-9]{1,4}$ example: 1774 Code of the Agency issuing the account without digit. [Restriction] Mandatory for the following account types: CACC (CONTA_DEPOSITO_A_VISTA) and SVGS (CONTA_POUPANCA).
  - numberstring
    Description
    minLength: 1 maxLength: 20 pattern: ^[0-9]{1,20}$ example: 1234567890 It must be filled in with the paying user's transactional account number, with verification digit (if any), If there is an alphanumeric value, it should be converted to 0.
  - accountTypestring
    Description
    Types of accounts used for payment. example: CACC Enum: [ CACC, SVGS, TRAN] CACC - Current - Current Account SVGS - Savings - Saving Account TRAN - TransactingAccount - Prepaid Payment Account
- creditorAccountobject
  - ispbstring
    Description
    minLength: 8 maxLength: 8 pattern: ^[0-9]{8}$ example: 12345678 It must be filled in with the ISPB (Brazilian Payment System Identifier) of the SPI participant (Instant Payment System) with numbers only.
  - issuerstring
    Description
    minLength: 1 maxLength: 4 pattern: ^[0-9]{1,4}$ example: 1774 Code of the Agency issuing the account without digit. [Restriction] Mandatory for the following account types: CACC (CONTA_DEPOSITO_A_VISTA) and SVGS (CONTA_POUPANCA).
  - numberstring
    Description
    minLength: 1 maxLength: 20 pattern: ^[0-9]{1,20}$ example: 1234567890 It must be filled in with the paying user's transactional account number, with verification digit (if any), If there is an alphanumeric value, it should be converted to 0.
  - accountTypestring
    Description
    Types of accounts used for payment. example: CACC Enum: [ CACC, SVGS, TRAN] CACC - Current - Current Account SVGS - Savings - Saving Account TRAN - TransactingAccount - Prepaid Payment Account
  - holderobject
    Description
    Holder object
    - identifierstring
      Description
      The number of the user identification document If identifierType value is CPF: maxLength: 11 example: 11111111111 pattern: ^\d{11}$ If identifierType value is CNPJ: maxLength: 14 example: 11111111111111 pattern: ^\d{14}$
    - identifierTypestring
      Description
      Type of the user identification document: CNPJ or CPF If value is CPF: maxLength: 3 example: CPF pattern: ^[A-Z]{3}$ If value is CNPJ maxLength: 4 example: CNPJ pattern: ^[A-Z]{4}$
    - namestring
      Description
      Username
- externalInfoobject
  Description
  Metadata, user customizable
- cancellationobject
  Description
  Object containing the data relating to the paying user who requested the cancellation, the channel used by him and the reason.
  - cancelledFromstring
    Description
    example: INITIATOR Enum: [ INITIATOR, HOLDER ]
  - cancelledAtstring
    Description
    maxLength: 20 pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ example: 2021-05-21T08:30:00Z
  - cancelledByobject
    Description
    Cancel object
    - identifierstring
      Description
      The number of the user identification document If identifierType value is CPF: maxLength: 11 example: 11111111111 pattern: ^\d{11}$ If identifierType value is CNPJ: maxLength: 14 example: 11111111111111 pattern: ^\d{14}$
    - identifierTypestring
      Description
      Type of the user identification document: CNPJ or CPF If value is CPF: maxLength: 3 example: CPF pattern: ^[A-Z]{3}$ If value is CNPJ maxLength: 4 example: CNPJ pattern: ^[A-Z]{4}$
- statusstring
  Description
  Consent status
- statusReasonobject
  Description
  Status reason object
  - codestring
    Description
    example: CONSENT_AWAITING_AUTHORIZATION Enum: [NOT_INFORMED,INFRASTRUCTURE_FAILURE,AUTHORIZATION_EXPIRED_TIME, USER_REJECTED, ORIGIN_DESTINATION_ACCOUNTS_EQUAL, ACCOUNT_DOES_NOT_ALLOW_PAYMENT, DIVERGENT_AUTHENTICATION, NOT_INFORMED, REVOKED_USER, REVOKED_MERCHANT ]
  - messagestring
    Description
    pattern: [wWs]* Length: 2048 example: User refused consent Status message
- createAtstring
  Description
  maxLength: 20 pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ example: 2020-07-21T08:30:00Z
- statusUpdateAtstring
  Description
  maxLength: 20 pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$ example: 2020-07-21T08:30:00Z
- firstPaymentboolean
  Description
  Is it a First Payment
- originalPaymentIdstring
  Description
  minLength: 1 maxLength: 100 pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$ example: TXpRMU9UQTROMWhZV2xSU1FUazJSMDl
- paymentReferencestring
pagingobject
- nextCursorstring
- prevCursorstring
- hasNextstring
- hasPrevstring

curl

curl --location --globoff 'https://api-sandbox.klavi.ai/payment/management/v1/merchants/automatic/{appId}/consents/{consentId}/orders' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'

nodejs

var request = require('request');
var options = {
   'method': 'GET',
   'url': 'https://api-sandbox.klavi.ai/payment/management/v1/merchants/automatic/{appId}/consents/{consentId}/orders',
   'headers': {
      'Accept': 'application/json',
      'Content-Type': 'application/json'
   }
};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

javascript

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api-sandbox.klavi.ai/payment/management/v1/merchants/automatic/{appId}/consents/{consentId}/orders", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

python

import requests
import json

url = "https://api-sandbox.klavi.ai/payment/management/v1/merchants/automatic/{appId}/consents/{consentId}/orders"

payload = {}
headers = {
   'Accept': 'application/json',
   'Content-Type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api-sandbox.klavi.ai/payment/management/v1/merchants/automatic/{appId}/consents/{consentId}/orders")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"

response = https.request(request)
puts response.read_body

200

{
    "data": [
        {
            "id": "bd4de72f-550b-421b-ba5c-28190e754d58",
            "appId": "ax2regress",
            "clientRequestId": "retry15",
            "institutionId": "c8f0bf49-4744-4933-8960-7add6e590841",
            "customer": {
                "identifierType": "CPF",
                "identifier": "***.092.776-**",
                "name": "Kbms 10086",
                "phone": "12*******00",
                "email": "q***@klavi.ai"
            },
            "date": "2025-09-08",
            "consentId": "17d9d5be-073f-4706-86d4-8fdd36b90aed",
            "endToEndId": "E4445979920250908132600000000005",
            "ibgeTownCode": "",
            "amount": "90.1200",
            "currency": "BRL",
            "remittanceInformation": "batata",
            "debtorAccount": {
                "ispb": "",
                "issuer": "",
                "number": "",
                "accountType": ""
            },
            "creditorAccount": {
                "ispb": "00000000",
                "issuer": "****",
                "number": "******",
                "accountType": "CACC",
                "holder": {
                    "identifier": "**.***.708/0001-**",
                    "identifierType": "CNPJ",
                    "name": "John Doe"
                }
            },
            "externalInfo": {
                "batata": "batata"
            },
            "cancellation": {
                "cancelledFrom": "",
                "cancelledAt": "",
                "cancelledBy": {
                    "identifier": "",
                    "identifierType": ""
                }
            },
            "status": "PAYMENT_REJECTED",
            "statusReason": {
                "code": "UNKNOWN",
                "message": "unknown server error"
            },
            "createAt": "2025-09-07T22:26:14Z",
            "statusUpdateAt": "2025-09-07T22:26:48Z",
            "firstPayment": false,
            "originalPaymentId": "6aef77ea-f4e1-44c2-92af-f5cda0413154",
            "paymentReference": "03-09-2025/P1M"
        }
    ],
    "paging": {
        "nextCursor": "XX3tSz4UQ9c70Kuy63wUtKL8JJdY-MPgS6e4dgr6PQ3eXHXGalTDvpRDqPb7HlnVceMtez3ctA3Td-ncikHTXw",
        "prevCursor": "",
        "hasNext": true,
        "hasPrev": false
    }
}