Get an intent

Get an intent by ID

GET /intent/{id}

Get an intent

cURL

curl --request GET \
  --url https://api.pushcash.com/intent/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "intent_sandbox_dMggQ93ZYH6DH9LBhVeijE",
  "idempotency_key": "f1bbb856",
  "created_at": "2023-05-24T20:36:50.694Z",
  "direction": "cash_in",
  "user_id": "user_28CJjV7P4Go5PNJvfzghiD",
  "amount": 1450,
  "currency": "USD",
  "guarantee_amount": 1450,
  "status": "approved",
  "decline_category": null,
  "transactions": [
    {
      "id": "txn_230vjroij4985uefjoiu9",
      "amount": 1450,
      "currency": "USD",
      "created_at": "2023-05-24T20:15:18.158Z",
      "date": "2023-05-24",
      "batch": "398002",
      "balance": "settlement",
      "type": "intent",
      "source_id": "intent_sandbox_dMggQ93ZYH6DH9LBhVeijE",
      "status": "settled"
    }
  ],
  "dispute": null,
  "refund": null,
  "credential": {
    "display_name": "Chase Checking",
    "last4": "6018"
  },
  "payment_credential": {
    "bank_name": "Space Coast Credit Union",
    "account": {
      "number_mask": "5978",
      "routing": "263177903"
    },
    "card": {
      "primary_account_number_mask": "6018",
      "expiration": "2024-05-01",
      "brand": "visa"
    }
  },
  "rail": "card",
  "account": {
    "id": "account_WsELzpJOvU6fNafvzWbF6K",
    "type": "settlement",
    "name": "Settlement Account",
    "created_at": "2023-05-24T20:15:18.158Z"
  },
  "type": "push"
}

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<date-time> · required

Creation timestamp for the Intent

direction · enum<string> · required

Direction of the payment.

• Submit cash_in for deposits
• Submit cash_out for withdrawals

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

dispute · object · required

A dispute received from the payment network tied to an intent

Show child attributes

Example:

{
  "id": "dispute_0293cj9ru032lisdjow",
  "amount": 10000,
  "currency": "USD",
  "created_at": "2023-05-24T20:36:50.694Z",
  "intent_id": "intent_sandbox_dMggQ93ZYH6DH9LBhVeijE",
  "code": "R01",
  "status": "created",
  "type": "push"
}

refund · object · required

A refund issued against an approved intent

Show child attributes

Example:

{
  "id": "refund_28CJjV7P4Go5PNJvfzghiD",
  "intent_id": "intent_sandbox_dMggQ93ZYH6DH9LBhVeijE",
  "amount": 1450,
  "currency": "USD",
  "status": "approved",
  "created_at": "2023-05-24T20:36:50.694Z"
}

approval_mode · enum<string> · required

Enable manual review of payouts or redemptions through this parameter. See Manual Review for details.

Available options: automatic, manual

credential · object · required

The credentials used for the payment intent

Show child attributes

Example:

{
  "display_name": "Chase Checking",
  "last4": "6018"
}

payment_credential · object · required

The details for the user's payment credential

Show child attributes

Example:

{
  "bank_name": "Space Coast Credit Union",
  "account": {
    "number_mask": "5978",
    "routing": "263177903"
  },
  "card": {
    "primary_account_number_mask": "6018",
    "expiration": "2024-05-01",
    "brand": "visa"
  },
  "created_at": "2023-04-10T05:10:14.532Z"
}

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

Example:

{
  "id": "account_WsELzpJOvU6fNafvzWbF6K",
  "type": "settlement",
  "name": "Settlement Account",
  "balance": 1000000,
  "created_at": "2023-05-24T20:15:18.158Z"
}

type · enum<string> · required

The payment flow type for the intent.

Available options: push, card_only, apple_pay

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: insufficient_funds, unapproved_amount, fraud_risk, connection_error, transaction_limit, unsupported_card, suspended_user