List Payment Methods Paginated

GET

/api/:account_id/payments/payment_methods/paginated

GET

/api/:account_id/payments/payment_methods/paginated

$ curl https://app.paymentkit.com/api/account_id/payments/payment_methods/paginated \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "items": [
3     {
4       "id": "pm_8f3a2b1c9d4e5f6a7b8c9d0e",
5       "account_id": "acct_1234567890abcdef",
6       "customer_id": "cust_9876543210fedcba",
7       "provider_type": "credit_card",
8       "name": "Visa ending in 4242",
9       "is_active": true,
10       "metadata": {
11         "last4": "4242",
12         "brand": "Visa",
13         "exp_month": 12,
14         "exp_year": 2026,
15         "bin": "411111",
16         "card_attributes": {
17           "card_type": "CREDIT",
18           "card_segment_type": "CONSUMER",
19           "prepaid_card": "NO",
20           "virtual_card": "NO",
21           "country_name": "United States",
22           "country_numeric": "840",
23           "regulated": "YES"
24         }
25       },
26       "created_at": "2024-01-15T09:30:00Z",
27       "updated_at": "2024-01-15T09:30:00Z",
28       "used_in_subscription": false,
29       "network_token_status": null
30     }
31   ],
32   "total": 1,
33   "has_more": false
34 }

List payment methods for an account with pagination, filtering, and sorting.

Backs the account-level payment-methods table and its CSV export. Account access is validated by the endpoint dependency, and rows are scoped to the account by PaginationHelper.build_query. Unlike customers/invoices, PaymentMethodEntity has no simulation_id (simulation lives on the customer), so this listing is not production-only.

List payment methods for an account with pagination, filtering, and sorting. Backs the account-level payment-methods table and its CSV export. Account access is validated by the endpoint dependency, and rows are scoped to the account by ``PaginationHelper.build_query``. Unlike customers/invoices, ``PaymentMethodEntity`` has no ``simulation_id`` (simulation lives on the customer), so this listing is not production-only.

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