Description (Generate Company Sign Key)
Action to generate key for company to sign signature(POST)
End Point
https://api.yedpay.com/v1/companies/{{company_id}}/sign-key
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 |
---|
Response
# | Name | Type | Description |
---|---|---|---|
1 | success | Boolean | Generate Sign Key Success or Fail |
2 | data | Array | Include all sign key information (sign_type, key etc...) |
Success Response - data
# | Name | Type | Description |
---|---|---|---|
1 | id | String | ID of the Sign Key |
2 | company_id | String | ID of Company |
3 | sign_type | String | Algorithm for signing signature |
4 | key | String | Key generated |
5 | updated_at | String | Last update date of the sign key |
Example Success Response
{ "success": true, "data": { "id": "xxxxxx", "company_id": "xxxxxxx", "sign_type": "HMAC_SHA256", "key": "00112233445566778899aabbccddeeff", "updated_at": "2019-03-12 16:39:26" } }
Example Error Response
{ "success": false, "message": "This action is unauthorized.", "status": 403 }
v1.62.0-20231122 © The Payment Cards Group Limited. All rights reserved.