JPurse API Documentation

Version v2.30

Summary
JPurse API Documentation
API Reference
API Libraries
Authentication
Errors
URLs
ISBProvides functionality for ISB Golf Club integration.
//json/createCustomer
//json/updateCustomer
//json/addCardToCustomer
//json/lockCard
//json/activateCustomer
//json/deactivateCustomer
//json/unlockCard
//json/balance
//json/balanceHistory
//json/findCustomer
//json/lockLock a gift.
//json/listActivePrograms
emoneyProvides functionality for starting performing PSP actions.
/PSP/getPSPPaymentMethodesGet current active available payment methodes
/PSP/startPSPPaymentStart a PSP payment in order to use a customers account to end up topping up his er her balance.
/PSP/getPSPPaymentsStart a PSP payment in order to use a customers account to end up topping up his er her balance.
AboutProvides functionality for getting deployment information.
/about/aboutReturns information about the backend such as version.
AuthenticationProvides functionality for authentication.
/authentication/authenticateAuthenticate.
/authentication/authenticateDeviceAuthenticate a device.
/authentication/listAuthoritiesList all the rights.
BalanceProvides functionality for viewing balance related information of a customer.
/balance/balanceShow the current balance of a customer
/balance/balanceHistoryShows the transactions of the balance history for a custom, device or program
/balance/requestRefundRequest a refund of a balance currently attached to a customer identified by an attached card
/balance/confirmRefundRequestRequest a refund of a balance currently attached to a customer identified by an attached card, confirming the initial request
CardProvides functionality for managing cards.
/card/isCardValidCheck if the card is valid.
/card/lockCardLock a Card based on its card identifier.
/card/getCardIdentifierByUidGet the identifier of the card.
/card/unlockCardUnlock a Card based on its card identifier.
/card/getCardTypeGet the cartype of a card based on the card identifier.
/card/cardInfoGet the info of the card based on the card identifier.
/card/listCustomerCardsList the customer’s cards based on the customer Id.
CardBackgroundProvides functionality for card backgrounds.
/cardBackground/listCardBackgroundsLists the card backgrounds.
CommunityProvides functionality for communities.
/community/listCommunitiesList all active communities.
CouponProvides functionality for coupons.
/coupon/addCouponAdd coupon to user but do not claim.
/coupon/claimCouponClaim a coupon.
/coupon/assignCouponAssign a coupon to a user.
/coupon/assignCouponToGroupAssign a coupon to a group.
/coupon/listCouponFind a list of coupons.
/coupon/listCouponAssignmentFind a list of coupon assignments.
/coupon/requestCouponAssignmentRequest a coupon assignment.
CustomerProvides functionality for customers.
/customer/registerCustomerRegister a customer.
/customer/registerRaffleCustomerRegister a raffle customer as a new customer.
/customer/resetPasswordReset the password of a customer by his/her identifier.
/customer/changePasswordChange the password of a customer by his/her identifier.
/customer/lockCustomerLock a customer.
/customer/cleanCustomerClean a customer.
/customer/updateCustomerUpdate a customer.
/customer/findCustomerFind a customer.
/customer/findCustomersFind active customers
/customer/subscribeCustomerSubscribes the user by it’s userIdentifier identifier
/customer/unsubscribeCustomerUnsubscribes the user by it’s userIdentifier identifier
/customer/addCardToCustomerAdd a card to a customer.
/customer/removeCardFromCustomerRemoves a card from a customer.
/customer/authenticateCustomerAuthenticate a customer.
/customer/mergeCustomersAuthenticate a customer.
DeviceThemeProvides functionality for DeviceTheme related actions.
/deviceTheme/getDeviceThemeRetrieve the theme for a device
GiftProvides functionality for gift related actions.
/gift/lockLock a gift.
/gift/claimGiftClaim a gift.
/gift/claimGiftsClaim a list gift.
/gift/issueGiftIssue a gift.
/gift/issueGiftsIssue a list of gifts.
/gift/balanceBalance of a gift.
/gift/reversalReversal of a gift action.
/gift/createGiftCreation of a gift
/gift/giftUpdatePincodeUpdate gift pincode
/gift/giftLinkCustomerLink a gift to a customer
/gift/giftInfoRetrieve information on a gift
/gift/balanceJSONBalance of a gift.
LoyaltyProvides functionality for loyalty.
/loyalty/loyaltyRewardRedeemFind the reward list redeem rules.
/loyalty/startLoyaltyStart a loyalty.
MerchantProvides functionality for merhcants.
/merchant/registerMerchantRegister a merchant.
/merchant/listMerchantFind a list of merchants.
/merchant/listProgramByMerchantfind a list of programs from a merchant.
MerchantApplicationProvides functionality for merchantApplications.
/merchantApplication/merchantApplicationCreateCreate a merchant application.
/merchantApplication/merchantApplicationCheckcheck a merchant application.
ModuleProvides functionality for module related actions.
/module/listModulesFind a list of modules.
ProductProvides functionality for products.
/product/listActiveProductsFind a list of active products.
/product/listProductImagesfind a list of product images.
/product/listProductsByProgramFind a list of products based on product Id.
ProgramProvides functionality for programs.
/program/listActiveProgramsFind a list of active programs.
/program/listGiftProgramsfind a list of issueable gift programs.
RaffleProvides functionality for raffle related actions.
/raffle/retrieveRaffleQuestionsRaffle Question Retrieval
/raffle/listRafflesCall to lists all raffles the user is assigned for
/raffle/validateRaffleTicketRaffle Ticket Validation
/raffle/validateRafflePriceRaffle Price Validation
/raffle/claimRafflePriceRaffle Price Claiming
RedeemProvides functionality for Redeeming.
/redeem/redeemRedeem.
/redeem/listRulesList the redeem rules.
/redeem/rulesForMerchantList the redeem rules of a merchant.
/redeem/listRedeemRulesList the redeem rules based on parameters from the RedeemRuleRequest.
ReverseProvides functionality for reverses.
/reverse/reversalReverse a transaction.
RewardProvides functionality for Rewarding.
/reward/rewardReward.
/reward/rulesForMerchantList the reward rules of a merchant.
/reward/listRewardRulesFind a list of reward rules based on a card.
SerialProvides functionality for serials.
/serial/generateSerialGenerate a serial.
SlideProvides functionality for managing slides.
/slide/listCurrentSlidesFind a list of slides.
stackProvides functionality for creating and listing stacks.
/stack/relocateStackRelocate a stack.
StatisticsProvides functionality for retrieving statistics
/statistics/statisticsFind a list of statistics.
TopDownProvides functionality for TopDowning
/topdown/topDownTop down.
/topdown/topDownProductTop down product.
TopUpThe Class TopUpResource.
/topup/topUpTop up
UserProvides functionality for managing users.
/user/lockUserLock a user.
/user/authenticateUserAuthenticate a user.
/user/findUserFind a user.
/user/findUsersFind users.
VideoProvides functionality for managing videos.
/video/listCurrentVideosFind a list of videos.

API Reference

The API is organized around HTTP and Protocol Buffers.

HTTP

Our API is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors.  We use built-in HTTP features, like HTTP authentication and HTTP verbs, which can be understood by off-the-shelf HTTP clients.

Protocol Buffers

Requests and responses are serialized using Protocol Buffers, including errors -- think XML, but smaller, faster, and simpler.

API Libraries

There are lots of pre-built libraries for interacting with JPurse.

Java

  • Classes and Sources: java/sva.sdk.java-*.jar
  • Runtime: java/protostuf-*jar

Objective-C

  • Classes and Sources: objc/protobuffer/protomessages and objc/protobuffer/protostubs
  • Runtime: objc/protobuffer/runtime

PHP

  • Classes and Sources: php/protobuffer/protomessages and php/protobuffer/protostubs
  • Runtime: php/protobuffer/runtime
  • Examples: php/examples

Python

  • Classes and Sources: python/protobuffer/protomessages and python/protobuffer/protostubs
  • Runtime: python/binaries

Authentication

  • Authentication to the API occurs via HTTP Basic Auth.
  • All API requests must be made over HTTPS.
  • Calls made over plain HTTP will fail.
  • Authorisation is required for all requests.

Basic Authentication Header Format

  • Username, password (and optionally device-ID) are concatenated with a colon.
  • The resulting string is then Base64 encoded.
  • The authorization method and a space i.e.  “Basic “ is then put before the encoded string.

Errors

JPurse uses conventional HTTP response codes to indicate success or failure of a request.

HTTP Status Code Summary

200, 204 OKEverything worked as expected.
400 Bad RequestOften missing a required parameter, or parameters were valid but request failed.  For all bad requests, we return a FaultResponse.
401 UnauthorizedNo valid authentication credentials provided.
404 Not FoundThe requested item doesn’t exist.
500, 502, 503, 504 Server errorsSomething went wrong on JPurse’s end.

URLs

ISB

Provides functionality for ISB Golf Club integration.

//json/createCustomer

Request method

HTTP POST

Security rights

CONFIGURE_USER

See Also

Request entity: <String>

Response entity: none

//json/updateCustomer

Request method

HTTP POST

Security rights

CONFIGURE_USER

See Also

Request entity: <String>

Response entity: none

//json/addCardToCustomer

Request method

HTTP POST

Security rights

CONFIGURE_USER

See Also

Request entity: <String>

Response entity: none

//json/lockCard

Request method

HTTP POST

Security rights

CONFIGURE_CARD

See Also

Request entity: <String>

Response entity: none

//json/activateCustomer

Request method

HTTP POST

Security rights

CONFIGURE_USER

See Also

Request entity: <String>

Response entity: none

//json/deactivateCustomer

Request method

HTTP POST

Security rights

CONFIGURE_USER

See Also

Request entity: <String>

Response entity: none

//json/unlockCard

Request method

HTTP POST

Security rights

CONFIGURE_CARD

See Also

Request entity: <String>

Response entity: none

//json/balance

Request method

HTTP POST

Security rights

BALANCE

See Also

Request entity: <String>

Response entity: BalanceResponse

//json/balanceHistory

Request method

HTTP POST

Security rights

BALANCE

See Also

Request entity: <String>

Response entity: BalanceHistoryResponse

//json/findCustomer

Request method

HTTP GET

Security rights

CONFIGURE_USER

See Also

Request entity: none

Response entity: FindCustomerResponse

//json/lock

Lock a gift.

Request method

HTTP GET

Security rights

CONFIGURE_GIFT

See Also

Request entity: none

Response entity: none

//json/listActivePrograms

Request method

HTTP POST

Security rights

LIST_MERCHANTS

See Also

Request entity: none

Response entity: ListProgramResponse

emoney

Provides functionality for starting performing PSP actions.

/PSP/getPSPPaymentMethodes

Get current active available payment methodes

Request method

HTTP POST

Security rights

TOPUP

See Also

Request entity: <RetrievePaymentMethodsRequest>

Response entity: GetPSPPaymentMethodResponse

/PSP/startPSPPayment

Start a PSP payment in order to use a customers account to end up topping up his er her balance.

Request method

HTTP POST

Security rights

TOPUP

See Also

Request entity: StartPSPPaymentRequest

Response entity: StartPSPPaymentResponse

/PSP/getPSPPayments

Start a PSP payment in order to use a customers account to end up topping up his er her balance.

Request method

HTTP POST

Security rights

TOPUP

See Also

Request entity: RetrievePSPPaymentsRequest

Response entity: RetrievePSPPaymentsResponse

About

Provides functionality for getting deployment information.

/about/about

Returns information about the backend such as version.

Request method

HTTP GET

Security rights

ABOUT

See Also

Request entity: none

Response entity: AboutResponse

Authentication

Provides functionality for authentication.

/authentication/authenticate

Authenticate.

Request method

HTTP POST

Security rights

permitAll

See Also

Request entity: none

Response entity: none

/authentication/authenticateDevice

Authenticate a device.

Request method

HTTP POST

Security rights

permitAll

See Also

Request entity: AuthenticateDeviceRequest

Response entity: AuthenticateDeviceResponse

/authentication/listAuthorities

List all the rights.

Request method

HTTP POST

Security rights

permitAll

See Also

Request entity: none

Response entity: ListRightsResponse

Balance

Provides functionality for viewing balance related information of a customer.

/balance/balance

Show the current balance of a customer.  The quantity of each product and the amount of cash registered to a customer is returned as response.

Request method

HTTP POST

Security rights

BALANCE

See Also

Request entity: BalanceRequest

Response entity: BalanceResponse

/balance/balanceHistory

Shows the transactions of the balance history for a custom, device or program.  Every transaction shows how the balance was updated.

Request method

HTTP POST

Security rights

BALANCE

See Also

Request entity: BalanceHistoryRequest

Response entity: BalanceHistoryResponse

/balance/requestRefund

Request a refund of a balance currently attached to a customer identified by an attached card

Request method

HTTP POST

Security rights

BALANCE

See Also

Request entity: RequestRefundRequest

Response entity: RequestRefundResponse

/balance/confirmRefundRequest

Request a refund of a balance currently attached to a customer identified by an attached card, confirming the initial request

Request method

HTTP POST

Security rights

BALANCE

See Also

Request entity: ConfirmRefundRequest

Response entity: none

Card

Provides functionality for managing cards.

/card/isCardValid

Check if the card is valid.

Request method

HTTP POST

Security rights

CHECK_CARD

See Also

Request entity: IsCardValidRequest

Response entity: IsCardValidResponse

/card/lockCard

Lock a Card based on its card identifier.

Request method

HTTP POST

Security rights

CONFIGURE_CARD

See Also

Request entity: LockCardRequest

Response entity: none

/card/getCardIdentifierByUid

Get the identifier of the card.

Request method

HTTP POST

Security rights

GET_CARDIDENTIFIER_BY_UID

See Also

Request entity: GetCardIdentifierRequest

Response entity: GetCardIdentifierResponse

/card/unlockCard

Unlock a Card based on its card identifier.

Request method

HTTP POST

Security rights

CONFIGURE_CARD

See Also

Request entity: UnLockCardRequest

Response entity: none

/card/getCardType

Get the cartype of a card based on the card identifier.

Request method

HTTP POST

Security rights

CHECK_CARD

See Also

Request entity: GetCardTypeRequest

Response entity: GetCardTypeResponse

/card/cardInfo

Get the info of the card based on the card identifier.

Request method

HTTP POST

Security rights

CHECK_CARD

See Also

Request entity: CardInfoRequest

Response entity: CardInfoResponse

/card/listCustomerCards

List the customer’s cards based on the customer Id.

Request method

HTTP POST

Security rights

CHECK_CARD

See Also

Request entity: ListCustomerCardsRequest

Response entity: ListCustomerCardsResponse

CardBackground

Provides functionality for card backgrounds.

/cardBackground/listCardBackgrounds

Lists the card backgrounds.

Request method

HTTP POST

Security rights

LIST_CARDBACKGROUNDS

See Also

Request entity: ListCardBackgroundRequest

Response entity: ListCardBackgroundResponse

Community

Provides functionality for communities.

/community/listCommunities

List all active communities.

Request method

HTTP GET

Security rights

LIST_COMMUNITIES

See Also

Request entity: none

Response entity: ListCommunitiesResponse

Coupon

Provides functionality for coupons.

/coupon/addCoupon

Add coupon to user but do not claim.

Request method

HTTP POST

Security rights

CONFIGURE_COUPON

See Also

Request entity: AddCouponRequest

Response entity: AssignCouponResponse

/coupon/claimCoupon

Claim a coupon.

Request method

HTTP POST

Security rights

CONFIGURE_COUPON

See Also

Request entity: ClaimCouponRequest

Response entity: ClaimCouponResponse

/coupon/assignCoupon

Assign a coupon to a user.

Request method

HTTP POST

Security rights

ASSIGN_COUPON

See Also

Request entity: AssignCouponRequest

Response entity: AssignCouponResponse

/coupon/assignCouponToGroup

Assign a coupon to a group.

Request method

HTTP POST

Security rights

ASSIGN_COUPON

See Also

Request entity: AssignCouponToGroupRequest

Response entity: AssignCouponToGroupResponse

/coupon/listCoupon

Find a list of coupons.

Request method

HTTP POST

Security rights

LIST_COUPONS

See Also

Request entity: ListCouponRequest

Response entity: ListCouponResponse

/coupon/listCouponAssignment

Find a list of coupon assignments.

Request method

HTTP POST

Security rights

LIST_COUPON_ASSIGNMENTS

See Also

Request entity: ListCouponAssignmentRequest

Response entity: ListCouponAssignmentResponse

/coupon/requestCouponAssignment

Request a coupon assignment.

Request method

HTTP POST

Security rights

LIST_COUPON_ASSIGNMENTS

See Also

Request entity: RequestCouponAssignmentRequest

Response entity: RequestCouponAssignmentResponse

Customer

Provides functionality for customers.

/customer/registerCustomer

Register a customer.

Request method

HTTP POST

Security rights

CONFIGURE_CUSTOMER

See Also

Request entity: RegisterCustomerRequest

Response entity: RegisterCustomerResponse

/customer/registerRaffleCustomer

Register a raffle customer as a new customer.

Request method

HTTP POST

Security rights

CONFIGURE_CUSTOMER

See Also

Request entity: RegisterCustomerRequest

Response entity: RegisterCustomerResponse

/customer/resetPassword

Reset the password of a customer by his/her identifier.

Request method

HTTP POST

Security rights

CONFIGURE_CUSTOMER

See Also

Request entity: ResetPasswordRequest

Response entity: none

/customer/changePassword

Change the password of a customer by his/her identifier.

Request method

HTTP POST

Security rights

CONFIGURE_CUSTOMER

See Also

Request entity: ChangePasswordRequest

Response entity: none

/customer/lockCustomer

Lock a customer.

Request method

HTTP POST

Security rights

CONFIGURE_CUSTOMER

See Also

Request entity: LockCustomerRequest

Response entity: none

/customer/cleanCustomer

Clean a customer.

Request method

HTTP POST

Security rights

CONFIGURE_CUSTOMER

See Also

Request entity: CleanCustomerRequest

Response entity: none

/customer/updateCustomer

Update a customer.

Request method

HTTP POST

Security rights

CONFIGURE_CUSTOMER

See Also

Request entity: UpdateCustomerRequest

Response entity: UpdateCustomerResponse

/customer/findCustomer

Find a customer.

Request method

HTTP POST

Security rights

LIST_CUSTOMERS

See Also

Request entity: FindCustomerRequest

Response entity: FindCustomerResponse

/customer/findCustomers

Find active customers.  Note we do not allow searching ALL users via communityID (too many returns)

Request method

HTTP POST

Security rights

LIST_CUSTOMERS

See Also

Request entity: FindCustomersRequest

Response entity: FindCustomersResponse

/customer/subscribeCustomer

Subscribes the user by it’s userIdentifier identifier.  <br/> The identifier can be an email address or a card.

Request method

HTTP POST

Security rights

CONFIGURE_CUSTOMER

See Also

Request entity: SubscribeCustomerRequest

Response entity: none

/customer/unsubscribeCustomer

Unsubscribes the user by it’s userIdentifier identifier.  <br/> The identifier can be an email address or a card.

Request method

HTTP POST

Security rights

CONFIGURE_CUSTOMER

See Also

Request entity: UnsubscribeCustomerRequest

Response entity: none

/customer/addCardToCustomer

Add a card to a customer.

Request method

HTTP POST

Security rights

CONFIGURE_CUSTOMER

See Also

Request entity: AddCardToCustomerRequest

Response entity: none

/customer/removeCardFromCustomer

Removes a card from a customer.

Request method

HTTP POST

Security rights

CONFIGURE_CUSTOMER

See Also

Request entity: RemoveCardFromCustomerRequest

Response entity: none

/customer/authenticateCustomer

Authenticate a customer.

Request method

HTTP POST

Security rights

CONFIGURE_CUSTOMER

See Also

Request entity: AuthenticateCustomerRequest

Response entity: AuthenticateCustomerResponse

/customer/mergeCustomers

Authenticate a customer.

Request method

HTTP POST

Security rights

CONFIGURE_CUSTOMER

See Also

Request entity: MergeCustomerRequest

Response entity: none

DeviceTheme

Provides functionality for DeviceTheme related actions.

/deviceTheme/getDeviceTheme

Retrieve the theme for a device

Request method

HTTP GET

Security rights

permitAll

See Also

Request entity: none

Response entity: GetDeviceThemeResponse

Gift

Provides functionality for gift related actions.

/gift/lock

Lock a gift.

Request method

HTTP POST

Security rights

CONFIGURE_GIFT

See Also

Request entity: LockGiftRequest

Response entity: none

/gift/claimGift

Claim a gift.

Request method

HTTP POST

Security rights

CLAIM_GIFT

See Also

Request entity: ClaimGiftRequest

Response entity: ClaimGiftResponse

/gift/claimGifts

Claim a list gift.

Request method

HTTP POST

Security rights

CLAIM_GIFT

See Also

Request entity: ClaimGiftsRequest

Response entity: none

/gift/issueGift

Issue a gift.

Request method

HTTP POST

Security rights

ISSUE_GIFT

See Also

Request entity: IssueGiftRequest

Response entity: IssueGiftResponse

/gift/issueGifts

Issue a list of gifts.

Request method

HTTP POST

Security rights

ISSUE_GIFT

See Also

Request entity: IssueGiftsRequest

Response entity: none

/gift/balance

Balance of a gift.

Request method

HTTP POST

Security rights

BALANCE

See Also

Request entity: BalanceGiftRequest

Response entity: BalanceGiftResponse

/gift/reversal

Reversal of a gift action.

Request method

HTTP POST

Security rights

BALANCE

See Also

Request entity: ReversalRequest

Response entity: none

/gift/createGift

Creation of a gift

Request method

HTTP POST

Security rights

CONFIGURE_GIFT

See Also

Request entity: CreateGiftRequest

Response entity: CreateGiftResponse

/gift/giftUpdatePincode

Update gift pincode

Request method

HTTP POST

Security rights

CONFIGURE_GIFT

See Also

Request entity: UpdateGiftPincodeRequest

Response entity: none

/gift/giftLinkCustomer

Link a gift to a customer

Request method

HTTP POST

Security rights

CONFIGURE_GIFT

See Also

Request entity: LinkGiftToCustomerRequest

Response entity: none

/gift/giftInfo

Retrieve information on a gift

Request method

HTTP POST

Security rights

BALANCE

See Also

Request entity: GiftInfoRequest

Response entity: GiftInfoResponse

/gift/balanceJSON

Balance of a gift.

Request method

HTTP POST

Security rights

BALANCE

See Also

Request entity: <String>

Response entity: BalanceGiftResponse

Loyalty

Provides functionality for loyalty.

/loyalty/loyaltyRewardRedeem

Find the reward list redeem rules.

Request method

HTTP POST

Security rights

REWARD

See Also

Request entity: RewardListRedeemRulesRequest

Response entity: RewardListRedeemRulesResponse

/loyalty/startLoyalty

Start a loyalty.

Request method

HTTP POST

Security rights

LOYALTY_START

See Also

Request entity: StartLoyaltyRequest

Response entity: StartLoyaltyResponse

Merchant

Provides functionality for merhcants.

/merchant/registerMerchant

Register a merchant.

Request method

HTTP POST

Security rights

CONFIGURE_MERCHANT

See Also

Request entity: RegisterMerchantRequest

Response entity: none

/merchant/listMerchant

Find a list of merchants.

Request method

HTTP POST

Security rights

LIST_MERCHANTS

See Also

Request entity: ListMerchantRequest

Response entity: ListMerchantResponse

/merchant/listProgramByMerchant

find a list of programs from a merchant.

Request method

HTTP POST

Security rights

LIST_PROGRAMS_BY_MERCHANT

See Also

Request entity: ListProgramByMerchantRequest

Response entity: ListProgramResponse

MerchantApplication

Provides functionality for merchantApplications.

/merchantApplication/merchantApplicationCreate

Create a merchant application.

Request method

HTTP POST

Security rights

CONFIGURE_MERCHANT

See Also

Request entity: MerchantApplicationCreateRequest

Response entity: none

/merchantApplication/merchantApplicationCheck

check a merchant application.

Request method

HTTP POST

Security rights

CONFIGURE_MERCHANT

See Also

Request entity: MerchantApplicationCheckRequest

Response entity: MerchantApplicationCheckResponse

Module

Provides functionality for module related actions.

/module/listModules

Find a list of modules.

Request method

HTTP GET

Security rights

LIST_MODULES

See Also

Request entity: none

Response entity: ListModulesResponse

Product

Provides functionality for products.

/product/listActiveProducts

Find a list of active products.

Request method

HTTP POST

Security rights

LIST_PRODUCTS

See Also

Request entity: none

Response entity: ListProductsResponse

/product/listProductImages

find a list of product images.

Request method

HTTP POST

Security rights

LIST_PRODUCTS

See Also

Request entity: ListProductImagesRequest

Response entity: ListProductImagesResponse

/product/listProductsByProgram

Find a list of products based on product Id.

Request method

HTTP POST

Security rights

LIST_PRODUCTS

See Also

Request entity: ListProductsByProgramRequest

Response entity: ListProductsResponse

Program

Provides functionality for programs.

/program/listActivePrograms

Find a list of active programs.

Request method

HTTP POST

Security rights

LIST_PROGRAMS

See Also

Request entity: none

Response entity: ListProgramResponse

/program/listGiftPrograms

find a list of issueable gift programs.

Request method

HTTP POST

Security rights

LIST_PROGRAMS

See Also

Request entity: none

Response entity: ListProgramResponse

Raffle

Provides functionality for raffle related actions.

/raffle/retrieveRaffleQuestions

Raffle Question Retrieval

Request method

HTTP POST

Security rights

RAFFLE_VALIDATION

See Also

Request entity: RaffleQuestionRetrievalRequest

Response entity: RaffleQuestionRetrievalResponse

/raffle/listRaffles

Call to lists all raffles the user is assigned for

Request method

HTTP POST

Security rights

RAFFLE_VALIDATION

See Also

Request entity: none

Response entity: ListRafflesResponse

/raffle/validateRaffleTicket

Raffle Ticket Validation

Request method

HTTP POST

Security rights

RAFFLE_VALIDATION

See Also

Request entity: RaffleTicketValidationRequest

Response entity: RaffleTicketValidationResponse

/raffle/validateRafflePrice

Raffle Price Validation

Request method

HTTP POST

Security rights

RAFFLE_PRICE

See Also

Request entity: RafflePriceValidationRequest

Response entity: RafflePriceValidationResponse

/raffle/claimRafflePrice

Raffle Price Claiming

Request method

HTTP POST

Security rights

RAFFLE_PRICE

See Also

Request entity: RaffleTicketValidationClaimRequest

Response entity: none

Redeem

Provides functionality for Redeeming.

/redeem/redeem

Redeem.

Request method

HTTP POST

Security rights

REDEEM

See Also

Request entity: RedeemRequest

Response entity: RedeemResponse

/redeem/listRules

List the redeem rules.

Request method

HTTP POST

Security rights

LIST_RULES

See Also

Request entity: ListRedeemRuleRequest

Response entity: ListRedeemRuleResponse

/redeem/rulesForMerchant

List the redeem rules of a merchant.

Request method

HTTP POST

Security rights

LIST_RULES_FOR_MERCHANT

See Also

Request entity: ListRuleForMerchantRequest

Response entity: ListRedeemRuleResponse

/redeem/listRedeemRules

List the redeem rules based on parameters from the RedeemRuleRequest.

Request method

HTTP POST

Security rights

LIST_RULES

See Also

Request entity: RedeemRuleRequest

Response entity: ListRedeemRuleResponse

Reverse

Provides functionality for reverses.

/reverse/reversal

Reverse a transaction.

Request method

HTTP POST

Security rights

TOPUP

See Also

Request entity: ReversalRequest

Response entity: none

Reward

Provides functionality for Rewarding.

/reward/reward

Reward.

Request method

HTTP POST

Security rights

REWARD

See Also

Request entity: RewardRequest

Response entity: RewardResponse

/reward/rulesForMerchant

List the reward rules of a merchant.

Request method

HTTP POST

Security rights

LIST_RULES_FOR_MERCHANT

See Also

Request entity: ListRuleForMerchantRequest

Response entity: ListRewardRuleResponse

/reward/listRewardRules

Find a list of reward rules based on a card.

Request method

HTTP POST

Security rights

LIST_RULES

See Also

Request entity: ListRuleForCardRequest

Response entity: ListRewardRuleResponse

Serial

Provides functionality for serials.

/serial/generateSerial

Generate a serial.

Request method

HTTP POST

Security rights

GENERATE_SERIAL

See Also

Request entity: none

Response entity: GenerateSerialResponse

Slide

Provides functionality for managing slides.

/slide/listCurrentSlides

Find a list of slides.

Request method

HTTP POST

Security rights

permitAll

See Also

Request entity: ListSlideRequest

Response entity: ListSlideResponse

stack

Provides functionality for creating and listing stacks.

/stack/relocateStack

Relocate a stack.

Request method

HTTP POST

Security rights

CONFIGURE_STACK

See Also

Request entity: RelocateStackRequest

Response entity: none

Statistics

Provides functionality for retrieving statistics

/statistics/statistics

Find a list of statistics.

Request method

HTTP POST

Security rights

LIST_TRANSACTIONS

See Also

Request entity: StatisticRequest

Response entity: StatisticResponse

TopDown

Provides functionality for TopDowning

/topdown/topDown

Top down.

Request method

HTTP POST

Security rights

TOPDOWN

See Also

Request entity: TopDownRequest

Response entity: TopDownResponse

/topdown/topDownProduct

Top down product.

Request method

HTTP POST

Security rights

TOPDOWN

See Also

Request entity: TopDownRequest

Response entity: TopDownProductResponse

TopUp

The Class TopUpResource.

/topup/topUp

Top up

Request method

HTTP POST

Security rights

TOPUP

See Also

Request entity: TopUpRequest

Response entity: TopUpResponse

User

Provides functionality for managing users.

/user/lockUser

Lock a user.

Request method

HTTP POST

Security rights

CONFIGURE_USER

See Also

Request entity: LockUserRequest

Response entity: none

/user/authenticateUser

Authenticate a user.

Request method

HTTP POST

Security rights

AUTHENTICATE_USER

See Also

Request entity: AuthenticateUserRequest

Response entity: AuthenticateUserResponse

/user/findUser

Find a user.

Request method

HTTP POST

Security rights

LIST_USERS

See Also

Request entity: FindUserRequest

Response entity: FindUserResponse

/user/findUsers

Find users.

Request method

HTTP POST

Security rights

LIST_USERS

See Also

Request entity: FindUsersRequest

Response entity: FindUsersResponse

Video

Provides functionality for managing videos.

/video/listCurrentVideos

Find a list of videos.

Request method

HTTP POST

Security rights

permitAll

See Also

Request entity: ListVideoRequest

Response entity: ListVideoResponse

Close