Activate Status
GET https://api.e-guma.ch/v1/depot_vouchers/{code}/activate_status.json?apikey={api-key}
Parameters
coderequired | The alphanumeric code of the voucher. The code has 12 characters. You can pass the code with (e.g. ABCD-ABCD-ABCD) or without (e.g. ABCDABCDABCD) dashes. |
api-keyrequired |
Return
code | The same voucher code as you provided as parameter |
can_be_activated | If the voucher is not yet sold it is equal true. If the voucher is already sold it is false |
free_amount | If this value is true, the user can choose the value of the voucher in your system. If false, the value of the voucher is returned in the field amount_in_cents |
amount_in_cents | The value of the voucher |
message | If the voucher can not be activated, the message contains the reason. The message is returned in the client's default language. |
Example
GET https://api.e-guma.ch/v1/depot_vouchers/CDHE2JNT5LS9/activate_status.json?apikey=510e32c594d84816a4af9df1
{
"code":"CDHE2JNT5LS9",
"can_be_activated":true,
"free_amount":false,
"amount_in_cents":5000,
"message":""
}
Updated over 4 years ago