Skip to main content
GET
List all payment intents

Authorizations

Authorization
string
header
required

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

Query Parameters

status
enum<string>

Filters by the most recent timeline.status within the payment intent. Continuous intents shown as active in the timeline are stored as pending, so filter them with pending.

Available options:
created,
pending,
complete,
expired,
failed,
refunded
context
enum<string>

Filters by the most recent timeline.context within the payment intent.

Available options:
underpaid,
paid,
overpaid
walletId
string

The accountId of the custody account to list payment intents for. Without this filter, a Digital Asset Accounts distributor key returns only payment intents on the distributor's own entity. To list an end user's payment intents, pass the accountId of the end user's custody account. The account must belong to the caller; otherwise the request is rejected.

Example:

"1000662322"

from
string

Queries items created since the specified date-time (inclusive) in ISO 8601 format. ISO-8601 UTC date/time format.

Example:

"2020-04-10T02:13:30.000Z"

to
string

Queries items created before the specified date-time (inclusive) in ISO 8601 format. ISO-8601 UTC date/time format.

Example:

"2020-04-10T02:13:30.000Z"

pageBefore
string

A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize.

Example:

"def9520a-5280-4089-9b02-3c9ef8fc8514"

pageAfter
string

A collection ID value used for pagination. It marks the exclusive beginning of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize.

Example:

"bce1e961-bdb8-4983-a9c2-0b3fbc2614cf"

pageSize
integer

Limits the number of items to be returned.

Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used.

If omitted, the collection will determine the page size itself.

Required range: x >= 1
Example:

5

Response

Successfully retrieved a list of payment intents.

data
object[]

A transient payment intent.