Available from CRM.COM R5.0.0
This method returns a voucher's secret number. The secret number of a single voucher is returned by each call
Resource URL
Parameters
Name | Type | Description | |||||||||
token | String | The token retrieved from the login method | |||||||||
| voucher_identifier (mandatory) | Voucher identifier | The identifier of the voucher that should be returned as a result. The allowed vouchers identifier fields are the following:
| |||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved voucher |
secret_number | String | The secret_number of the retrieved voucher |
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"secret_number": "0977835",
"id": "87DB0829834D1AC4B38B64616BF8855D"
}
}