Jump to Content
API Reference
v1.0
Log In
API Reference
Log In
v1.0
API Reference
Authentication Flow
All
Pages
Start typing to search…
JUMP TO
IBEX Hub API
Welcome!
Quick Start
Sandbox vs. Production
Postman
🖥️
Hub Console
Authentication
🔏
Authentication Flow
🔐
Access Token
🔓
Making Authenticated Requests
Accounts
Description
Create Account
post
Get Account
All Accounts V2
get
All Accounts v1
get
Account Details
get
Update Account
put
Webhooks
Get Account Webhook
get
Create Account Webhook
post
Update Account Webhook
put
Delete Account Webhook
del
Trigger Transaction Webhook
get
Transactions
Description
Account Transactions
get
Transaction Details
get
Transaction Types
get
Onchain
OnChain Transactions
Generate Bitcoin Address
post
Send to Address V2
post
Send to Address v1
post
Estimate Fee V2
get
Estimate Fee v1
get
Get Onchain Transaction (v1)
get
Lightning Network
The Lightning Network (LN)
Lightning Invoices
Flow
Add Invoice V2
post
Add Invoice with a mSat amount
post
Get Invoice
Invoice From bolt11
get
Invoice From Hash
get
Delete Invoice From bolt11
del
Lightning Payments
Flow
Pay Invoice V2
post
Pay Invoice specifying a mSat amount
post
Decode invoice
get
Payment estimation
get
Get Payment
From hash
get
From Bolt11
get
Payment splits
Create Splits
post
Get Splits
Get all Splits
get
Get a single Split
get
Update Splits
Update all Splits
put
Update a single Split
put
Delete Splits
Delete all Splits
del
Delete a single Split
del
Get Split Destinations
get
LNURL - Decode
Decode LNURL
get
LNURL - pay
Flow
Create LNURL-pay
post
Pay to a LNURL-pay
post
Invoice requirements
get
Bolt11
get
LNURL-pay status
get
All LNURL-pay
get
LNURL - withdraw
Flow
Create LNURL-withdraw
post
Withdraw from a LNURL-withdraw
post
Invoice requirements
get
Pay invoice
get
LNURL-Withdraw Status
get
All LNURL-withdraws
get
Cancel a LNURL-withdraw
del
Lightning Address
Create a Lightning Address
post
All Lightning Addresses
get
Bolt11
get
Update Lightning Address
put
Lightning Address
del
Pay to Lightning Address
Custom Lightning Address
Currencies
All Currencies
get
Rates V2
get
Rates (deprecated)
get
IBEXPay API
Link to IBEXPay API docs
HUB API.
Countries
Get all countries
get
Fiat On : Off Ramp
On Ramp
Get Available On Ramps (Combinations)
get
Create Deposit information
post
Account Deposit info
put
Deposit info Details
get
Update Deposit info Details
put
Archive Deposit info
del
Restore Deposit info
patch
Off Ramp
Get Available Off Ramps (Combinations)
get
Requirement By ID
get
Beneficiaries
Create Beneficiary
post
Get All Beneficiaries
get
Get Beneficiary
get
Off Ramp Destinations
Create Withdrawal Destination
post
Withdrawal Fee estimate
get
Withdrawal
post
Get All by beneficiary
get
Withdrawal informations by id
get
Crypto
Crypto Receive
Get Options
get
Get all infos by account
get
Create Receive info
post
Get By ID
get
Update
put
Archive
del
Restore
patch
Crypto Send
Options
get
Requirements
get
Create Send info
post
Send fee estimate
get
Send Crypto
post
Get info by ID
get
Get all send infos
get
Powered by
Authentication Flow
Ask AI
Machine-to-Machine (M2M)
