Skip to main content
GET
Get Provider Channels

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

ChannelId
integer<int32>
required

An identifier that represents a CommercePay channel. Refer to the id on response endpoints of Get Channel List.

Response

Success

id
string | null

An identifier that represents the payment provider channel

name
string | null

Payment Provider channel Name

displayName
string | null

Payment Provider channel Display Name

imageUrl
string | null

Url image of Payment Provider channel

status
enum<integer>

Status of the payment provider channel

Available options:
0,
1,
2,
-1