Skip to main content
GET
List all instant payments

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

account_id
string

Returns instant payments associated with this account_id.

Pattern: ^account_\w+$
account_number_id
string

Returns instant payments associated with this account_number_id.

Pattern: ^account_number_\w+$
direction
enum<string>

Returns instant payments with the given direction. Who is initiating the transaction.

outgoing: You are sending a transaction to a counterparty. incoming: You are receiving a transaction from a counterparty.

Available options:
outgoing,
incoming
Example:

"outgoing"

status
enum<string>

Returns instant payments with the given status. The current status of the instant payment object. If outgoing: created, under_review, canceled, rejected, posted. If incoming: under_review, rejected, posted.

Available options:
created,
under_review,
canceled,
rejected,
posted
Example:

"posted"

counterparty_status
enum<string> | null

Returns instant payments with the given counterparty status. The current status of the instant payment from the counterparty's perspective. If outgoing: posted, under_review, or rejected. If incoming: posted or null.

Available options:
posted,
under_review,
rejected
Example:

"posted"

return_request_status
enum<string>

Returns instant payments that have a return request with the given status. The current status of the return request object. For incoming return requests: response_needed, accepted, rejected. For outgoing return requests: pending, accepted, rejected.

Available options:
pending,
response_needed,
accepted,
rejected
Example:

"pending"

created_at
object

A set of filters on the list using the object's field created_at.

limit
integer
default:10

Maximum number of objects to be returned.

Required range: 1 <= x <= 100
starting_after
string

A cursor for use in pagination; this is an ID that defines your place in the list.

Pattern: ^instant_payment_\w+$
ending_before
string

A cursor for use in pagination; this is an ID that defines your place in the list.

Pattern: ^instant_payment_\w+$

Response

A list of instant payment objects.

objects
object[]
required
has_more
boolean
required

Indicates whether more results are available.