Skip to main content
GET
List intents

Authorizations

Authorization
string
header
required

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

Query Parameters

created_at.after
string<date-time>

Return intents created after this ISO 8601 timestamp.

created_at.before
string<date-time>

Return intents created before this ISO 8601 timestamp.

cursor
string

The cursor for the next page of results to fetch

Example:

"vjl8vk3l4o8dhsjlzh=="

type
enum<string>

Filter by payment flow type

Available options:
push,
card_only
status
enum<string>[]

Filter intents by status. Provide multiple values to retrieve intents with any of the provided statuses.

  • created: the intent is created.
  • pending: for cash_out with approval_mode set to manual, the operator must approve or cancel the intent. For a declined cash_in card payment recovered via ACH Save, the intent stays pending until the ACH re-authorization returns a result.
  • approved: terminal state. The payment has been submitted to the network.
  • declined: terminal state. The payment was declined.
  • canceled: terminal state. The intent was canceled by the operator.
Available options:
created,
approved,
declined,
pending,
canceled

Response

Successful operation

data
object[]
required
next_cursor
string | null
required

Use cursor for paginating list endpoints in conjunction with the cursor request parameter.

In a response, the value is null if there are no more results to fetch.

Example:

"vjl8vk3l4o8dhsjlzh=="