Jump to Content

v1.0

API Reference

v1.0API Reference

All

Pages

Start typing to search…

IBEX Hub API

Welcome!
Quick Start
Sandbox vs. Production
Postman
🖥️Hub Console

Authentication

🔏Authentication Flow
- 🔐Access Token
- 🔓Making Authenticated Requests

Accounts

Description
Create Accountpost
Get Account
Update Accountput
Webhooks

Transactions

Description
Account Transactionsget
Transaction Detailsget
Transaction Typesget

Onchain

OnChain Transactions
Generate Bitcoin Addresspost
Send to Address V2post
- Send to Address v1post
Estimate Fee V2get
- Estimate Fee v1get
Get Onchain Transaction (v1)get

Lightning Network

The Lightning Network (LN)

Lightning Invoices

Flow
Add Invoice V2post
- Add Invoice with a mSat amountpost
Get Invoice
- Invoice From bolt11get
- Invoice From Hashget
Delete Invoice From bolt11del

Lightning Payments

Flow
Pay Invoice V2post
- Pay Invoice specifying a mSat amountpost
Decode invoiceget
Payment estimationget
Get Payment
- From hashget
- From Bolt11get

Payment splits

Create Splitspost
Get Splits
- Get all Splitsget
- Get a single Splitget
Update Splits
- Update all Splitsput
- Update a single Splitput
Delete Splits
- Delete all Splitsdel
- Delete a single Splitdel
Get Split Destinationsget

LNURL - Decode

Decode LNURLget

LNURL - pay

Flow
Create LNURL-paypost
Pay to a LNURL-paypost
Invoice requirementsget
Bolt11get
LNURL-pay statusget
All LNURL-payget

LNURL - withdraw

Flow
Create LNURL-withdrawpost
Withdraw from a LNURL-withdrawpost
Invoice requirementsget
Pay invoiceget
LNURL-Withdraw Statusget
All LNURL-withdrawsget
Cancel a LNURL-withdrawdel

Lightning Address

Create a Lightning Addresspost
All Lightning Addressesget
Bolt11get
Update Lightning Addressput
Lightning Addressdel
Pay to Lightning Address
Custom Lightning Address

Currencies

All Currenciesget
Rates V2get
- Rates (deprecated)get

IBEXPay API

Link to IBEXPay API docs

HUB API.

Countries
- Get all countriesget

Fiat On : Off Ramp

On Ramp
Off Ramp

Crypto

Crypto Receive
Crypto Send

Powered by

Get Beneficiary

get

https://api-sandbox.poweredbyibex.io/beneficiaries/{id}

Get a beneficiary, you can create withdrawal informations.

Language