Description (Company Gateway Code List)
Show the available gateways for apply (GET)
End Point
https://api.yedpay.com/v1/companies/{{company_id}}/gateway-codes
Request Header
| # | Key | Value | Description |
|---|---|---|---|
| 1 | Authorization |
Bearer {{access_token}}
OR API-KEY {{api_key}} |
Login Token
OR API Key |
Body
| # | Name | Type | Description |
|---|
Response
| # | Name | Type | Description |
|---|---|---|---|
| 1 | success | Boolean | Request Success or Fail |
| 2 | data | Array | Include all available gateway |
Success Response - data
| # | Name | Type | Description |
|---|---|---|---|
| 1 | id | Integer | Id of the Gateway |
| 2 | gateway_name | String | Name of the Gateway |
| 3 | subtype | Array | The subtype of the gateway |
Gateway subtype
| # | Name | Type | Description |
|---|---|---|---|
| 1 | gateway_sub_id | Integer | ID of the gateway subtype |
| 2 | gateway_sub_name | String | Name of the gateway subtype |
| 3 | gateway_code | String | The gateway code |
| 4 | gateway_status | Integer |
The current status of gateway
|
| 5 | is_online | Boolean | Is online gateway or not |
Example Success Response
{
"success": true,
"data": [
{
"gateway_id": 1,
"gateway_name": "alipay",
"subtype": [
{
"gateway_sub_id": 1,
"gateway_sub_name": "Alipay",
"gateway_code": "1_1",
"gateway_status": 2,
"is_online": false
}
]
},
{
"gateway_id": 4,
"gateway_name": "alipay_online",
"subtype": [
{
"gateway_sub_id": 1,
"gateway_sub_name": "Alipay Online",
"gateway_code": "4_1",
"gateway_status": 2,
"is_online": true
},
{
"gateway_sub_id": 2,
"gateway_sub_name": "Alipay Online PC2Mobile",
"gateway_code": "4_2",
"gateway_status": 2,
"is_online": true
},
{
"gateway_sub_id": 3,
"gateway_sub_name": "Alipay Online SDK",
"gateway_code": "4_3",
"gateway_status": 2,
"is_online": true
}
]
},
{
"gateway_id": 7,
"gateway_name": "cybersource",
"subtype": [
{
"gateway_sub_id": 1,
"gateway_sub_name": "VISA",
"gateway_code": "7_1",
"gateway_status": 2,
"is_online": false
},
{
"gateway_sub_id": 2,
"gateway_sub_name": "Mastercard",
"gateway_code": "7_2",
"gateway_status": 2,
"is_online": false
}
]
},
{
"gateway_id": 8,
"gateway_name": "wechatpay",
"subtype": [
{
"gateway_sub_id": 1,
"gateway_sub_name": "WeChat Pay",
"gateway_code": "8_1",
"gateway_status": 2,
"is_online": false
},
{
"gateway_sub_id": 2,
"gateway_sub_name": "WeChat Pay Online",
"gateway_code": "8_2",
"gateway_status": 2,
"is_online": true
},
{
"gateway_sub_id": 3,
"gateway_sub_name": "WeChat Pay Online SDK",
"gateway_code": "8_3",
"gateway_status": 2,
"is_online": true
}
]
},
{
"gateway_id": 9,
"gateway_name": "unionpay_online",
"subtype": [
{
"gateway_sub_id": 1,
"gateway_sub_name": "UnionPay ExpressPay",
"gateway_code": "9_1",
"gateway_status": 2,
"is_online": true
},
{
"gateway_sub_id": 2,
"gateway_sub_name": "UnionPay ExpressPay CN",
"gateway_code": "9_2",
"gateway_status": 2,
"is_online": true
},
{
"gateway_sub_id": 5,
"gateway_sub_name": "UnionPay UPOP",
"gateway_code": "9_5",
"gateway_status": 3,
"is_online": true
}
]
},
{
"gateway_id": 10,
"gateway_name": "unionpay_qr",
"subtype": [
{
"gateway_sub_id": 1,
"gateway_sub_name": "UnionPay Merchant Presented Code",
"gateway_code": "10_1",
"gateway_status": 2,
"is_online": false
},
{
"gateway_sub_id": 2,
"gateway_sub_name": "UnionPay Customer Presented Code",
"gateway_code": "10_2",
"gateway_status": 2,
"is_online": false
}
]
},
{
"gateway_id": 11,
"gateway_name": "unionpay_pos",
"subtype": [
{
"gateway_sub_id": 1,
"gateway_sub_name": "UnionPay POS",
"gateway_code": "11_1",
"gateway_status": 0,
"is_online": false
}
]
},
{
"gateway_id": 12,
"gateway_name": "adyen",
"subtype": [
{
"gateway_sub_id": 1,
"gateway_sub_name": "VISA Online",
"gateway_code": "12_1",
"gateway_status": 0,
"is_online": true
},
{
"gateway_sub_id": 2,
"gateway_sub_name": "Mastercard Online",
"gateway_code": "12_2",
"gateway_status": 0,
"is_online": true
}
]
}
],
"status": 200
}
Example Error Response
{
"success": false,
"message": "Unauthenticated.",
"status": 500
}
v1.61.15-20230523 © The Payment Cards Group Limited. All rights reserved.