List Intents

GET

/api/:account_id/payments/intents/

GET

/api/:account_id/payments/intents/

$ curl https://app.paymentkit.com/api/account_id/payments/intents/ \
>      -H "Authorization: Bearer <token>"

1 {
2   "items": [
3     {
4       "id": "string",
5       "account_id": "string",
6       "customer_id": "string",
7       "amount_atom": 1,
8       "currency": "aed",
9       "status": "string",
10       "client_secret": "string",
11       "confirmed_at": "2024-01-15T09:30:00Z",
12       "metadata": {},
13       "created_at": "2024-01-15T09:30:00Z",
14       "updated_at": "2024-01-15T09:30:00Z",
15       "display_status": "",
16       "tooltip_key": "string",
17       "created_via": "string",
18       "cancellation_reason": "string",
19       "amount_atom_capturable": 0,
20       "amount_atom_received": 0,
21       "amount_atom_refunded": 0,
22       "refunded_at": "2024-01-15T09:30:00Z",
23       "attempt_count": 1,
24       "invoices": [
25         {
26           "invoice_id": "string",
27           "amount_atom": 1
28         }
29       ],
30       "customer_email": "string",
31       "payment_method": {
32         "id": "string",
33         "account_id": "string",
34         "customer_id": "string",
35         "provider_type": "credit_card",
36         "name": "string",
37         "is_active": true,
38         "metadata": {},
39         "created_at": "2024-01-15T09:30:00Z",
40         "updated_at": "2024-01-15T09:30:00Z",
41         "used_in_subscription": false,
42         "network_token_status": "string"
43       },
44       "processor": {
45         "id": "string",
46         "name": "string",
47         "description": "string",
48         "psp_payment_id": "string"
49       },
50       "decline_reason": "string",
51       "failure_code": "string",
52       "bin": "string",
53       "is_merchant_initiated": true
54     }
55   ],
56   "total": 1,
57   "has_more": true
58 }

List payment intents for an account with pagination.

Works for both User and API Key authentication. Account access is automatically validated via endpoint dependency.

Returns payment intents with related data:

Invoice allocations
Customer email
Payment method info (from latest attempt)
Processor info (from latest attempt)

List payment intents for an account with pagination. Works for both User and API Key authentication. Account access is automatically validated via endpoint dependency. Returns payment intents with related data: - Invoice allocations - Customer email - Payment method info (from latest attempt) - Processor info (from latest attempt)

Authentication

AuthorizationBearer

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

Path parameters

account_idstringRequired

Query parameters

limitintegerOptional1-100Defaults to 50

Number of items per page

offsetintegerOptional>=0Defaults to 0

Number of items to skip

filterstringOptionalDefaults to {}

Filter conditions as key-value pairs or advanced filter objects (JSON string)

sortBystring or nullOptional

Field to sort by

sortOrderintegerOptionalDefaults to -1

Sort order: 1 for ascending, -1 for descending

searchstring or nullOptional

Keyword-based search across multiple fields

Response

Successful Response

itemslist of objects

totalinteger

has_moreboolean

Errors

422

Unprocessable Entity Error