Skip to main content

Retrieve Payment Methods

GET 
/shops/:shopId/payment-methods

Retrieves the list of payment methods available for a given shop, identified by its {shopId}. This endpoint provides an unfiltered list of all payment methods applicable to the shop. Optionally, the results can be narrowed down by specifying supported currencies and payment instrument types. The information obtained from this endpoint is essential for the paymentSettings object in the order creation endpoint.

Request​

Path Parameters

    shopId integerrequired

    The unique identifier of the shop for which to retrieve payment methods. How to get your shopId

Query Parameters

    currencies string[]

    Possible values: >= 3 characters and <= 3 characters

    Currently not implemented. A list of currency codes to filter available payment methods by currencies they support. Specifies the currency in ISO 4217 alphabetic code format, consisting of 3 uppercase letters.

    instrumentTypes string[]

    Possible values: [card, bank_transfer, wallet]

    Currently not implemented. A list of payment instrument types to filter the payment methods.

Responses​

Returns a list of payment methods available for the specified shop, optionally filtered by the supported currencies and instrument types.

Schema
    data object[]required
  • Array [
    • providerCode stringrequired

    Determines which payment provider should be used to process the payment.

    acquirerCode stringrequired

    Identifies the specific acquirer responsible for processing payments.

    instrumentType stringrequired

    Possible values: [card, wallet, bank_transfer]

    Specifies the instrument type. See available instrument types

    entryMode stringnullable

    Applicable only for instrumentType == card. Specifies the method by which payment data is entered. Payment Entry Modes for instrument type card.

    dataEntryModes string[]required

    Possible values: [redirect, h2h, qr]

    Methods for customer data entry to process payment:

    redirect - the customer enters payment information on the provider's (acquirer's) page via redirect;

    h2h (host2host) - the customer enters payment information on our payment page;

    qr - the customer scans a QR code and enters information on the aggregator's side.

    allowedCards string[]required

    Applicable only for instrumentType == card. Specifies the credit or debit card brands that can be used with this payment method.

    transferType stringnullable

    Possible values: [bank_wire, sepa, swift, sbp, card2card, pix, online_banking, qris, promptpay, vietqr, vietnambanksqr, virtual_account, khipu, giropay, eps, open_finance]

    Applicable only for instrumentType == bank_transfer. Specifies the type of bank transfer. See details about transferType

    currencies string[]required

    Possible values: >= 3 characters and <= 3 characters

    A list of currency codes supported by this payment instrument. Specifies the currency in ISO 4217 alphabetic code format, consisting of 3 uppercase letters.

    regions string[]required

    Possible values: Value must match regular expression ^[A-Z]{2}$

    A list of regions where this payment method is available. Each region will be specified by its ISO 3166-1 alpha-2 code

    isDefault booleanrequired

    Specifies whether this payment method is set as the default for this shop. When creating an order (Create Order), if the paymentSettings object is not explicitly provided, the payment will be processed using this default payment method.

    paymentSettingsAlias stringnullable

    A unique identifier assigned to a specific payment configuration. Use this alias when creating orders to ensure the correct payment settings are applied. This field is optional and will be provided in the response only if the payment method has been configured with an alias.

    For more detailed information about how to use aliases, refer to the Alias Documentation

  • ]
Loading...