Retrieve Payout Methods

GET 
/payouts/payout-methods/:shopId

Retrieves the list of payout methods available for a given shop, identified by its {shopId}. This endpoint provides an unfiltered list of all payout methods applicable to the shop.

Optionally, the results can be narrowed down by specifying supported currencies, instrument types, regions, and transfer types.

The information obtained from this endpoint is used to determine the list of mandatory fields required for creating a payout, as detailed in the Retrieve Required Payout Fields endpoint.

Request

Path Parameters

shopId integerrequired

The unique identifier of the shop for which to retrieve payout methods.

Query Parameters

currencies string[]

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

Currently not implemented. A list of currency codes to filter available payout 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, crypto_wallet, voucher]

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

regions string[]

Currently not implemented. A list of regions to filter the payout methods available in specific geographical areas. Each region should be specified by its ISO 3166-1 alpha-2 code.

transferTypes string[]

Possible values: [swift, sepa, bank_wire, card2card, pix, sbp, online_banking, open_finance, virtual_account, qris, promptpay, thaiqr, spei, vietnambanksqr, vietqr, khipu, paysafecard, multibanco, bancontact, blik, p24, rapidtransfer, upi, thb_qr, sberbank, giropay, eps, account2card]

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

Responses

200

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

application/json

Schema

Schema

data object[]required
Array [
providerCode stringrequired
Determines which payout provider should be used to process the payout.
acquirerCode stringrequired
Identifies the specific acquirer responsible for processing payments.
instrumentType stringrequired
Possible values: [card, bank_transfer, wallet, crypto_wallet, voucher]
Specifies the instrument type for the payout.
entryMode stringnullable
Possible values: [cnp, card_present, moto, recurring, saved_card, redirect]
This field specifies the method by which payment data is entered and should only be used when instrumentType == card. Payment Entry Modes for instrument type card
dataEntryModes string[]required
Possible values: [redirect, h2h, qr]
Methods for data entry to process payout:
redirect - the entity making the payout enters payment information on the provider's (acquirer's) page via redirect;
h2h (host2host) - the entity making the payout enters payment information via our API;
qr - the entity making the payout 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 payout method.
transferType stringnullable
Possible values: [swift, sepa, bank_wire, card2card, pix, sbp, online_banking, open_finance, virtual_account, qris, promptpay, thaiqr, spei, vietnambanksqr, vietqr, khipu, paysafecard, multibanco, bancontact, blik, p24, rapidtransfer, upi, thb_qr, sberbank, giropay, eps, account2card]
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 payout instrument.
regions string[]required
Possible values: Value must match regular expression ^[A-Z]{2}$
A list of regions where this payout method is available. Each region will be specified by its ISO 3166-1 alpha-2 code
isDefault booleanrequired
This parameter is currently not in use and can be ignored. Specifies whether this payout method is set as the default for this shop. When creating an payout (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 payout configuration. Use this alias when creating payouts to ensure the correct payment settings are applied. This field is optional and will be provided in the response only if the payout method has been configured with an alias.
For more detailed information about how to use aliases, refer to the Alias Documentation
]

Example (from schema)

{
  "data": [
    {
      "providerCode": "connectpay",
      "acquirerCode": "Gcash",
      "instrumentType": "wallet",
      "entryMode": null,
      "dataEntryModes": [
        "redirect"
      ],
      "allowedCards": [],
      "transferType": null,
      "currencies": [
        "PHP"
      ],
      "regions": [
        "PH"
      ],
      "isDefault": false,
      "paymentSettingsAlias": "testAlias"
    }
  ]
}

Loading...