Skip to main content
GET
Get Channel List

Headers

Abp-TenantId
string
required

Your unique Merchant ID assigned by CommercePay.

Authorization
string
required

Your API credentials used for authentication (typically a Bearer token).

cap-signature
string
required

A unique security hash used to verify the integrity of the request body. See Generate Signature for how to generate this.

Query Parameters

countryCode
string
required

Country code with 2-letter of ISO Alpha-2 standard

Maximum string length: 2
Example:

"MY"

Response

200 - application/json

Success

id
integer<int32>

An identifier that represents CommercePay channel.

name
string | null

Channel Name

type
enum<integer>

Channel Type: [1= OnlinePayment, 2= OnlinePayout, 3= OnlineRecurringPayment]

Available options:
1,
2
refundType
enum<integer>

Channel Support Refund Type: [0= UnSupported Refund, 1= Only Full Refund, 2= Full Refund And Partial Refund]

Available options:
0,
1,
2
isProviderHostChannel
boolean

If "isProviderHostChannel" is indicated as true, it means that the provider has its own one or more hosted channels. To get provider channels, merchants are required to call the endpoint: /api/services/app/Channel/GetProviderChannels.

currencies
object[] | null
imageUrl
string | null

Url image of Payment Provider channel

groupId
integer<int32> | null
groupName
string | null
groupImageUrl
string | null
savePayment
boolean

Availability to save user info for subsequent payments