Jump to Content

v1.0

v1.0API Reference

IBEX Hub API

Welcome!
Quick Start
Sandbox vs. Production

Auth

Auth Middleware
Sign Uppost
Sign Inpost
Authentication Token Details
- Revoke Refresh Tokenpost
- Refresh Access Tokenpost
Password Management
- Change Passwordpost
- Forgot Passwordpost

Accounts

Description
Create Accountpost
Get Account
Update Accountput

Transactions

Description
Account Transactionsget
Transaction Detailsget

Onchain

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

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 bolt11delete

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 Splitsdelete
- Delete a single Splitdelete
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-withdrawdelete

Lightning Address

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

Currencies

All Currenciesget
Rates V2get
- Rates (deprecated)get

IBEXPay API

Link to IBEXPay API docs

Powered by

IBEX Hub API

Welcome!
Quick Start
Sandbox vs. Production

Auth

Auth Middleware
Sign Uppost
Sign Inpost
Authentication Token Details
- Revoke Refresh Tokenpost
- Refresh Access Tokenpost
Password Management
- Change Passwordpost
- Forgot Passwordpost

Accounts

Description
Create Accountpost
Get Account
Update Accountput

Transactions

Description
Account Transactionsget
Transaction Detailsget

Onchain

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

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 bolt11delete

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 Splitsdelete
- Delete a single Splitdelete
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-withdrawdelete

Lightning Address

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

Currencies

All Currenciesget
Rates V2get
- Rates (deprecated)get

IBEXPay API

Link to IBEXPay API docs

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