Configuring Vouchers

You use the fields outlined in the following table to model vouchers.

FieldDescription
voucher_typeSpecify cash-equivalent to ensure the value is deducted from the total.
voucher_amountThe total value of the voucher.
voucher_descriptionA description.
voucher_applied_amountA voucher amount that has been applied. It may not been fully applied if its amount was higher than the total transaction amount.
voucher_remaining_amountA voucher amount that has not been applied. Voucher may not been fully applied if its amount was higher than the total transaction amount.

For example:

{
        "voucher_type":"cash-equivalent"
        "voucher_code":"ABC_1234"
        "voucher_description":"Example 1"
        "voucher_amount":50
        "voucher_applied_amount":1
        "voucher_remaining_amount":0
    }
]