Create Member Redemption
1 min
POST
https://api.b.preview.loyaltyservices.io/api/v3/members/{memberIdentifier}/redemptions
memberIdentifierstringMember identifier
createCouponUseboolean<p>If the redemption item creates coupons, this will place a hold or use on those coupons</p>
holdCouponboolean<p>If set to true, will place a hold on the coupon instead of a use. Dependent on client program configuration.</p>
validateOnlyboolean<p>If set to true, will only validate the redemption and not place the order.</p>
allowOverRedeemboolean<p>Allow redemption where the member point balance can be less then zero after the redemption is issued. Requester must have entitlement of api:member-redemption</p><div></div> to perform this.<p></p>
allowPoolRedeemboolean<p>If the member lacks sufficient currency to redeem the item, but belongs to a points pool with a sufficient combined balance, the redemption is funded by first exhausting the member's individual balance, then drawing the shortfall from pool members. If the pool balance is also insufficient and allowOverRedeem is set, any remaining shortfall is overdrawn from the redeeming member's account.</p>
migrateboolean<p>Imports a redemption i.e. creates or updates a Tally redemption without updating point balances.
If a redemption exists with the same account number and reference ID, that redemption will be updated;
otherwise a new redemption is created.
A point value is not calculated for the redemption but can be provided in the providedAmount property.
The "api:member-redemption</p><div></div>" scope is required to use this parameter.
Use this parameter only to migrate existing data to Tally.<p></p>
skipFraudCheckboolean<p>Set to true to bypass fraud detection and complete the redemption.
Requires the "api:member-redemption-fraud</p><div></div>" scope.
Use case: When a redemption is initially blocked due to fraud detection,
an authorized agent can review the case and retry the redemption with
this flag set to true to override the fraud check and complete the transaction.<p></p>
asyncboolean<p>Submits the operation for background processing and returns a ‘202 Accepted’ response
along with an identifier to track the processing status.
Requires the "api:async-task</p><div></div>" scope.<p></p>
acceptstringGenerated from available response content types
bodyobjectMember Redemption Request Object
200Success
202Accepted
400Bad request
401Unauthorized
403Forbidden
500Internal error
curl --request POST \
--url 'https://api.b.preview.loyaltyservices.io/api/v3/members/{memberIdentifier}/redemptions?createCouponUse=boolean&holdCoupon=boolean&validateOnly=boolean&allowOverRedeem=boolean&allowPoolRedeem=boolean&migrate=boolean&skipFraudCheck=boolean&async=boolean' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"quantity": "",
"orderAddress": {
"address1": "",
"city": "",
"stateCode": "",
"zip": "",
"countryCode": ""
}
}'