Payment Methods

List Payment Methods

Changed on Nov 3, 2026

Returns a list of PaymentMethods that were previously created.

get/v1/companies/{company_id}/payment-methods

Request

Base URL
https://api.routable.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/routable/apis/routable-api/docs/v1/companies/:company_id/payment-methods/get.ts
A function with typed inputs. Its response is checked against the schema.

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

object'List' required

The object’s type (List).

Example response

{
  "results": [
    {
      "type_details": {
        "attention_line": "Attn: John Smith"
      }
    }
  ]
}

Changes

Nov 3, 20269d71f3ec4b5c Revision changes
- breaking
  added to the // response property oneOf list for the response status
- warning
  added the new GHS enum value to the ////////// response property for the response status
- warning
  added the new GHS enum value to the ////////// response property for the response status
- warning
  added the new MOP enum value to the ////////// response property for the response status
- warning
  added the new MOP enum value to the ////////// response property for the response status
- warning
  added the new card enum value to the //////// response property for the response status
- warning
  added the new card enum value to the //////// response property for the response status
- warning
  added the new card enum value to the //////// response property for the response status
- warning
  added the new card enum value to the //////// response property for the response status
- info
  added the optional property ///////// to the response with the status
- info
  added the optional property ///////// to the response with the status
- info
  added the optional property ///////// to the response with the status
- info
  added the optional property ///////// to the response with the status
- info
  added card discriminator mapping keys to the // response property for the response status
- info
  the ////// response's property pattern ^\d{18}$ was removed for the status

Operation history