f67a043e3190
List payment methods
Returns a paginated list of payment methods for a member or company, or for the authenticated user when neither is given, with optional filtering by creation date. A payment method is a stored representation of how a customer intends to pay, such as a card, bank account, or digital wallet.
Required permissions:
- member:payment_methods:read
Query parameters
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
The unique identifier of the member to list payment methods for. Omit this and company_id to list your own saved payment methods.
The unique identifier of the company. Provide either this or member_id, not both. Omit both to address your own saved payment methods.
The direction of the sort.
Only return payment methods created before this timestamp.
Only return payment methods created after this timestamp.
How a payment method will be charged after the buyer leaves — the same vocabulary as a confirmation token's setup_future_usage.
Only return payment methods of these types. Pass the eligible type values from the payment method types catalogue so the list holds nothing the purchase cannot take. An empty list returns no payment methods.
Only return cards on these networks, such as the networks the seller accepts. Payment methods that are not cards are unaffected.
Only return cards funded this way. A card whose funding could not be determined is excluded, and payment methods that are not cards are unaffected.
Filter cards by whether they carry the payer identity document their payment provider requires. Payment methods that are not cards are unaffected.
Filter by expiry. Only a card can expire, so false keeps every payment method that is not past its expiration month and true returns expired cards alone.
Filter by whether the stored credential has permanently stopped charging, such as a vault entry its provider closed.
Response
A successful response
Example response
{
"data": [
{
"created_at": "2023-12-01T05:00:00.401Z",
"id": "payt_xxxxxxxxxxxxx"
}
]
}