v1

latestOpenAPI 3.1.02026-07-228956435.8 KB
Payment methods

List payment methods

Lists the payment methods of your organization for the mode (live or test) of the API key used, sorted by most recently created first. Use customer to narrow the list to a single customer, and the cursor parameters (starting_after, ending_before) together with limit to paginate. The Link response header contains the URL of the next page. Each payment method exposes its details under a key named after its type (bank_transfer, card, or pac).

get/payment_methods

Query parameters

amountinteger

Amount, in the smallest currency unit, the payment methods must be able to process. If present, the response only includes payment methods that can process this amount.

customerstring

Unique identifier of the customer that owns the payment methods. If present, the response only includes payment methods that belong to this customer.

ending_beforestring

Pagination cursor. The id of a payment method; the response contains the page of more recent payment methods, the ones listed before the cursor. Cannot be combined with starting_after.

limitinteger

Maximum number of payment methods to return per page, up to 300. Defaults to 30.

starting_afterstring

Pagination cursor. The id of a payment method; the response contains the page of older payment methods, the ones listed after the cursor. Cannot be combined with ending_before.

Response

List of payment methods for the current mode, sorted by most recently created first. The type-specific details key is null when the resource backing a payment method is no longer available.

Example response

[
  {
    "id": "pm_1zXcVbNmAsDfGhJk",
    "bank_transfer": {
      "account_holder_id": "111111111",
      "account_number": "001111111111",
      "account_type": "checking_account",
      "institution_id": "cl_banco_de_chile",
      "institution_name": "Banco de Chile",
      "mfa_type": "sms",
      "status": "active"
    },
    "created_at": "2026-01-15T14:30:00.000Z",
    "customer": "cus_oVgVqlnK0PdmGirH",
    "mode": "live"
  }
]