voucher-user-resource
getAllVouchers
get/api/user/voucher/{code}
Path parameters
codestring required
code
Query parameters
amount.equalsnumber
amount.greaterThannumber
amount.greaterThanOrEqualnumber
amount.innumber[]
amount.lessThannumber
amount.lessThanOrEqualnumber
amount.notEqualsnumber
amount.notInnumber[]
amount.specifiedboolean
balance.equalsnumber
balance.greaterThannumber
balance.greaterThanOrEqualnumber
balance.innumber[]
balance.lessThannumber
balance.lessThanOrEqualnumber
balance.notEqualsnumber
balance.notInnumber[]
balance.specifiedboolean
clubBalance.equalsnumber
clubBalance.greaterThannumber
clubBalance.greaterThanOrEqualnumber
clubBalance.innumber[]
clubBalance.lessThannumber
clubBalance.lessThanOrEqualnumber
clubBalance.notEqualsnumber
clubBalance.notInnumber[]
clubBalance.specifiedboolean
clubId.equalsinteger
clubId.greaterThaninteger
clubId.greaterThanOrEqualinteger
clubId.ininteger[]
clubId.lessThaninteger
clubId.lessThanOrEqualinteger
clubId.notEqualsinteger
clubId.notIninteger[]
clubId.specifiedboolean
createdDateFrom.equalsstring date-time
createdDateFrom.greaterThanstring date-time
createdDateFrom.greaterThanOrEqualstring date-time
createdDateFrom.in[0].epochSecondinteger
createdDateFrom.in[0].nanointeger
createdDateFrom.lessThanstring date-time
createdDateFrom.lessThanOrEqualstring date-time
createdDateFrom.notEqualsstring date-time
createdDateFrom.notIn[0].epochSecondinteger
createdDateFrom.notIn[0].nanointeger
createdDateFrom.specifiedboolean
createdDateTo.equalsstring date-time
createdDateTo.greaterThanstring date-time
createdDateTo.greaterThanOrEqualstring date-time
createdDateTo.in[0].epochSecondinteger
createdDateTo.in[0].nanointeger
createdDateTo.lessThanstring date-time
createdDateTo.lessThanOrEqualstring date-time
createdDateTo.notEqualsstring date-time
createdDateTo.notIn[0].epochSecondinteger
createdDateTo.notIn[0].nanointeger
createdDateTo.specifiedboolean
currency.equals'IRR'
currency.instring[]
currency.notEquals'IRR'
currency.notInstring[]
currency.specifiedboolean
fromDatestring
fromDate
id.equalsinteger
id.greaterThaninteger
id.greaterThanOrEqualinteger
id.ininteger[]
id.lessThaninteger
id.lessThanOrEqualinteger
id.notEqualsinteger
id.notIninteger[]
id.specifiedboolean
pageinteger
Page number of the requested page
purchaseId.equalsinteger
purchaseId.greaterThaninteger
purchaseId.greaterThanOrEqualinteger
purchaseId.ininteger[]
purchaseId.lessThaninteger
purchaseId.lessThanOrEqualinteger
purchaseId.notEqualsinteger
purchaseId.notIninteger[]
purchaseId.specifiedboolean
sizeinteger
Size of a page
sortstring[]
Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
sourceDescription.containsstring
sourceDescription.doesNotContainstring
sourceDescription.equalsstring
sourceDescription.instring[]
sourceDescription.notEqualsstring
sourceDescription.notInstring[]
sourceDescription.specifiedboolean
toDatestring
toDate
userId.equalsinteger
userId.greaterThaninteger
userId.greaterThanOrEqualinteger
userId.ininteger[]
userId.lessThaninteger
userId.lessThanOrEqualinteger
userId.notEqualsinteger
userId.notIninteger[]
userId.specifiedboolean
voucherSource.equals'PURCHASE' | 'GIFT_CARD' | 'REFUND' | 'BURN_PURCHASE' | 'BOUGHT' | 'CLUB_MONTHLY_GIVEN' | 'CLUB_MONTHLY_TAKEN'
voucherSource.instring[]
voucherSource.notEquals'PURCHASE' | 'GIFT_CARD' | 'REFUND' | 'BURN_PURCHASE' | 'BOUGHT' | 'CLUB_MONTHLY_GIVEN' | 'CLUB_MONTHLY_TAKEN'
voucherSource.notInstring[]
voucherSource.specifiedboolean
voucherType.equals'DEPOSIT' | 'WITHDRAW'
voucherType.instring[]
voucherType.notEquals'DEPOSIT' | 'WITHDRAW'
voucherType.notInstring[]
voucherType.specifiedboolean
Response
OK
Changes
No recorded changes to this endpoint across all 1 revision of this API.