increase-test
GET/real_time_payments_transfers

List real-time payments transfers

Lists real-time payments transfers, with optional filters for account, external account, status, idempotency key, and creation time. Use cursor and limit to paginate the results, and use status.in to filter by one or more transfer statuses. The response includes a next_cursor when another page is available.

10 parameters
cursorstringoptional
Returns the page of transfers after this cursor.
limitintegeroptional
Maximum number of transfers to return. Must be at least 1 and defaults to 100 when omitted.
Default:100
account_idstringoptional
Filters results to transfers belonging to the specified account.
external_account_idstringoptional
Filters results to transfers made to the specified external account.
idempotency_keystringoptional
Filters results to the transfer with this idempotency key. Must be between 1 and 200 characters.
status.inarray<string>optional
Filters results to transfers whose status matches one or more comma-delimited values: pending_approval, canceled, pending_submission, pending_reviewing, requires_attention, rejected, submitted, or complete.
created_at.afterstringoptional
Filters to transfers created after this ISO 8601 date-time.
created_at.beforestringoptional
Filters to transfers created before this ISO 8601 date-time.
created_at.on_or_afterstringoptional
Filters to transfers created at or after this ISO 8601 date-time.
created_at.on_or_beforestringoptional
Filters to transfers created at or before this ISO 8601 date-time.

3 status codes
200Returns a list response containing real-time payments transfer objects in `data` and a `next_cursor` value for retrieving the next page, or null when there are no more results.
dataarray<RealTimePaymentsTransfer>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. Values for status.in must be pending_approval, canceled, pending_submission, pending_reviewing, requires_attention, rejected, submitted, or complete; timestamp filters must use ISO 8601 date-time values. idempotency_key must be between 1 and 200 characters.