Skip to main content

DiscountPaymentRequest

Discount attached to a customer transaction. Can be points discount, voucher discount, etc.

amountinteger<int64>required

Discount amount in minor currency units.

currencyCodeCurrency (string)required

Currency alphabetic code as specified by ISO 4217

Possible values: >= 3 characters and <= 3 characters

Example: EUR
typestringrequired

Discount source type.

Possible values: [POINTS, VOUCHER]

redemption object

Identifies a chosen discount option for redemption APIs (for example purchase-order discountDetails or transfer preview discounts). The presence of a redemption resource indicates whether the downstream business domain is responsible for debiting the customer's loyalty rewards. If redemption is not provided, the discount is applied as a fiat adjustment, and no loyalty rewards are debited.

referencestringrequired

Stable reference for this discount tier or voucher (for example points amount as a string, voucher code, or 0 for no discount).

displayNamestring

Customer-facing label for the discount option in UI copy.

sender objectrequired

Discount sender information

customerIdstring

Wallet customer identifier.

accountIdstring

The account where the money gets debited from.

currencyCurrency (string)

Currency alphabetic code as specified by ISO 4217

Possible values: >= 3 characters and <= 3 characters

Example: EUR
DiscountPaymentRequest
{
"amount": 0,
"currencyCode": "EUR",
"type": "POINTS",
"redemption": {
"reference": "string",
"displayName": "string"
},
"sender": {
"customerId": "string",
"accountId": "string",
"currency": "EUR"
}
}