API Reference

Get Payment Methods

Retrieve paginated list of payment methods. Permission: Read Payment Methods

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
Defaults to page=5

The page number for paginated results. Defaults to 1. Used to traverse the paginated response

string

The field to sort results by. Prefix with '-' for descending order (e.g., '-createdAt'). Sortable fields are indicated in each field's description. Used to sort the response in ascending or descending order of an attribute

string

Filter expression in the format: filter[field][operator]=value. See individual field descriptions for available operators. Example: filter[status][eq]=Funded. Used to filter the response on an attribute value

string

The masked bank account number. Sortable: Yes. Filter Operators: eq, in, ne, neq, nn, null, nin

string

The name of the bank. Sortable: Yes. Filter Operators: sw, eq, in, ne, neq, nn, null, nin

string

The bank routing number. Sortable: Yes. Filter Operators: eq, in, ne, neq, nn, null, nin

string

The card brand. Common values: Visa, Mastercard, Amex, Discover. Sortable: Yes. Filter Operators: sw, eq, in, ne, neq, nn, null, nin

string

The card expiration date in MM/YY format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

string

The first six digits (BIN) of the card number. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

string

The last four digits of the card number. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

string

The tokenized card representation. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

string

The city from the billing address. Sortable: Yes. Filter Operators: sw, eq, in, ne, neq, nn, null, nin

string

The country from the billing address. Sortable: Yes. Filter Operators: sw, eq, ne, neq, nn, null

string

When the payment method was created. ISO 8601 datetime format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

string

The UUID of the customer who owns this payment method. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

string

The reason the payment method was disabled. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null

string

The email address associated with this payment method. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

boolean

Whether the payment method is disabled. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

string

The date the bank account was opened. ISO 8601 date format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

string

The postal or ZIP code from the billing address. Sortable: Yes. Filter Operators: eq, in, ne, neq, nn, null, nin

string

The state from the billing address. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

string

The street address from the billing address. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

string

The payment method type. Common values: ACH, Debit Card, Credit Card. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

string

When the payment method was last updated. ISO 8601 datetime format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

string

The payment method's unique identifier (UUID v4 format). Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

Headers
string
required
Defaults to application/vnd.totality.v1+json

Must be application/json.

string
required
Defaults to application/json

Must be application/json.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json