These docs are for v2024.02.01. Click to read the latest docs for v2025.03.01.

List customer available payment methods

List all available payment methods for the customer
Response Code | Fault Code | Fault | Suggested User Message
------------- | ---------- | ----- | ----------------------
404 | 90068 | UnknownCustomerFault | Customer does not exist
404 | 90043 | NoPaymentMethodsFoundFault | Payment Method not found
500 | 90061 | SystemFailureFault | System Failure, please try again later
400 | 90048 | PaymentMethodNotAssociatedFault | Payment method not found

Path Params
uuid
required

The ID of the customer the methods are listed for

Query Params
string

Optional filtering of payment methods by status.
If not supplied, all ACTIVE and EXPIRED methods are returned.
ALL: all methods regardless of status
ACTIVE: all methods flagged as active and without an expuiry date or with an expiry date in the future
EXPIRED: all methods flagged as active and with an expiry date in the past
INACTIVE: all methods flagged as inactive

boolean

Optional. If true, will only return payment methods that can be used to add a manual payment. Not supplied or false will return all payment methods.

Headers
string

The tenant ID for which the operation is being carried out. This will be automatically generated during the authentication process.

string

The ID of a user who is performing the operation. This will be automatically generated during the authentication process.

string

The source of whether records are updated by HMAC or a USER. This will be automatically generated during the authentication process. For customers accessing the service the source will be set to CUSTOMER.

Responses

Language
URL
Choose an example:
application/json