Distributor APIs
Authenticate
Last Updated: April 28, 2026Description Getting token for authentication of the POS dealer Request Path {{base_url}}/dealers/token-obtain/ Method Post Usage An access token provides access to the HiPin API for a specified amount of time. When the access token expires, clients must authenticate again. Request Parameters Parameter Data Type Position Required Description distributor_id Integer Body Yes Client ID (Provided by...
Profile
Last Updated: July 4, 2021Description Getting distributor POS profile Request Path {{base_url}}/dealers/terminal-info/{{terminal_id}}/ Method Get Usage This method is called for getting the distributor profile. Request Parameters Parameter Data Type Position Required Description terminal_id String URL Yes Distributor Terminal id Response Parameters Parameter Description Required id Terminal id Yes distributor_name Distributor name Yes distributor_timezone Distributor time zone Yes distributor_avatar Distributor...
Terminal Transactions
Last Updated: July 6, 2021Description Getting terminal transactions list Request Path {{base_url}}/dealers/terminal-transactions/ Method Get Usage This method is called for getting all transactions done in the distributors 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} limit Integer Query Parameters No...
Product List
Last Updated: July 6, 2021Description Getting permission list (digital products which you make an order of them) Request Path {{base_url}}/dealers/terminal-permissions/ Method Get Usage This method is called for getting all permissions (available digital products) for terminals. Request Parameters Parameter Data Type Position Required Description Authorization String Header Yes Used retrieving token in a header: Authorization: JWT {token} limit Integer...
Check Card
Last Updated: July 6, 2021Description Checking card by POS dealer Request Path {{base_url}}/dealers/card-check/{{barcode}}/ Method Get Usage Clients can check card status by using the card’s PAN (barcode) on the back of the card. 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...
Card Transaction List
Last Updated: July 6, 2021Description Getting all transaction list Request Path {{base_url}}/dealers/transaction-list/{{barcode_id}}/ 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 Description Nullable count Number...
Check Transaction
Last Updated: July 6, 2021Description Checking transaction Request Path {{base_url}}/dealers/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...
Active Card
Last Updated: July 6, 2021Description Activating card by POS dealer Request Path {{base_url}}/dealers/card-activate/ Method Post Usage This method is called for activating a card by POS dealer. 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 Store Terminal id terminal_pin String Body No...
Charge Card
Last Updated: July 6, 2021Description Charging card by POS dealer Request Path {{base_url}}/dealers/card-charge/ Method Post Usage This method is called for charging a physical card. A card which is reusable, can charge. 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 Store Terminal...
Deactivate Card
Last Updated: July 6, 2021Description Deactivating card by POS dealer Request Path {{base_url}}/dealers/card-deactivate/ Method Post Usage This method is called for deactivating physical cards. A card which doesn’t have any redeem transaction, can deactivate. 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...
Create Digital Order
Last Updated: April 28, 2026Description Getting digital order Request Path {{base_url}}/dealers/orders/ Method Post Usage This method creates a digital order. Request Parameters Parameter Data Type Position Required Description Authorization String Header Yes Used retrieving token in a header: Authorization: JWT {token} count Integer Body Yes Number of cards description String Body Yes Information about order transaction_id String Body No...
Digital Order
Last Updated: July 6, 2021Description Getting digital order Request Path {{base_url}}/dealers/orders/ Method Get Usage This method is called for getting all the digital orders. 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 id Order id No status_display Showing status of order...
Digital Order Card
Last Updated: October 3, 2024Description Getting digital order Request Path {{base_url}}/dealers/terminal-cards/ Method Get Usage This method is called to get the list of cards. Parameter Data Type Position Required Description Authorization String Header Yes Used retrieving token in a header: Authorization: JWT {token} transaction_id String URL Yes Order Transaction ID Response Parameters Parameter Description Nullable count Number of products ...