v1
latestOpenAPI 3.0.12026-07-245303882.5 MBPayment Initiation
List PIX payment initiations with filters
Retrieves a paginated list of PIX payment initiations with support for filtering by status, date range, and scheduling type. Supports query parameters for advanced filtering and pagination according to Open Finance Brasil specifications.
get/open-keys/itp/api/v2/payments/v4/payment-initiation
Query parameters
pagestring
Page number for pagination
pageSizestring
Number of items per page
initialDatestring
Example:2024-01-01
Initial date filter in ISO 8601 format (YYYY-MM-DD)
finalDatestring
Example:2024-12-31
Final date filter in ISO 8601 format (YYYY-MM-DD)
scheduled'INSTANT' | 'SCHEDULED'
Example:INSTANT
Filter by payment scheduling type: INSTANT for immediate payments, SCHEDULED for future-dated payments
querystring
Advanced query filters object supporting MongoDB-style queries for status, amounts, and other payment attributes
Response
Payment Processing successfully returned.
Example response
{
"data": [
{
"paymentInitiationApi": "PAYMENTS_V4",
"createdAt": "2024-01-01T20:32:44.581Z",
"updatedAt": "2024-01-01T20:32:44.581Z",
"deletedAt": "2024-01-01T20:32:44.581Z",
"journeySessionId": "f362a873-c127-4122-b711-a37b24a36914",
"redirectUrl": "https://example.com",
"enrollment": {
"platform": "ANDROID"
},
"data": {
"loggedUser": {
"document": {
"identification": "11122233344",
"rel": "CPF"
}
},
"businessEntity": {
"document": {
"identification": "00000000000191",
"rel": "CNPJ"
}
},
"creditor": {
"cpfCnpj": "12345678000199",
"personType": "PESSOA_JURIDICA",
"name": "João da Silva Santos"
},
"payment": {
"type": "PIX",
"schedule": {
"single": {
"date": "2023-08-23"
},
"daily": {
"startDate": "2023-08-23"
},
"weekly": {
"dayOfWeek": "QUINTA_FEIRA",
"startDate": "2023-08-23"
},
"monthly": {
"startDate": "2023-08-23"
},
"custom": {
"additionalInformation": "Todas quintas e domingos por 6 meses"
}
},
"date": "2024-03-05",
"currency": "BRL",
"amount": "1.12",
"ibgeTownCode": "5300108",
"details": {
"localInstrument": "DICT",
"qrCode": "\n\t\t\t\t\t\t 00020104141234567890123426660014BR.GOV.BCB.PIX014466756C616E6F32303139406578616D706C652E636F6D27300012\n\t\t\t\t\t\t BR.COM.OUTRO011001234567895204000053039865406123.455802BR5915NOMEDORECEBEDOR6008BRASILIA61087007490062\n\t\t\t\t\t\t 530515RP12345678-201950300017BR.GOV.BCB.BRCODE01051.0.080450014BR.GOV.BCB.PIX0123PADRAO.URL.PIX/0123AB\n\t\t\t\t\t\t CD81390012BR.COM.OUTRO01190123.ABCD.3456.WXYZ6304EB76",
"proxy": "11223344556",
"creditorAccount": {
"accountType": "CACC",
"ispb": "00000000",
"issuer": "0001",
"number": "0001234567"
}
}
},
"debtorAccount": {
"accountType": "CACC",
"ispb": "00000000",
"issuer": "0001",
"number": "0001234567"
},
"remittanceInformation": "Pagamento da nota XPTO035-002"
},
"journeySession": {
"createdAt": "2024-01-01T20:32:44.581Z",
"updatedAt": "2024-01-01T20:32:44.581Z",
"deletedAt": "2024-01-01T20:32:44.581Z",
"settings": [
{
"key": "JOURNEY_RULES"
}
]
},
"authorizationUrl": "https://example.com",
"ofConsent": {
"authorization_url": "https://example.com",
"status": "AWAITING_AUTHORISATION",
"organizationLogo": "https://example.com",
"redirect_uri": "https://example.com",
"consentTerm": 0.123,
"creditor": {
"cpfCnpj": "12345678000199",
"personType": "PESSOA_JURIDICA",
"name": "João da Silva Santos"
},
"loggedUser": {
"document": {
"identification": "11122233344",
"rel": "CPF"
}
},
"payment": {
"type": "PIX",
"date": "2025-08-05",
"currency": "BRL",
"amount": "10.00",
"details": {
"localInstrument": "DICT",
"proxy": "usuario@ficticio.com",
"creditorAccount": {
"ispb": "00000000",
"issuer": "0001",
"number": "0001234567",
"accountType": "CACC"
}
}
},
"rejectionReason": {
"code": "TEMPO_EXPIRADO_AUTORIZACAO"
}
},
"ofPayments": [
{
"localInstrument": "DICT",
"payment": {
"currency": "BRL",
"amount": "1.00"
},
"creditorAccount": {
"number": "1234567890",
"accountType": "CACC",
"ispb": "12345678",
"issuer": "1774"
},
"cnpjInitiator": "13935893000109",
"proxy": "cliente-a00001@pix.bcb.gov.br",
"endToEndId": "E13935893202511021042TKe1h8bM2FO",
"authorisationFlow": "FIDO_FLOW",
"creationDateTime": "2025-11-13T21:41:49Z",
"debtorAccount": {
"ispb": "12345678",
"issuer": "0001",
"number": "969139",
"accountType": "CACC"
},
"paymentId": "9917ab8f-e134-490b-b2b5-59ecd4e0abd0",
"status": "ACSC",
"statusUpdateDateTime": "2025-11-13T21:41:56Z"
}
],
"httpCalls": [
{
"response": {
"status": "200",
"statusText": "OK"
},
"createdAt": "2024-01-01T20:32:44.581Z",
"updatedAt": "2024-01-01T20:32:44.581Z",
"deletedAt": "2024-01-01T20:32:44.581Z"
}
]
}
],
"meta": {
"total": 0.123,
"page": 0.123,
"pageSize": 0.123,
"totalPages": 0.123
}
}