v1
latestOpenAPI 3.1.02026-08-04103211436.0 KBList payment orders
Returns the payment orders of a company, ordered by execution date (most recent first). Results are paginated: use limit to control page size and pass the returned nextPageToken to fetch the next page; nextPageToken is null once the last page has been reached. startPaymentDate/endPaymentDate filter by execution date. If only one of the two is given, the other defaults: endPaymentDate defaults to now, and startPaymentDate defaults to 6 months before endPaymentDate. If neither is given, no date filter is applied. Explicit date ranges are not capped: any span is accepted.
Path parameters
Query parameters
Only return payment orders executed on or after this date. If given without endPaymentDate, endPaymentDate defaults to now.
Only return payment orders executed on or after this date. If given without endPaymentDate, endPaymentDate defaults to now.
Only return payment orders executed up to this date. If given without startPaymentDate, startPaymentDate defaults to 6 months before endPaymentDate.
Only return payment orders executed up to this date. If given without startPaymentDate, startPaymentDate defaults to 6 months before endPaymentDate.
Filter by payment order execution status.
Filter payment orders whose beneficiary legal name contains this text.
Filter payment orders whose beneficiary legal name contains this text.
Filter payment orders whose documentId contains this text.
Filter payment orders whose documentId contains this text.
Maximum number of payment orders to return per page. Defaults to 200, which is also the maximum allowed value.
Maximum number of payment orders to return per page. Defaults to 200, which is also the maximum allowed value.
Token to fetch the next page of results, returned by a previous call to this endpoint. An invalid token returns a 404 error.
Token to fetch the next page of results, returned by a previous call to this endpoint. An invalid token returns a 404 error.
Response
Successful Response
Example response
{
"data": [
{
"id": "po_8f2a1c9e",
"concept": "Supplier invoice payment",
"documentId": "INV-2024-0456",
"relatedCustomId": "invoice-2024-001",
"amount": 1500,
"beneficiary": {
"legalName": "Acme Supplies S.L."
},
"product": {
"alias": "Main disbursement account"
},
"bank": {
"fullName": "Banco Santander"
}
}
]
}