Redeem a gift. [Authenticated; Perm: Account Integrator / Member]

post

https://qa-api.giftlocal.com/api/integration/redemption/redeem-gift

Body Params

amount

double

The amount to redeem. Leave as null to redeem in full.

hasAdminOverrideUsageSchedule

boolean

Advanced schduling override flag.

organizationID

uuid

The ID of location where the redemption is occuring.

pointOfSaleSystemOrganizationIdentifier

string

Identifier for the specific's location point of sale

submissionInterface

string

The interface used during submission.

targetTypeCode

string

Target Type Code for POS (i.e GIFT/NOT_GIFT)

validateTargetType

boolean

Validate target type for POS InfoG (must be supplied in combination with TargetTypeCode)

voucherCode

int64

The voucher code - must be full 12 digit voucher code. Optional alternative to voucher ID..

voucherID

uuid

The voucher ID - required unless a full 12 digit voucher code is provided.

voucherPublicToken

string

The voucher's public token - as an alternative to the voucher code.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

200OK