Description (Create Company Application)
Action to create Application for company to access API.(POST)Each company can create 10 Applications
End Point
https://api-h2h-staging.yedpay.com/v1/companies/{{company_id}}/applications
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 |
Body
| # | Name | Type | Description |
|---|---|---|---|
| 1 | store_id | String | (optional) Store's ID |
| 2 | name | String | Name of Application |
Response
| # | Name | Type | Description |
|---|---|---|---|
| 1 | success | Boolean | Generate Application Success or Fail |
| 2 | data | Array | Include all Application information (api_key etc...) |
Success Response - data
| # | Name | Type | Description |
|---|---|---|---|
| 1 | id | String | ID of the application |
| 2 | name | String | Name of Application |
| 3 | company_id | String | ID of Company |
| 4 | store_id | String | ID of Store |
| 5 | type | Integer |
Application Type 1: OFFLINE 2: ONLINE |
| 6 | api_key | String | Key generated |
| 7 | last_used | String | date of the latest application used record(nullable) |
| 8 | revoked_at | String | revoke date of the application (nullable) |
| 9 | created_at | String | create date of the application |
| 10 | updated_at | String | Last update date of the application |
Example Success Response
{
"success": true,
"data": {
"id": "xxxxxx",
"name": "xxxxxx",
"company_id": "xxxxxx",
"store_id": "xxxxxxx",
"type": 2,
"api_key": "00112233445566778899aabbccddeeff",
"last_used": "",
"revoked_at': "",
"created_at": "2019-03-12 16:39:26"
"updated_at": "2019-03-12 16:39:26"
}
}
Example Error Response
{
"success": false,
"message": "This action is unauthorized.",
"status": 403
}
v1.89.5-20251216 © The Payment Cards Group Limited. All rights reserved.