Skip to main content
GET
/
intent
/
list
List intents
curl --request GET \
  --url https://api.pushcash.com/intent/list \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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,
      "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"
        }
      },
      "rail": "card",
      "account": {
        "id": "account_WsELzpJOvU6fNafvzWbF6K",
        "type": "settlement",
        "name": "Settlement Account",
        "created_at": "2023-05-24T20:15:18.158Z"
      },
      "type": "push"
    }
  ],
  "next_cursor": "vjl8vk3l4o8dhsjlzh=="
}

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.

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=="