Jump to Content

v1.0

v1.0API Reference

IBEX Hub API

Welcome!
Quick Start

IBEXPay API

Link to IBEXPay API docs

Auth

Authentication Token Details
Auth Middleware
Sign Uppost
Sign Inpost
Refresh Access Tokenpost
Revoke Refresh Tokenpost

Password

Change Passwordpost
Forgot Passwordpost
Confirm Forgot Passwordpost

Accounts

Presentation
Create Accountpost
Get All Accountsget
Get All Accounts V2get
Get Account Detailsget
Update Accountput

Transactions

Transactions
Transaction detailsget
Account Transactionsget

Onchain

OnChain Transactions
Generate Bitcoin Addresspost
Send to Addresspost
Send to Address v2post
Estimate Feeget
Estimate Fee V2get

Lightning Network

The Lightning Network (LN)

Lightning Invoices

Flow
Add Invoice V1 (deprecated)post
Add Invoice V2post
Invoice From Hashget
Invoice From bolt11get
Delete Invoice From bolt11delete

Lightning Payments

Flow
Decode Invoiceget
Get fee estimationget
Pay Invoice V1 (deprecated)post
Pay Invoice V2post
Get payment infos from Bolt11get
Get payment info from hashget

LNURL - Decode

Decode LNURLget

LNURL - pay

Flow
Create LNURL-paypost
Invoice requirementsget
Pay invoiceget
Pay to a LNURL-paypost
Get LNURL-pay statusget
Get all LNURL-payget

LNURL - withdraw

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

Lightning Address

Create a Lightning Addresspost
Get all Lightning Addressesget
Update Lightning Addressput
Delete Lightning Addressdelete

Currencies

Get Allget
Get Ratesget
Get Rates V2get

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

Powered by

IBEX Hub API

Welcome!
Quick Start

IBEXPay API

Link to IBEXPay API docs

Auth

Authentication Token Details
Auth Middleware
Sign Uppost
Sign Inpost
Refresh Access Tokenpost
Revoke Refresh Tokenpost

Password

Change Passwordpost
Forgot Passwordpost
Confirm Forgot Passwordpost

Accounts

Presentation
Create Accountpost
Get All Accountsget
Get All Accounts V2get
Get Account Detailsget
Update Accountput

Transactions

Transactions
Transaction detailsget
Account Transactionsget

Onchain

OnChain Transactions
Generate Bitcoin Addresspost
Send to Addresspost
Send to Address v2post
Estimate Feeget
Estimate Fee V2get

Lightning Network

The Lightning Network (LN)

Lightning Invoices

Flow
Add Invoice V1 (deprecated)post
Add Invoice V2post
Invoice From Hashget
Invoice From bolt11get
Delete Invoice From bolt11delete

Lightning Payments

Flow
Decode Invoiceget
Get fee estimationget
Pay Invoice V1 (deprecated)post
Pay Invoice V2post
Get payment infos from Bolt11get
Get payment info from hashget

LNURL - Decode

Decode LNURLget

LNURL - pay

Flow
Create LNURL-paypost
Invoice requirementsget
Pay invoiceget
Pay to a LNURL-paypost
Get LNURL-pay statusget
Get all LNURL-payget

LNURL - withdraw

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

Lightning Address

Create a Lightning Addresspost
Get all Lightning Addressesget
Update Lightning Addressput
Delete Lightning Addressdelete

Currencies

Get Allget
Get Ratesget
Get Rates V2get

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

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