API
Status PageSuporte
Start typing to search…

List PIX payment initiations with filters

get
https://api-sandbox-v2-hml.openkeys.celcoin.sandbox.fsapps.app/open-keys/itp/api/v2/payments/v4/payment-initiation

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.

Query Params
string
length between 0 and 999999

Page number for pagination

string
length between 0 and 999999

Number of items per page

string
length between 0 and 999999

Initial date filter in ISO 8601 format (YYYY-MM-DD)

string
length between 0 and 999999

Final date filter in ISO 8601 format (YYYY-MM-DD)

string
enum
length between 0 and 999999

Filter by payment scheduling type: INSTANT for immediate payments, SCHEDULED for future-dated payments

Allowed:
string
length between 0 and 999999

Advanced query filters object supporting MongoDB-style queries for status, amounts, and other payment attributes

Responses

Updated about 2 months ago

Language
Credentials
OAuth2
Missing 3 required scopes
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 2 months ago