Skip to main content
GET
Get Customer Payment Methods

Authorizations

Authorization
string
header
required

Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.

Headers

tenant
string
required

Your tenant identifier. Requests without it are rejected.

Path Parameters

customerId
string
required

The customer id

Pattern: ^customer(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$

Query Parameters

whenAt
string<date-time>

Optional: the whenAt datetime

simulatedAt
string<date-time>

Optional: the simulatedAt datetime

branchId
string

Optional: the branchId

Pattern: ^branch(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
includeDeleted
boolean

Include soft-deleted payment methods (super-user only)

Response

data
object[]
required

Array of payment methods

total
number

Optional: Total number of payment methods

offset
number

Optional: Number of payment methods the array has to star after

limit
number

Optional: Number of payment methods in the array