List Payment Methods

get

https://api.routable.com/v1/companies/{company_id}/payment-methods

Returns a list of PaymentMethods that were previously created.

Path Params

company_id

uuid

required

The Company ID.

Query Params

archival_status

string

enum

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).

Allowed:

is_valid

string

enum

Defaults to 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`.

Allowed:

page

integer

≥ 1

Defaults to 1

Retrieve a specific page of a List.

page_size

integer

1 to 100

Defaults to 10

Set the number of results per page of a List.

verification_status

string

enum

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.

Allowed:

Response

200OK