Yedpay

Description (Register Company Domain)

Register the domain name(s) of the company for using online gateways (POST)

End Point

https://api.yedpay.com/v1/companies/{{company_id}}/aml-domains

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

Body

Body
# Name Type Description
1 domain Url Domain of the company
Should be in URL format and at least 10 characters (Max: 100 characters)
2 store_id String Company's Store ID
3 name String name of the company domain
4 type Integer Domain Type
1: web
2: app
5 return_url String (Optional) Redirect URL when the payment is finished
if type = WEB, only HTTP and HTTPS scheme URL allowed
if type = APP, custom scheme is allowed

Response

Response
# Name Type Description
1 success Boolean Register Company Domain Success or Fail
2 message String Detail message of the response

Example Success Response

    {
        "success": true,
        "message": "Request accepted"
    }
        

Example Error Response

    {
        "success": false,
        "message": "Unauthenticated.",
        "status": 500
    }
    

v1.65.2-20240326 © The Payment Cards Group Limited. All rights reserved.