GET
/
intent
/
{id}

Authorizations

Authorization
string
headerrequired

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

Path Parameters

id
string
required

The intent ID

Response

200 - application/json
id
string
required
idempotency_key
string | null
required

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

created_at
string
required

Creation timestamp for the Intent

direction
enum<string>
required

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

Available options:
cash_in,
cash_out
user_id
string
required
amount
integer
required

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

currency
enum<string>
required

Currency associated with the amount

Available options:
USD
status
enum<string>
required
Available options:
created,
approved,
declined,
pending,
canceled
transactions
object[]
required
dispute
object
required

A dispute received from the payment network tied to an intent

display_limits
boolean
required

Whether the request-limits screen will be displayed in the session

limits_requested
boolean | null
required

Whether the user submitted a request to change their transaction limits during the payment session.

display_loyalty
boolean
required

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

approval_mode
enum<string>
required

How the intent should be approved and submitted for processing

Available options:
automatic,
manual
payment_credential
object | null
required

The details for the user's payment credential

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
account
object
required
guarantee_amount
integer | null

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

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.

List intentsApprove a pending intent