Yedpay API Documentation

Description (Show Company Domain)

Show the domain name of the company for using online gateways (GET)

Can include the follow parameters separated by comma "," adding the parameter "include" in the url to get more information:

* company - provides the company info

* store - provides the store info

Example:

https://api.yedpay.com/v1/companies/{{company_id}}/aml-domains/{{domain_id}}?include=company

End Point

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

Variable

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

Request Header

Request Header
#	Key	Value	Description
1	Authorization	Bearer {{access_token}}	Login Token

Response

Response
#	Name	Type	Description
1	success	Boolean	Show Company Domain Success or Fail
2	data	Array	Include all domain Information (company_id etc...)

Success Response - data

Success Response - data
#	Name	Type	Description
1	id	String	Unique identifier of the domain
2	company_id	String	Unique identifier of the company
3	store_id	String	Unique identifier of the store
4	protocol	String	Protocol of the domain
5	domain	String	Domain of the company
6	name	String	Name (Description) of the domain
7	type	Integer	Domain Type 1: web 2: app
8	status	String	Domain Status: pending, activated, disabled, rejected, obsoleted, terminated
9	created_at	String	Datetime when the Company Domain was created
10	updated_at	String	Datetime when the Company Domain was updated lastly

Example Success Response

            {
                "success": true,
"data": {
                    "id": "R350MQONDY3KEJDYL4",
                    "company_id": "3GWX1LKVQNXOER4NYP",
                    "store_id": "2NMJVPOMGN9O70RL8W",
                    "protocol": "https",
                    "domain": "www.yedpay.com",
                    "name": "xxxxxxxx",
                    "type": 2,
                    "created_at": 2024-04-24 20:43:47
                    "updated_at": 2024-04-24 20:43:47
                }
            }

Example Error Response

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