Yedpay

Description (Show Company Domain)

Show the domain name(s) 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}}/domains?include=company

End Point

https://api.yedpay.com/v1/companies/{{company_id}}/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

Response

Response
# Name Type Description
1 success Boolean Show Company Domain Success or Fail
2 data Array Include all domain Information (company_id etc...)
3 meta Array Include all Pagination's Information (total, count, total_pages, 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": "P5631VZGQV3KN94JDX",
                        "company_id": "6PEQD4O4MMGZ5VY8W3",
                        "store_id": "Q1N07LOJN06Z35P2GD",
                        "protocol": "http",
                        "domain": "www.yedpay.com",
                        "name": "xxxxxxxx",
                        "type": 1,
                        "created_at": 2022-01-25 10:32:21
                        "updated_at": 2022-01-25 10:32:21
                    },
                    {
                        "id": "6PEQD4O4JQMZ5VY8W3",
                        "company_id": "WJ3459ZDRM9OY1RP8V",
                        "store_id": "8YN319ZPEQJKX2DJ7P",
                        "protocol": "http",
                        "domain": "www.yedpay.com",
                        "name": "xxxxxxxx",
                        "type": 1,
                        "created_at": 2022-01-25 10:32:21
                        "updated_at": 2022-01-25 10:32:21
                    }
                ],
                "meta": {
                    "pagination": {
                        "total": 2,
                        "count": 2,
                        "per_page": 40,
                        "current_page": 1,
                        "total_pages": 1,
                        "links": []
                    }
                }
            }

Example Error Response

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

v1.53.8-20220124 © The Payment Cards Group Limited. All rights reserved.