Get an intent

Get an intent by ID

Authorizations

Authorization

string

header

required

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

Successful operation

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

Show child attributes

transactions.id

string

required

The unique identifier assigned by Push

transactions.amount

integer

required

Amount of the transaction (signed)

transactions.currency

enum<string>

required

Currency associated with the amount

Available options:

USD

transactions.created_at

string

required

When the transaction was created (ISO 8061 date string)

transactions.date

string

required

The settlement date of the transaction

transactions.batch

string | null

required

The batch for the transaction

transactions.account_id

string

required

The account associated with the transaction

transactions.type

enum<string>

required

The type of transaction

Available options:

intent,

transfer,

unreconciled

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

transactions.status

enum<string>

required

The transaction's settlement status

Available options:

settled,

pending

transactions.direction

enum<string>

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

Available options:

credit,

debit

dispute

object

required

A dispute received from the payment network tied to an intent

Show child attributes

dispute.id

string

required

The unique identifier assigned by Push

dispute.amount

integer

required

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

dispute.currency

enum<string>

required

Currency associated with the amount

Available options:

USD

dispute.created_at

string

required

When the dispute was created (ISO 8061 date string)

dispute.intent_id

string

required

The intent which corresponds to the dispute

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

dispute.status

enum<string>

required

The status of the dispute

Available options:

created,

won,

lost

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

Show child attributes

payment_credential.bank_name

string

required

The name of the bank associated with the credential

payment_credential.account

object

required

Show child attributes

payment_credential.account.number_mask

string

required

The account number (mask)

payment_credential.account.routing

string

required

The routing number for the account

payment_credential.card

object

required

Show child attributes

payment_credential.card.primary_account_number_mask

string

required

The primary account number (mask)

payment_credential.card.expiration

string

required

The expiration date for the card

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

Show child attributes

account.id

string

required

The unique identifier assigned by Push

account.type

enum<string>

required

The type of account

Available options:

settlement

account.name

string

required

The name of the account

account.created_at

string

required

When the account was created (ISO 8061 date string)

account.balance

integer

The balance of the account.

guarantee_amount

integer | null

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

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

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.