Yedpay

Description (Create Store)

Create a store which related with that company. (POST)

End Point

https://api.yedpay.com/v1/companies/{{company_id}}/stores

Variable

# Name Type Description
1 company_id String Company's ID

Request Header

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

Body

# Name Type Description
1 name String Store's Name
2 phone String (Optional) Store's Phone
3 address String (Optional) Store's Address
4 logo Integer (Optional) Store's Logo
5 type Integer (Optional) Store Type
1: OFFLINE
2: ONLINE
(default type = 1 [Offline Store])
6 domain Url (require if type = 2 [Online Store]) Domain of the company
Should be in URL format and at least 10 characters (Max: 100 characters)
7 protocol String (require if type = 2 [Online Store]) Domain protocol (http, https)
8 domain_name String (optional if type = 2 [Online Store]) name of the company domain
9 domain_type Integer (optional if type = 2 [Online Store]) Domain Type
1: web
2: app

Response

# Name Type Description
1 success Boolean Create Store Success or Fail
2 message String Success or Fail Message

Success Response - data

# Name Type Description
1 id String Id of the Store
2 name String Name of the Store
3 phone String Phone of the Store
4 address String Address of the Store
5 store_identifier String Store Identifier
6 type Integer Store Type:
1 - OFFLINE
2 - ONLINE
7 logo String Logo of the Store
8 logo_url String Url of the Logo
9 created_at String Date when the Store was created "YYYY-mm-dd h:i:s"

Example Success Response

            {
                "success": true,
                "data": {
                    "id": "KzoONpJE",
                    "name": "xxxx",
                    "phone": "xxxx",
                    "address": "xxxx",
                    "store_identifier": "LZXE",
                    "type": 1,
                    "logo": "xxxx",
                    "logo_url": "xxxx",
                    "created_at": "2099-01-02 12:00:00"
                }
            }
        

Example Error Response

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

v1.30.0-20191113 © The Payment Cards Group Limited. All rights reserved.