Yedpay

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 company_id String Id of the Company
3 gateway_id Integer Id of the Gateway
4 name String Name of the Gateway
5 rate String Rate of the Gateway
6 rate_without_number_format Float Rate of the Gateway
7 status_gateway Integer Status of the Gateway
8 status String Status of the Gateway
9 cross_border_rate Float (ONLY applicable if gateway_id = 7) Cross Border Rate of the Gateway
10 signature_required Boolean (ONLY applicable if gateway_id = 7) Whether signature is required during transaction
11 contract Array (ONLY applicable if gateway_id = 7) Contract Information for cybersource
12 gateway Array Include Information of the Gateway(ONLY superadmin)

Example Success Response

            {
                "success": true,
                "data": [
                    {
                        "id": "JwoMPpKy",
                        "company_id": "JwoMPpKy",
                        "gateway_id": 1,
                        "name": "alipay",
                        "rate": "1.50",
                        "rate_without_number_format": 1.5,
                        "status_gateway": 2,
                        "status": "activated",
                    },
                    {
                        "id": "e4r94oJx",
                        "company_id": "JwoMPpKy",
                        "gateway_id": 8,
                        "name": "wechatpay",
                        "rate": "2.50",
                        "rate_without_number_format": 2.5,
                        "status_gateway": 2,
                        "status": "activated",
                    },
                    {
                        "id": "OQW3GQK",
                        "company_id": "JwoMPpKy",
                        "gateway_id": 7,
                        "name": "cybersource",
                        "rate": "2.50",
                        "rate_without_number_format": 2.5,
                        "status_gateway": 2,
                        "status": "activated",
                        "cross_border_rate": "2.50",
                        "signature_required": false,
                    },
                ],
                "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.19.0-20190522 © The Payment Cards Group Limited. All rights reserved.