Deactivate

Use Deactivate Status before calling this method.

POST https://api.e-guma.ch/v1/depot_vouchers/{`code`}/deactivate.json?apikey={`api-key`}

Parameters

AttributeDescription
code requiredThe 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-key required

POST Data (optional)

AttributeDescription
deactivate_reason optionalAn optional alphanumeric deactivation reason can be transmitted. Maximum 1024 characters.

Return

codeThe same voucher code as you provided as parameter
amount_in_centsThe value of the deactivated voucher

Example

POST https://api.e-guma.ch/v1/depot_vouchers/CDHE2JNT5LS9/deactivate.json?apikey=510e32c594d84816a4af9df1
{
  "deactivate_reason":"This is a reason for deactivation"
}
{
  "code":"JWCPP7QV25S4",
  "balance_in_cents":40000
}