Jump to Content
Documentation
API Reference
Recipes
Home
Documentation
API Reference
v2.0.1
Documentation
API Reference
Recipes
API Reference
Bachmanity
API Reference
OAuth 2.0
All
Pages
Start typing to search…
JUMP TO
HIPS API REFERENCE
Introduction
Authentication
HTTP Basic Access Auth
Token Bearer Authentication
OAuth 2.0
Key Management
Location Headers
Metadata
Webhooks
Configuring your webhook settings
Validating Webhooks
Idempotent Requests
Request IDs
Response and Error Codes
Pagination
Testing
Try LIVE in browser
Test card numbers
HIPS API
loyalty
Spend tokens (debit)
post
Credit tokens
post
Show statement
get
Show balance
get
Enroll customer
post
Show Loyalty Program
get
Create Loyalty Program
post
partners
Payments Report
get
List terminals in estate
get
List estates
get
Create terminal
post
Connect terminal to merchant
post
List merchant terminals
get
Start onboarding
put
Create gateway credentials
post
Show a merchant
get
List merchants
get
Create a new merchant
post
Create Sales Channel as partner
post
Activate a merchant
post
Activate a merchant
post
orders
Cancel recurring contract
del
Abort Order (or QR session)
del
Revoke/Refund Order
patch
Add TIP to Order
patch
Fulfill an order
patch
Update Order
patch
View Order
get
Create Order
post
payouts
View a payout
get
Lists all payouts on a specific merchant
get
tokens
Card Tokenization Verification
post
Card Tokenization
post
payments
Capture payment
patch
Refund or Void a payment
patch
View a payment
get
Capture EMV payment
patch
Refund or Void a EMV payment
patch
Upload batch of offline EMV transactions
post
Reversal of EMV payment
post
List a EMV payments on a specific terminal
get
Create a EMV payment
post
View EMV payment on specific terminal
get
Lists all payments on a specific merchant
get
Create a payment
post
qrs
Generate a Dynamic QR Code
post
Connect a Static QR Code
patch
Create Static QR Code
post
sales_channel
Create Sales Channel
post
onboarding
Delete owner
del
Add owner
post
Upload selfie (biometric)
post
Upload identification document
post
Update onboarding dossier
patch
Show onboarding dossier
get
Powered by
OAuth 2.0
Ask AI
For application developers
