Description (Company's Credential List)
Show the credentials's Information for the gateways of the company. (GET)
End Point
https://api.yedpay.com/v1/companies/{{company_id}}/credentials
Variable
# | Name | Type | Description |
---|---|---|---|
1 | company_id | String | Company's ID |
Request Header
# | Key | Value | Description |
---|---|---|---|
1 | Authorization | Bearer {{access_token}} | Login Token |
Body
# | Name | Type | Description |
---|
Response
# | Name | Type | Description |
---|---|---|---|
1 | success | Boolean | Request Credential List Success or Fail |
2 | data | Array | Include all credential Information (credential_id, company_id, gateway_id, etc..) |
3 | meta | Array | Include all Pagination's Information (total, count, total_pages, etc..) |
Success Response - data
# | Name | Type | Description |
---|---|---|---|
1 | id | String | Id of the Credential |
2 | display_gateway | Boolean | Whether the gateway will be displayed on checkout page |
3 | display | Boolean | Display Status of the Gateway (visible or invisible) |
4 | company_id | String | Id of the Company |
5 | gateway_id | Integer | Id of the Gateway |
6 | name | String | Name of the Gateway |
7 | rate | String | Rate of the Gateway |
8 | rate_without_number_format | Float | Rate of the Gateway |
9 | status_gateway | Integer | Status of the Gateway |
10 | status | String | Status of the Gateway |
11 | created_at | String | Date when the Request of Gateway was created "YYYY-mm-dd h:i:s" |
12 | updated_at | String | Date when the Request of Gateway was updated "YYYY-mm-dd h:i:s" |
13 | merchant_status | String | (ONLY applicable if gateway_id = 4) Merchant Status of the Gateway |
14 | cross_border_rate | Float | (ONLY applicable if gateway_id = 7 or 12) Cross Border Rate of the Gateway |
15 | signature_required | Boolean | (ONLY applicable if gateway_id = 7) Whether signature is required during transaction |
16 | transaction_limit | String | (ONLY applicable if gateway_id = 7 or 12) Whether signature is required during transaction |
Example Success Response
{ "success": true, "data": [ { "id": "JwoMPpKy", "display_gateway": "true", "display": "visible", "company_id": "JwoMPpKy", "gateway_id": 1, "name": "alipay", "rate": "1.50", "rate_without_number_format": 1.5, "status_gateway": 2, "status": "activated", "merchant_status": "activated", "created_at": "2099-01-02 12:00:00", "updated_at": "2099-01-02 12:00:00" }, { "id": "e4r94oJx", "display_gateway": "true", "display": "visible", "company_id": "JwoMPpKy", "gateway_id": 8, "name": "wechatpay", "rate": "2.50", "rate_without_number_format": 2.5, "status_gateway": 2, "status": "activated", "created_at": "2099-01-02 12:00:00", "updated_at": "2099-01-02 12:00:00" }, { "id": "OQW3GQK", "display_gateway": "true", "display": "visible", "company_id": "JwoMPpKy", "gateway_id": 7, "name": "cybersource", "rate": "2.50", "rate_without_number_format": 2.5, "status_gateway": 2, "status": "activated", "created_at": "2099-01-02 12:00:00", "updated_at": "2099-01-02 12:00:00" "cross_border_rate": "2.50", "signature_required": false, "transaction_limit": "1000000.00", }, ], "meta": { "pagination": { "total": 3, "count": 3, "per_page": 40, "current_page": 1, "total_pages": 1, "links": [] } } }
Example Error Response
{ "success": false, "message": "Unauthenticated.", "status": 500 }
v1.61.22-20230912 © The Payment Cards Group Limited. All rights reserved.