Yedpay API Documentation

Description (Apply for Credential)

Action to apply for the use of the gateway. (POST)

End Point

https://api-h2h-staging.yedpay.com/v1/credentials/apply/{{company_id}}

Variable

Variable
#	Name	Type	Description
1	company_id	String	Company's ID

Request Header

Request Header
#	Key	Value	Description
1	Authorization	Bearer {{access_token}}	Login Token
2	Content-Type	application/x-www-form-urlencoded	x-www-form-urlencoded

Body

Body
#	Name	Type	Description
1	gateway_id	Integer	(Required if gateway_code not exist) (1 - Alipay, 2 - UnionPay, 4 - Alipay Online, 7 - Cybersource, 8 - WeChat Pay, 9 - UnionPay Online, 10 - UnionPay QR, 11 - UnionPay POS, 12 - Credit Card Online)
2	gateway_sub_id	Integer	(Optional) Subtype of Gateway (Default: 1) (If gateway_id = 7) 1. VISA Offline 2. Mastercard Offline 5. AMEX Offline
3	gateway_code	Integer	(Required if gateway_id not exist) Gateway Code Format: {{gateway_id}}_{{gateway_sub_id}} Example: 7_2 (Cybersource - Mastercard Offline)
4	signature_required	Boolean	(ONLY applicable if gateway_id = 7) Whether signature is required during transactions (Default: false)

Response

Response
#	Name	Type	Description
1	success	Boolean	Apply Credential Success or Fail
2	message	String	Success or Fail Message

Example Success Response

            {
                "success": true,
                "message": "Request Accepted."
            }

Example Error Response

            {
                "success": false,
                "message": "Gateway was requested before",
                "status": 400
            }