v1
latestOpenAPI 3.1.12026-07-2452287575.4 KBPayment Methods
List Payment Methods
Returns a list of PaymentMethods that were previously created.
get/v1/companies/{company_id}/payment-methods
Path parameters
company_idstring uuid required
Example:8c581d79-bb84-4bc1-b1c5-8c073264a569
The Company ID.
Query parameters
archival_status'not_archived' | 'system' | 'team_member'
Filter by archival status. When omitted, no archival status filter is applied. NOTE: Filters for system and team_member-archived PaymentMethods can only return invalid PaymentMethods. Therefore, unless you also pass is_valid=false, its default, is_valid=true, will ensure you receive no returned PaymentMethods.
| Value | Description |
|---|---|
| not_archived | Only active (non-archived) accounts. |
| system | Only system-archived accounts (cannot be unarchived). |
| team_member | Only accounts archived by a TeamMember (can be unarchived). |
is_valid'all' | 'false' | 'true'
Filter by whether the PaymentMethod can be used for payments. Pass all to return all PaymentMethods regardless of validity.
| Value | Description |
|---|---|
| all | Fetch all PaymentMethods regardless of validity. |
| false | Fetch only invalid PaymentMethods. |
| true | Fetch only valid PaymentMethods. |
pageinteger
Retrieve a specific page of a List.
page_sizeinteger
Set the number of results per page of a List.
verification_status'failed' | 'not_verified' | 'pending' | 'verified'
Filter by verification status.
| Value | Description |
|---|---|
| failed | Verification failed. |
| not_verified | Accounts not yet verified or not requiring verification. |
| pending | Verification in progress (micro-deposits pending). |
| verified | Successfully verified accounts. |
Response
OK
Example response
{
"results": [
{
"type_details": {
"attention_line": "Attn: John Smith"
}
}
]
}