GET/real_time_payments_requests_for_payment

List real-time payments requests for payment

Lists real-time payments requests for payment, with optional filters for account, creation time, and idempotency key. Use cursor and limit to paginate the results, and use the timestamp parameters to scope the results by creation time. The response includes a next_cursor when another page is available.

8 parameters
cursorstringoptional
Returns the page of requests after this cursor.
limitintegeroptional
Maximum number of requests to return. Must be at least 1 and defaults to 100 when omitted.
Default:100
account_idstringoptional
Filters results to requests destined for the specified account.
created_at.afterstringoptional
Filters to requests created after this ISO 8601 date-time.
created_at.beforestringoptional
Filters to requests created before this ISO 8601 date-time.
created_at.on_or_afterstringoptional
Filters to requests created at or after this ISO 8601 date-time.
created_at.on_or_beforestringoptional
Filters to requests created at or before this ISO 8601 date-time.
idempotency_keystringoptional
Filters results to the request with this idempotency key. Must be between 1 and 200 characters.

3 status codes
200Returns a list response containing real-time payments request for payment objects in `data` and a `next_cursor` value for retrieving the next page, or null when there are no more results.
dataarray<RealTimePaymentsRequestForPayment>required
The contents of the list.
next_cursorstringrequired
A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.
4XXReturned when the request cannot be processed because of a client error.
5XXReturned when the server encounters an error processing the request.

Error handling

limit must be at least 1 and cannot exceed 100; it defaults to 100 when omitted. Timestamp filters must use ISO 8601 date-time values, and idempotency_key must be between 1 and 200 characters.