get all available payment channels of stores

get all available payment channels of stores

🔒

Requires read_finance access scope. More access scope

The get available payment channels API retrieves all available payment channels configured for a store.

This API is especially useful for:

  1. Identifying available payment methods for order processing
  2. Integrating with store-specific payment gateways
  3. Displaying payment options to customers during checkout

Request Parameters

Public Request Parameters

📘

Response Explanation

Public Response Parameters

📘

Successful Response

ParameterTypeExampleDescription
codestring"success"API response status code
messagestring"Refund records retrieved"Response message
data.channel_listarray[object]Array of payment channels
data.channel_list.idstring"ref_123456"Unique channel identifier
data.channel_list.namestring"PayPal"Display name of payment method
data.channel_list.payment_channelstring"PayPal"Payment service channel
data.channel_list.payment_methodstring"online"Specific payment method

Error Response

FieldTypeExampleDescription
codestringInvalidParameterError http message
messagestringError message
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!