Product List

Description Getting permission list Request Path {{base_url}}/stores/terminal-permissions/ Reversible No 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 Required id Permission id Yes product_detail Details of […]

Terminal Transactions

Description Getting terminal transactions list Request Path {{base_url}}/stores/terminal-transactions/ Reversible No 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 […]

Check Token

Description Getting token for authentication of the POS store  Request Path {{base_url}}/stores/token-check/ Reversible Yes Method Post Usage          This method is called to ensure the token is correct.

Profile

Description Getting store profile Request Path {{base_url}}/stores/terminal-info/{{terminal_id}}/ Reversible No Method Get  Usage          This method is called for getting the store profile. Request Parameters Parameter Data Type Position Required Description  terminal_id String URL Yes Store Terminal id Response Parameters Parameter Description Required id Terminal id Yes store_name Store name Yes store_timezone Store timezone Yes store_avatar Store […]

Card Transaction List

Description Getting all transactions’ store list based on barcode Request Path {{base_url}}/stores/transaction-list/{{barcode}}/ Reversible No Method Get Usage          This method is called to get all card transactions. Request Parameters Parameter Data Type Position Required Description  barcode String URL Yes 30 digit number Response Parameters Parameter Description Required status Transaction status Yes status_code Status code Yes amount […]

Check Transaction

Description Checking transactions Request Path {{base_url}}/stores/transaction-check/{{transaction_id}}/ Reversible Yes 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  transaction_id String […]

Redeem Card

Description Using card  Request Path {{base_url}}/stores/card-redeem/ Reversible Yes 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  terminal_id Integer Body Yes Store Terminal id terminal_pin String Body No Terminal user password card_pin […]

Check Card

Description Checking the card based on pin or pan  Request Path {{base_url}}/stores/card-check/ Reversible Yes 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 […]

Authenticate

Description Getting token for authentication  Request Path {{base_url}}/stores/token-obtain/ Reversible Yes 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 Provided by HiGift secret_key String Body […]