For AI agents: visit https://docs.poweredbyibex.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.

Jump to Content

v1.0

API Reference

v1.0API Reference

IBEX Hub API

Welcome!
Sandbox vs. Production
🛑Rate Limits
Postman
🖥️Hub Console

Authentication

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

Accounts

Description
Create Accountpost
Get Account
Update Accountput
Webhooks

Transactions

Description
Account Transactionsget
Get Transactionget
Transaction Typesget
Get All transactionsget
Get Transaction Detailsget

Onchain

OnChain Transactions
Generate Bitcoin Addresspost
Get All Addressesget
Send to Address V2post
- Send to Address v1post
Estimate Fee V2get
- Estimate Fee v1get
Send All to Addresspost

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
Send All to invoicepost

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
Swap Rateget
Historyget

IBEXPay API

Link to IBEXPay API docs

HUB API.

Countries
- Get all countriesget

Fiat On : Off Ramp

Beneficiaries
On Ramp
Off Ramp

Crypto

Crypto Receive
Crypto Send

Powered by

Link to IBEXPay API docs

This page will help you get started with IBEXPay API.

📘
IBEXPay API Documentation
https://ibexpay-api.readme.io/reference/getting-started-with-your-api

Updated about 1 year ago

Did this page help you?

Updated about 1 year ago

Did this page help you?