Store APIs
Authenticate
Last Updated: April 28, 2026Description Getting token for authentication Request Path {{base_url}}/stores/token-obtain/ Method Post Usage An access token provides access to the HiGift API for a specified amount of time. When the access token expires, clients must authenticate again. Request Parameters Parameter Data Type Position Required Description store_id Integer Body Yes Client ID (Provided by HiPin) secret_key String Body...
Profile
Last Updated: July 6, 2021Description Getting store profile Request Path {{base_url}}/stores/terminal-info/{{terminal_id}}/ Method Get Usage This method is called for getting the store profile. Request Parameters Parameter Data Type Position Required Description Authorization String Header Yes Used retrieving token in a header: Authorization: JWT {token} terminal_id String URL Yes Store Terminal id Response Parameters Parameter Description Nullable id Terminal id...
Terminal Transactions
Last Updated: July 6, 2021Description Getting terminal transactions list Request Path {{base_url}}/stores/terminal-transactions/ Method Get Usage This method is called for getting all transactions done in the store based card details and product details. Request Parameters Parameter Data Type Position Required Description Authorization String Header Yes Used retrieving token in a header: Authorization: JWT {token} Response Parameters Parameter Description Nullable ...
Product List
Last Updated: November 22, 2022Description Getting permission list Request Path {{base_url}}/stores/terminal-permissions/ Method Get Usage This method is called for getting all permissions for terminals. Request Parameters Parameter Data Type Position Required Description Authorization String Header Yes Used retrieving token in a header: Authorization: JWT {token} Response Parameters Parameter Description Nullable count Number of permissions Yes next Next permission Yes ...
Check Card
Last Updated: July 6, 2021Description Checking the card based on pin or pan Request Path {{base_url}}/stores/card-check/ Method Post Usage Clients can check card status by using the card’s PAN (barcode) on the back of the physical card. Or they can do it by using the card’s PIN and PAN or PIN and brand ID. Request Parameters Parameter Data Type...
Card Transaction List
Last Updated: July 6, 2021Description Getting all transactions’ store list based on barcode Request Path {{base_url}}/stores/transaction-list/{{barcode}}/ Method Get Usage This method is called to get all card transactions. Request Parameters Parameter Data Type Position Required Description Authorization String Header Yes Used retrieving token in a header: Authorization: JWT {token} barcode String URL Yes 30 digit number Response Parameters Parameter...
Check Transaction
Last Updated: July 6, 2021Description Checking transactions Request Path {{base_url}}/stores/transaction-check/{{transaction_id}}/ Method Get Usage Clients can check a transaction status by sending its transaction_id, which is generated in the Redeem API. If the redeem process had been failed, the response to this API would be 404 Not Found. Request Parameters Parameter Data Type Position Required Description Authorization String Header Yes...
Redeem Card
Last Updated: July 6, 2021Description Using card Request Path {{base_url}}/stores/card-redeem/ Method Post Usage Client can redeem card using PIN on the back of the physical card. Product ID must retrieve from check API first. Request Parameters Parameter Data Type Position Required Description Authorization String Header Yes Used retrieving token in a header: Authorization: JWT {token} terminal_id Integer Body Yes...