Version v2.30
JPurse API Documentation | |
API Reference | |
API Libraries | |
Authentication | |
Errors | |
URLs | |
ISB | Provides functionality for ISB Golf Club integration. |
//json/ | |
//json/ | |
//json/ | |
//json/ | |
//json/ | |
//json/ | |
//json/ | |
//json/ | |
//json/ | |
//json/ | |
//json/ | Lock a gift. |
//json/ | |
emoney | Provides functionality for starting performing PSP actions. |
/PSP/ | Get current active available payment methodes |
/PSP/ | Start a PSP payment in order to use a customers account to end up topping up his er her balance. |
/PSP/ | Start a PSP payment in order to use a customers account to end up topping up his er her balance. |
About | Provides functionality for getting deployment information. |
/about/ | Returns information about the backend such as version. |
Authentication | Provides functionality for authentication. |
/authentication/ | Authenticate. |
/authentication/ | Authenticate a device. |
/authentication/ | List all the rights. |
Balance | Provides functionality for viewing balance related information of a customer. |
/balance/ | Show the current balance of a customer |
/balance/ | Shows the transactions of the balance history for a custom, device or program |
/balance/ | Request a refund of a balance currently attached to a customer identified by an attached card |
/balance/ | Request a refund of a balance currently attached to a customer identified by an attached card, confirming the initial request |
Card | Provides functionality for managing cards. |
/card/ | Check if the card is valid. |
/card/ | Lock a Card based on its card identifier. |
/card/ | Get the identifier of the card. |
/card/ | Unlock a Card based on its card identifier. |
/card/ | Get the cartype of a card based on the card identifier. |
/card/ | Get the info of the card based on the card identifier. |
/card/ | List the customer’s cards based on the customer Id. |
CardBackground | Provides functionality for card backgrounds. |
/cardBackground/ | Lists the card backgrounds. |
Community | Provides functionality for communities. |
/community/ | List all active communities. |
Coupon | Provides functionality for coupons. |
/coupon/ | Add coupon to user but do not claim. |
/coupon/ | Claim a coupon. |
/coupon/ | Assign a coupon to a user. |
/coupon/ | Assign a coupon to a group. |
/coupon/ | Find a list of coupons. |
/coupon/ | Find a list of coupon assignments. |
/coupon/ | Request a coupon assignment. |
Customer | Provides functionality for customers. |
/customer/ | Register a customer. |
/customer/ | Register a raffle customer as a new customer. |
/customer/ | Reset the password of a customer by his/her identifier. |
/customer/ | Change the password of a customer by his/her identifier. |
/customer/ | Lock a customer. |
/customer/ | Clean a customer. |
/customer/ | Update a customer. |
/customer/ | Find a customer. |
/customer/ | Find active customers |
/customer/ | Subscribes the user by it’s userIdentifier identifier |
/customer/ | Unsubscribes the user by it’s userIdentifier identifier |
/customer/ | Add a card to a customer. |
/customer/ | Removes a card from a customer. |
/customer/ | Authenticate a customer. |
/customer/ | Authenticate a customer. |
DeviceTheme | Provides functionality for DeviceTheme related actions. |
/deviceTheme/ | Retrieve the theme for a device |
Gift | Provides functionality for gift related actions. |
/gift/ | Lock a gift. |
/gift/ | Claim a gift. |
/gift/ | Claim a list gift. |
/gift/ | Issue a gift. |
/gift/ | Issue a list of gifts. |
/gift/ | Balance of a gift. |
/gift/ | Reversal of a gift action. |
/gift/ | Creation of a gift |
/gift/ | Update gift pincode |
/gift/ | Link a gift to a customer |
/gift/ | Retrieve information on a gift |
/gift/ | Balance of a gift. |
Loyalty | Provides functionality for loyalty. |
/loyalty/ | Find the reward list redeem rules. |
/loyalty/ | Start a loyalty. |
Merchant | Provides functionality for merhcants. |
/merchant/ | Register a merchant. |
/merchant/ | Find a list of merchants. |
/merchant/ | find a list of programs from a merchant. |
MerchantApplication | Provides functionality for merchantApplications. |
/merchantApplication/ | Create a merchant application. |
/merchantApplication/ | check a merchant application. |
Module | Provides functionality for module related actions. |
/module/ | Find a list of modules. |
Product | Provides functionality for products. |
/product/ | Find a list of active products. |
/product/ | find a list of product images. |
/product/ | Find a list of products based on product Id. |
Program | Provides functionality for programs. |
/program/ | Find a list of active programs. |
/program/ | find a list of issueable gift programs. |
Raffle | Provides functionality for raffle related actions. |
/raffle/ | Raffle Question Retrieval |
/raffle/ | Call to lists all raffles the user is assigned for |
/raffle/ | Raffle Ticket Validation |
/raffle/ | Raffle Price Validation |
/raffle/ | Raffle Price Claiming |
Redeem | Provides functionality for Redeeming. |
/redeem/ | Redeem. |
/redeem/ | List the redeem rules. |
/redeem/ | List the redeem rules of a merchant. |
/redeem/ | List the redeem rules based on parameters from the RedeemRuleRequest. |
Reverse | Provides functionality for reverses. |
/reverse/ | Reverse a transaction. |
Reward | Provides functionality for Rewarding. |
/reward/ | Reward. |
/reward/ | List the reward rules of a merchant. |
/reward/ | Find a list of reward rules based on a card. |
Serial | Provides functionality for serials. |
/serial/ | Generate a serial. |
Slide | Provides functionality for managing slides. |
/slide/ | Find a list of slides. |
stack | Provides functionality for creating and listing stacks. |
/stack/ | Relocate a stack. |
Statistics | Provides functionality for retrieving statistics |
/statistics/ | Find a list of statistics. |
TopDown | Provides functionality for TopDowning |
/topdown/ | Top down. |
/topdown/ | Top down product. |
TopUp | The Class TopUpResource. |
/topup/ | Top up |
User | Provides functionality for managing users. |
/user/ | Lock a user. |
/user/ | Authenticate a user. |
/user/ | Find a user. |
/user/ | Find users. |
Video | Provides functionality for managing videos. |
/video/ | Find a list of videos. |
The API is organized around HTTP and Protocol Buffers.
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.
Requests and responses are serialized using Protocol Buffers, including errors -- think XML, but smaller, faster, and simpler.
There are lots of pre-built libraries for interacting with JPurse.
JPurse uses conventional HTTP response codes to indicate success or failure of a request.
200, 204 OK | Everything worked as expected. |
400 Bad Request | Often missing a required parameter, or parameters were valid but request failed. For all bad requests, we return a FaultResponse. |
401 Unauthorized | No valid authentication credentials provided. |
404 Not Found | The requested item doesn’t exist. |
500, 502, 503, 504 Server errors | Something went wrong on JPurse’s end. |
HTTP POST
BALANCE
Request entity: <String>
Response entity: BalanceResponse
HTTP POST
BALANCE
Request entity: <String>
Response entity: BalanceHistoryResponse
HTTP GET
CONFIGURE_USER
Request entity: none
Response entity: FindCustomerResponse
HTTP POST
LIST_MERCHANTS
Request entity: none
Response entity: ListProgramResponse
Get current active available payment methodes
HTTP POST
TOPUP
Request entity: <RetrievePaymentMethodsRequest>
Response entity: GetPSPPaymentMethodResponse
Start a PSP payment in order to use a customers account to end up topping up his er her balance.
HTTP POST
TOPUP
Request entity: StartPSPPaymentRequest
Response entity: StartPSPPaymentResponse
Start a PSP payment in order to use a customers account to end up topping up his er her balance.
HTTP POST
TOPUP
Request entity: RetrievePSPPaymentsRequest
Response entity: RetrievePSPPaymentsResponse
Returns information about the backend such as version.
HTTP GET
ABOUT
Request entity: none
Response entity: AboutResponse
Authenticate a device.
HTTP POST
permitAll
Request entity: AuthenticateDeviceRequest
Response entity: AuthenticateDeviceResponse
List all the rights.
HTTP POST
permitAll
Request entity: none
Response entity: ListRightsResponse
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.
HTTP POST
BALANCE
Request entity: BalanceRequest
Response entity: BalanceResponse
Shows the transactions of the balance history for a custom, device or program. Every transaction shows how the balance was updated.
HTTP POST
BALANCE
Request entity: BalanceHistoryRequest
Response entity: BalanceHistoryResponse
Request a refund of a balance currently attached to a customer identified by an attached card
HTTP POST
BALANCE
Request entity: RequestRefundRequest
Response entity: RequestRefundResponse
Request a refund of a balance currently attached to a customer identified by an attached card, confirming the initial request
HTTP POST
BALANCE
Request entity: ConfirmRefundRequest
Response entity: none
Check if the card is valid.
HTTP POST
CHECK_CARD
Request entity: IsCardValidRequest
Response entity: IsCardValidResponse
Lock a Card based on its card identifier.
HTTP POST
CONFIGURE_CARD
Request entity: LockCardRequest
Response entity: none
Get the identifier of the card.
HTTP POST
GET_CARDIDENTIFIER_BY_UID
Request entity: GetCardIdentifierRequest
Response entity: GetCardIdentifierResponse
Unlock a Card based on its card identifier.
HTTP POST
CONFIGURE_CARD
Request entity: UnLockCardRequest
Response entity: none
Get the cartype of a card based on the card identifier.
HTTP POST
CHECK_CARD
Request entity: GetCardTypeRequest
Response entity: GetCardTypeResponse
Get the info of the card based on the card identifier.
HTTP POST
CHECK_CARD
Request entity: CardInfoRequest
Response entity: CardInfoResponse
List the customer’s cards based on the customer Id.
HTTP POST
CHECK_CARD
Request entity: ListCustomerCardsRequest
Response entity: ListCustomerCardsResponse
Lists the card backgrounds.
HTTP POST
LIST_CARDBACKGROUNDS
Request entity: ListCardBackgroundRequest
Response entity: ListCardBackgroundResponse
List all active communities.
HTTP GET
LIST_COMMUNITIES
Request entity: none
Response entity: ListCommunitiesResponse
Add coupon to user but do not claim.
HTTP POST
CONFIGURE_COUPON
Request entity: AddCouponRequest
Response entity: AssignCouponResponse
Claim a coupon.
HTTP POST
CONFIGURE_COUPON
Request entity: ClaimCouponRequest
Response entity: ClaimCouponResponse
Assign a coupon to a user.
HTTP POST
ASSIGN_COUPON
Request entity: AssignCouponRequest
Response entity: AssignCouponResponse
Assign a coupon to a group.
HTTP POST
ASSIGN_COUPON
Request entity: AssignCouponToGroupRequest
Response entity: AssignCouponToGroupResponse
Find a list of coupons.
HTTP POST
LIST_COUPONS
Request entity: ListCouponRequest
Response entity: ListCouponResponse
Find a list of coupon assignments.
HTTP POST
LIST_COUPON_ASSIGNMENTS
Request entity: ListCouponAssignmentRequest
Response entity: ListCouponAssignmentResponse
Request a coupon assignment.
HTTP POST
LIST_COUPON_ASSIGNMENTS
Request entity: RequestCouponAssignmentRequest
Response entity: RequestCouponAssignmentResponse
Register a customer.
HTTP POST
CONFIGURE_CUSTOMER
Request entity: RegisterCustomerRequest
Response entity: RegisterCustomerResponse
Register a raffle customer as a new customer.
HTTP POST
CONFIGURE_CUSTOMER
Request entity: RegisterCustomerRequest
Response entity: RegisterCustomerResponse
Reset the password of a customer by his/her identifier.
HTTP POST
CONFIGURE_CUSTOMER
Request entity: ResetPasswordRequest
Response entity: none
Change the password of a customer by his/her identifier.
HTTP POST
CONFIGURE_CUSTOMER
Request entity: ChangePasswordRequest
Response entity: none
Lock a customer.
HTTP POST
CONFIGURE_CUSTOMER
Request entity: LockCustomerRequest
Response entity: none
Clean a customer.
HTTP POST
CONFIGURE_CUSTOMER
Request entity: CleanCustomerRequest
Response entity: none
Update a customer.
HTTP POST
CONFIGURE_CUSTOMER
Request entity: UpdateCustomerRequest
Response entity: UpdateCustomerResponse
Find a customer.
HTTP POST
LIST_CUSTOMERS
Request entity: FindCustomerRequest
Response entity: FindCustomerResponse
Find active customers. Note we do not allow searching ALL users via communityID (too many returns)
HTTP POST
LIST_CUSTOMERS
Request entity: FindCustomersRequest
Response entity: FindCustomersResponse
Subscribes the user by it’s userIdentifier identifier. <br/> The identifier can be an email address or a card.
HTTP POST
CONFIGURE_CUSTOMER
Request entity: SubscribeCustomerRequest
Response entity: none
Unsubscribes the user by it’s userIdentifier identifier. <br/> The identifier can be an email address or a card.
HTTP POST
CONFIGURE_CUSTOMER
Request entity: UnsubscribeCustomerRequest
Response entity: none
Add a card to a customer.
HTTP POST
CONFIGURE_CUSTOMER
Request entity: AddCardToCustomerRequest
Response entity: none
Removes a card from a customer.
HTTP POST
CONFIGURE_CUSTOMER
Request entity: RemoveCardFromCustomerRequest
Response entity: none
Authenticate a customer.
HTTP POST
CONFIGURE_CUSTOMER
Request entity: AuthenticateCustomerRequest
Response entity: AuthenticateCustomerResponse
Authenticate a customer.
HTTP POST
CONFIGURE_CUSTOMER
Request entity: MergeCustomerRequest
Response entity: none
Retrieve the theme for a device
HTTP GET
permitAll
Request entity: none
Response entity: GetDeviceThemeResponse
Lock a gift.
HTTP POST
CONFIGURE_GIFT
Request entity: LockGiftRequest
Response entity: none
Claim a gift.
HTTP POST
CLAIM_GIFT
Request entity: ClaimGiftRequest
Response entity: ClaimGiftResponse
Claim a list gift.
HTTP POST
CLAIM_GIFT
Request entity: ClaimGiftsRequest
Response entity: none
Issue a gift.
HTTP POST
ISSUE_GIFT
Request entity: IssueGiftRequest
Response entity: IssueGiftResponse
Issue a list of gifts.
HTTP POST
ISSUE_GIFT
Request entity: IssueGiftsRequest
Response entity: none
Balance of a gift.
HTTP POST
BALANCE
Request entity: BalanceGiftRequest
Response entity: BalanceGiftResponse
Reversal of a gift action.
HTTP POST
BALANCE
Request entity: ReversalRequest
Response entity: none
Creation of a gift
HTTP POST
CONFIGURE_GIFT
Request entity: CreateGiftRequest
Response entity: CreateGiftResponse
Update gift pincode
HTTP POST
CONFIGURE_GIFT
Request entity: UpdateGiftPincodeRequest
Response entity: none
Link a gift to a customer
HTTP POST
CONFIGURE_GIFT
Request entity: LinkGiftToCustomerRequest
Response entity: none
Retrieve information on a gift
HTTP POST
BALANCE
Request entity: GiftInfoRequest
Response entity: GiftInfoResponse
Balance of a gift.
HTTP POST
BALANCE
Request entity: <String>
Response entity: BalanceGiftResponse
Find the reward list redeem rules.
HTTP POST
REWARD
Request entity: RewardListRedeemRulesRequest
Response entity: RewardListRedeemRulesResponse
Start a loyalty.
HTTP POST
LOYALTY_START
Request entity: StartLoyaltyRequest
Response entity: StartLoyaltyResponse
Register a merchant.
HTTP POST
CONFIGURE_MERCHANT
Request entity: RegisterMerchantRequest
Response entity: none
Find a list of merchants.
HTTP POST
LIST_MERCHANTS
Request entity: ListMerchantRequest
Response entity: ListMerchantResponse
find a list of programs from a merchant.
HTTP POST
LIST_PROGRAMS_BY_MERCHANT
Request entity: ListProgramByMerchantRequest
Response entity: ListProgramResponse
Create a merchant application.
HTTP POST
CONFIGURE_MERCHANT
Request entity: MerchantApplicationCreateRequest
Response entity: none
check a merchant application.
HTTP POST
CONFIGURE_MERCHANT
Request entity: MerchantApplicationCheckRequest
Response entity: MerchantApplicationCheckResponse
Find a list of modules.
HTTP GET
LIST_MODULES
Request entity: none
Response entity: ListModulesResponse
Find a list of active products.
HTTP POST
LIST_PRODUCTS
Request entity: none
Response entity: ListProductsResponse
find a list of product images.
HTTP POST
LIST_PRODUCTS
Request entity: ListProductImagesRequest
Response entity: ListProductImagesResponse
Find a list of products based on product Id.
HTTP POST
LIST_PRODUCTS
Request entity: ListProductsByProgramRequest
Response entity: ListProductsResponse
Find a list of active programs.
HTTP POST
LIST_PROGRAMS
Request entity: none
Response entity: ListProgramResponse
find a list of issueable gift programs.
HTTP POST
LIST_PROGRAMS
Request entity: none
Response entity: ListProgramResponse
Raffle Question Retrieval
HTTP POST
RAFFLE_VALIDATION
Request entity: RaffleQuestionRetrievalRequest
Response entity: RaffleQuestionRetrievalResponse
Call to lists all raffles the user is assigned for
HTTP POST
RAFFLE_VALIDATION
Request entity: none
Response entity: ListRafflesResponse
Raffle Ticket Validation
HTTP POST
RAFFLE_VALIDATION
Request entity: RaffleTicketValidationRequest
Response entity: RaffleTicketValidationResponse
Raffle Price Validation
HTTP POST
RAFFLE_PRICE
Request entity: RafflePriceValidationRequest
Response entity: RafflePriceValidationResponse
Raffle Price Claiming
HTTP POST
RAFFLE_PRICE
Request entity: RaffleTicketValidationClaimRequest
Response entity: none
Redeem.
HTTP POST
REDEEM
Request entity: RedeemRequest
Response entity: RedeemResponse
List the redeem rules.
HTTP POST
LIST_RULES
Request entity: ListRedeemRuleRequest
Response entity: ListRedeemRuleResponse
List the redeem rules of a merchant.
HTTP POST
LIST_RULES_FOR_MERCHANT
Request entity: ListRuleForMerchantRequest
Response entity: ListRedeemRuleResponse
List the redeem rules based on parameters from the RedeemRuleRequest.
HTTP POST
LIST_RULES
Request entity: RedeemRuleRequest
Response entity: ListRedeemRuleResponse
Reverse a transaction.
HTTP POST
TOPUP
Request entity: ReversalRequest
Response entity: none
Reward.
HTTP POST
REWARD
Request entity: RewardRequest
Response entity: RewardResponse
List the reward rules of a merchant.
HTTP POST
LIST_RULES_FOR_MERCHANT
Request entity: ListRuleForMerchantRequest
Response entity: ListRewardRuleResponse
Find a list of reward rules based on a card.
HTTP POST
LIST_RULES
Request entity: ListRuleForCardRequest
Response entity: ListRewardRuleResponse
Generate a serial.
HTTP POST
GENERATE_SERIAL
Request entity: none
Response entity: GenerateSerialResponse
Find a list of slides.
HTTP POST
permitAll
Request entity: ListSlideRequest
Response entity: ListSlideResponse
Relocate a stack.
HTTP POST
CONFIGURE_STACK
Request entity: RelocateStackRequest
Response entity: none
Find a list of statistics.
HTTP POST
LIST_TRANSACTIONS
Request entity: StatisticRequest
Response entity: StatisticResponse
Top down.
HTTP POST
TOPDOWN
Request entity: TopDownRequest
Response entity: TopDownResponse
Top down product.
HTTP POST
TOPDOWN
Request entity: TopDownRequest
Response entity: TopDownProductResponse
Top up
HTTP POST
TOPUP
Request entity: TopUpRequest
Response entity: TopUpResponse
Lock a user.
HTTP POST
CONFIGURE_USER
Request entity: LockUserRequest
Response entity: none
Authenticate a user.
HTTP POST
AUTHENTICATE_USER
Request entity: AuthenticateUserRequest
Response entity: AuthenticateUserResponse
Find a user.
HTTP POST
LIST_USERS
Request entity: FindUserRequest
Response entity: FindUserResponse
Find users.
HTTP POST
LIST_USERS
Request entity: FindUsersRequest
Response entity: FindUsersResponse
Find a list of videos.
HTTP POST
permitAll
Request entity: ListVideoRequest
Response entity: ListVideoResponse