List intents

Retrieves a list of 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

Return intents created after this ISO 8601 timestamp.

created_at.before

string

Return intents created before this ISO 8601 timestamp.

cursor

string

The cursor for the next page of results to fetch

status

enum<string>[]

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

Available options:

created,

approved,

declined,

pending,

canceled

Response

200

application/json

Successful operation

data

object[]

required

Show child attributes

data.id

string

required

data.idempotency_key

string | null

required

The value passed in the X-Idempotency-Key header of the create intent request

data.created_at

string

required

Creation timestamp for the Intent

data.direction

enum<string>

required

Direction of the money flow, from the perspective of the Push Account

Available options:

cash_in,

cash_out

data.user_id

string

required

data.amount

integer

required

Amount for the transaction, in smallest unit of specified currency (ie if currency is USD, the unit would be cents)

data.currency

enum<string>

required

Currency associated with the amount

Available options:

USD

data.status

enum<string>

required

Available options:

created,

approved,

declined,

pending,

canceled

data.transactions

object[]

required

Show child attributes

data.transactions.id

string

required

The unique identifier assigned by Push

data.transactions.amount

integer

required

Amount of the transaction (signed)

data.transactions.currency

enum<string>

required

Currency associated with the amount

Available options:

USD

data.transactions.created_at

string

required

When the transaction was created (ISO 8061 date string)

data.transactions.date

string

required

The settlement date of the transaction

data.transactions.batch

string | null

required

The batch for the transaction

data.transactions.account_id

string

required

The account associated with the transaction

data.transactions.type

enum<string>

required

The type of transaction

Available options:

intent,

transfer,

unreconciled

data.transactions.source_id

string | null

required

The ID of the intent, dispute, or transfer associated with the transaction. If the transaction is unreconciled, this field will be null

data.transactions.status

enum<string>

required

The transaction's settlement status

Available options:

settled,

pending

data.transactions.direction

enum<string>

The direction of the transaction, as indicated by the sign of the amount

Available options:

credit,

debit

data.dispute

object

required

A dispute received from the payment network tied to an intent

Show child attributes

data.dispute.id

string

required

The unique identifier assigned by Push

data.dispute.amount

integer

required

Amount for the transaction, in smallest unit of specified currency (ie if currency is USD, the unit would be cents)

data.dispute.currency

enum<string>

required

Currency associated with the amount

Available options:

USD

data.dispute.created_at

string

required

When the dispute was created (ISO 8061 date string)

data.dispute.intent_id

string

required

The intent which corresponds to the dispute

data.dispute.code

enum<string>

required

The associated network code for the exception

Available options:

10.1,

10.2,

10.3,

10.4,

10.5,

11.1,

11.2,

11.3,

12.1,

12.2,

12.3,

12.4,

12.5,

12.6,

12.7,

13.1,

13.2,

13.3,

13.4,

13.5,

13.6,

13.7,

13.8,

13.9,

4837,

4840,

4849,

4863,

4870,

4871,

4807,

4808,

4812,

4834,

4831,

4842,

4846,

4850,

4999,

4853,

4841,

4854,

4855,

4859,

4860,

R01,

R02,

R03,

R04,

R05,

R06,

R07,

R08,

R09,

R10,

R11,

R12,

R13,

R14,

R15,

R16,

R17,

R18,

R19,

R20,

R21,

R22,

R23,

R24,

R25,

R26,

R27,

R28,

R29,

R30,

R31,

R32,

R33,

R34,

R35,

R36,

R37,

R38,

R39,

R40,

R41,

R42,

R43,

R44,

R45,

R46,

R47,

R50,

R51,

R52,

R53,

R61,

R62,

R67,

R68,

R69,

R70,

R71,

R72,

R73,

R74,

R75,

R76,

R77,

R80,

R81,

R82,

R83,

R84,

R85

data.dispute.status

enum<string>

required

The status of the dispute

Available options:

created,

won,

lost

data.display_loyalty

boolean

required

Whether the loyalty opt-in screen will be displayed in the session

data.approval_mode

enum<string>

required

How the intent should be approved and submitted for processing

Available options:

automatic,

manual

data.payment_credential

object | null

required

The details for the user's payment credential

Show child attributes

data.payment_credential.bank_name

string

required

The name of the bank associated with the credential

data.payment_credential.account

object

required

Show child attributes

data.payment_credential.account.number_mask

string

required

The account number (mask)

data.payment_credential.account.routing

string

required

The routing number for the account

data.payment_credential.card

object

required

Show child attributes

data.payment_credential.card.primary_account_number_mask

string

required

The primary account number (mask)

data.payment_credential.card.expiration

string

required

The expiration date for the card

data.rail

enum<string> | null

required

The payment rail used to complete the payment intent. Only defined once a payment intent has been processed.

Available options:

card,

ach

data.account

object

required

Show child attributes

data.account.id

string

required

The unique identifier assigned by Push

data.account.type

enum<string>

required

The type of account

Available options:

settlement

data.account.name

string

required

The name of the account

data.account.created_at

string

required

When the account was created (ISO 8061 date string)

data.account.balance

integer

The balance of the account.

data.guarantee_amount

integer | null

The amount guaranteed by Push for the transaction. Only defined when direction is cash_in.

data.decline_category

enum<string>

The high level reason why the intent was declined, included if the status is "declined"

Available options:

unapproved_amount,

fraud_risk,

connection_error,

transaction_limit

data.loyalty_opt_in

boolean | null

[IN PROGRESS] Whether the user opted into sharing their data with the operator. Only present if the user was shown the loyalty opt-in screen.

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.