Skip to navigation

Saved payment accounts

A saved payment account is a customer-owned fiat account for one catalog payment method. The catalog decides which fields an account needs, so build your form from the catalog rather than hard-coding fields.

Read the catalog

GET /v1/payment-methods/catalog returns the payment methods, each with a paymentMethodId. Its requiredFields schema defines the account fields and the field that identifies an account. GET /v1/payment-methods/catalog/{paymentMethodId}/currencies shows which currencies each method supports.

Create and list accounts

Create an account with POST /v1/me/payment-methods and list the customer’s accounts with GET /v1/me/payment-methods. A saved account’s ID is different from the catalog’s payment method ID, so keep the two distinct. Offer search needs an active saved account that matches the catalog payment method.

Update or remove an account

PATCH /v1/me/payment-methods/{id} can change the label and whether the account is active. The catalog method and the identifying value cannot change. To remove an account, use DELETE /v1/me/payment-methods/{id}.