Payment methods

List payment methods

Changed on

Returns a paginated list of saved payment methods for a member or account, or for the authenticated user when you pass neither.

Required permissions:

  • member:payment_methods:read
get/payment_methods

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/payment_methods
  • Auth: HTTP bearer

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

  • 507636677fe9Revision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • info

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

    • info

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

    • info

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

  • a66448c54b9dRevision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • info

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