Payment methods

List payment methods

Returns a paginated list of payment methods for a member or company, or for the authenticated user when neither is given, with optional filtering by creation date. A payment method is a stored representation of how a customer intends to pay, such as a card, bank account, or digital wallet.

Required permissions:

  • member:payment_methods:read
get/payment_methods

Query parameters

afterstring

Returns the elements in the list that come after the specified cursor.

beforestring

Returns the elements in the list that come before the specified cursor.

firstinteger

Returns the first n elements from the list.

Example:42
lastinteger

Returns the last n elements from the list.

Example:42
member_idstring

The unique identifier of the member to list payment methods for. Omit this and account_id to list your own saved payment methods.

Example:mber_xxxxxxxxxxxxx
direction'asc' | 'desc'

The direction of the sort.

created_beforestring date-time

Only return payment methods created before this timestamp.

Example:2023-12-01T05:00:00.401Z
created_afterstring date-time

Only return payment methods created after this timestamp.

Example:2023-12-01T05:00:00.401Z
future_usage'off_session' | 'on_session'

How a payment method will be charged after the buyer leaves — the same vocabulary as a confirmation token's setup_future_usage.

payment_method_typesPaymentMethodTypes[]

Only return payment methods of these types. Pass the eligible type values from the payment method types catalogue so the list holds nothing the purchase cannot take. An empty list returns no payment methods.

[
  "acss_debit"
]
card_brandsCardBrands[]

Only return cards on these networks, such as the networks the seller accepts. Payment methods that are not cards are unaffected.

card_funding_typesCardFundingTypes[]

Only return cards funded this way. A card whose funding could not be determined is excluded, and payment methods that are not cards are unaffected.

has_payer_documentboolean

Filter cards by whether they carry the payer identity document their payment provider requires. Payment methods that are not cards are unaffected.

expiredboolean

Filter by expiry. Only a card can expire, so false keeps every payment method that is not past its expiration month and true returns expired cards alone.

brokenboolean

Filter by whether the stored credential has permanently stopped charging, such as a vault entry its provider closed.

account_idstring

The unique identifier of the company. Provide either this or member_id, not both. Omit both to address your own saved payment methods.

Example:biz_xxxxxxxxxxxxxx

Response

A successful response

Example response

{
  "data": [
    {
      "created_at": "2023-12-01T05:00:00.401Z",
      "id": "payt_xxxxxxxxxxxxx",
      "payment_method_type": "acss_debit"
    }
  ]
}

Changes

Changed in 17 of the 74 revisions of this API.511157

  • 86b97292852d61See the full diff
    • ●

      added the new alipayhk enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new alipayhk enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new alipayhk enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new alipayhk enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new alipayhk enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new alipayhk enum value to the /// response property for the response status

      response-property-enum-value-added

    • ○

      added the enum value alipayhk to the property items/ of the query request parameter payment_method_types

      request-parameter-property-enum-value-added

  • 7fcefabddb0a61See the full diff
    • ●

      added the new tabby enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new tabby enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new tabby enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new tabby enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new tabby enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new tabby enum value to the /// response property for the response status

      response-property-enum-value-added

    • ○

      added the enum value tabby to the property items/ of the query request parameter payment_method_types

      request-parameter-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • c19acf2e2548167See the full diff
    • ▲

      removed the enum value bizum from the property items/ of the query request parameter payment_method_types

      request-parameter-property-enum-value-removed

    • ●

      added the new touch_n_go enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new touch_n_go enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new touch_n_go enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new touch_n_go enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new touch_n_go enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new touch_n_go enum value to the /// response property for the response status

      response-property-enum-value-added

    • ○

      added the enum value touch_n_go to the property items/ of the query request parameter payment_method_types

      request-parameter-property-enum-value-added

    • ○

      removed the bizum enum value from the /// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the bizum enum value from the /// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the bizum enum value from the /// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the bizum enum value from the /// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the bizum enum value from the /// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the bizum enum value from the /// response property for the response status

      response-property-enum-value-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 2fa9dfe9535a305See the full diff
    • ●

      added the new mercado_pago_ar enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new mercado_pago_ar enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new mercado_pago_ar enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new mercado_pago_ar enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new mercado_pago_ar enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new mercado_pago_ar enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new mercado_pago_mx enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new mercado_pago_mx enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new mercado_pago_mx enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new mercado_pago_mx enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new mercado_pago_mx enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new mercado_pago_mx enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new nupay enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new nupay enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new nupay enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new nupay enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new nupay enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new nupay enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new opay enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new opay enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new opay enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new opay enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new opay enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new opay enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new verve enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new verve enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new verve enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new verve enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new verve enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new verve enum value to the /// response property for the response status

      response-property-enum-value-added

    • ○

      added the enum value mercado_pago_ar to the property items/ of the query request parameter payment_method_types

      request-parameter-property-enum-value-added

    • ○

      added the enum value mercado_pago_mx to the property items/ of the query request parameter payment_method_types

      request-parameter-property-enum-value-added

    • ○

      added the enum value nupay to the property items/ of the query request parameter payment_method_types

      request-parameter-property-enum-value-added

    • ○

      added the enum value opay to the property items/ of the query request parameter payment_method_types

      request-parameter-property-enum-value-added

    • ○

      added the enum value verve to the property items/ of the query request parameter payment_method_types

      request-parameter-property-enum-value-added

  • 8473fa1d1f47183See the full diff
    • ●

      added the new oney enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new oney enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new oney enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new oney enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new oney enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new oney enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new oney_3x enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new oney_3x enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new oney_3x enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new oney_3x enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new oney_3x enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new oney_3x enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new oney_4x enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new oney_4x enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new oney_4x enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new oney_4x enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new oney_4x enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new oney_4x enum value to the /// response property for the response status

      response-property-enum-value-added

    • ○

      added the enum value oney to the property items/ of the query request parameter payment_method_types

      request-parameter-property-enum-value-added

    • ○

      added the enum value oney_3x to the property items/ of the query request parameter payment_method_types

      request-parameter-property-enum-value-added

    • ○

      added the enum value oney_4x to the property items/ of the query request parameter payment_method_types

      request-parameter-property-enum-value-added

    • ●

      deleted the query request parameter company_id

      request-parameter-removed

    • ○

      added the new optional query request parameter account_id

      new-optional-request-parameter

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 4da7133b2de7122See the full diff
    • ●

      added the new flex_pay enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new flex_pay enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new flex_pay enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new flex_pay enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new flex_pay enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new flex_pay enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new gcash enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new gcash enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new gcash enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new gcash enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new gcash enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new gcash enum value to the /// response property for the response status

      response-property-enum-value-added

    • ○

      added the enum value flex_pay to the property items/ of the query request parameter payment_method_types

      request-parameter-property-enum-value-added

    • ○

      added the enum value gcash to the property items/ of the query request parameter payment_method_types

      request-parameter-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 86d0a97abfe555See the full diff
    • ●

      added the new accel enum value to the //////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new culiance enum value to the //////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new nyce enum value to the //////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new pulse enum value to the //////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new star enum value to the //////// response property for the response status

      response-property-enum-value-added

    • ○

      added the enum value accel to the property items/ of the query request parameter card_brands

      request-parameter-property-enum-value-added

    • ○

      added the enum value culiance to the property items/ of the query request parameter card_brands

      request-parameter-property-enum-value-added

    • ○

      added the enum value nyce to the property items/ of the query request parameter card_brands

      request-parameter-property-enum-value-added

    • ○

      added the enum value pulse to the property items/ of the query request parameter card_brands

      request-parameter-property-enum-value-added

    • ○

      added the enum value star to the property items/ of the query request parameter card_brands

      request-parameter-property-enum-value-added

    This revision also has 42 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      removed subschema #7: PlatformBalancePaymentMethod from the / response property oneOf list for the response status

      response-property-one-of-removed

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 715c4defcbbf71See the full diff
    • ●

      added the new addi enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new addi enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new addi enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new addi enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new addi enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new addi enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new addi enum value to the /// response property for the response status

      response-property-enum-value-added

    • ○

      added the enum value addi to the property items/ of the query request parameter payment_method_types

      request-parameter-property-enum-value-added

Of the 74 revisions, 1 has no diff computed.