Lookup a gift card for redemption. [Authenticated; Perm: Account Integrator / Member]

post

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

itsOnMePaperCertificateCode

string

The voucher's ItsOnMe RD Code - as an alternative to the voucher code.

organizationID

uuid

The ID of location where the redemption is occuring.

pointOfSaleSystemOrganizationIdentifier

string

Identifier for the specific's location point of sale

targetProgramID

uuid

The anticipated program of the voucher.

targetTypeCode

string

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

ticketData

object

validateTargetProgram

boolean

If the target program is provided, whether to validate it matches with the gift. Default true. (must be supplied in combination with TargetProgramID)

validateTargetType

boolean

If the target type is provided, whether to validate it matches with the gift. Default true. (must be supplied in combination with TargetTypeCode)

voucherCode

int64

The 12 digit voucher code - required unless a public token 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

Loading…

Response

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

application/json

text/json

200OK