Reference

API reference

153 endpoints across 21 products, generated from the live specification. Base URL https://business.boundlesspay.com/api/public/v1.

Download the OpenAPI document

Balances & transactions

GET/balancesList balances GET/balances/{currency}Retrieve one balance GET/meDescribe the calling credential GET/usageMetered API usage for the current environment

Bank payouts

GET/payoutsList payouts POST/payoutsPay out to a bank account GET/payouts/{id}Retrieve a payout POST/payouts/{id}/reconcileRe-check a payout with its rail GET/payouts/banksList banks you can pay out to POST/payouts/resolve-accountResolve a bank account name

Blockchain addresses & withdrawals

GET/crypto/addressesList blockchain deposit addresses POST/crypto/addressesIssue a blockchain deposit address GET/crypto/receive-addressResolve the address to receive an asset on GET/crypto/withdrawalsList on-chain withdrawals POST/crypto/withdrawalsSend an on-chain withdrawal GET/crypto/withdrawals/{id}Retrieve an on-chain withdrawal POST/swaps/{id}/executeExecute a swap quote POST/swaps/{id}/refreshRefresh an expiring swap quote POST/swaps/quoteQuote a swap between two assets GET/trading/ordersList trading orders POST/trading/ordersPlace a trading order POST/trading/orders/{id}/cancelCancel a trading order

Business financing

GET/financing/credit-scoreRetrieve your credit score GET/financing/eligibilityCheck financing eligibility

Cards

GET/cardholdersList cardholders POST/cardholdersRegister a cardholder GET/cardholders/{id}Retrieve a cardholder GET/cardsList cards POST/cardsIssue a card GET/cards/{id}Retrieve a card POST/cards/{id}/freezeFreeze a card POST/cards/{id}/fundFund a card from a business balance POST/cards/{id}/limitsUpdate card spend limits POST/cards/{id}/terminateTerminate a card GET/cards/{id}/transactionsList card transactions POST/cards/{id}/unfreezeUnfreeze a card POST/cards/{id}/withdrawWithdraw funds from a card

Checkout page

GET/bpay-payments/{id}Retrieve a BpayTag payment GET/checkout-sessionsList checkout pages POST/checkout-sessionsCreate a checkout page GET/checkout-sessions/{id}Retrieve a checkout page POST/checkout-sessions/{id}/cancelCancel a checkout page POST/payment-intentsCreate a BpayTag payment request GET/payment-intents/{id}Retrieve a payment request POST/payment-intents/{id}/cancelCancel an unpaid payment request GET/tags/{id}Resolve a business BpayTag

Conversions & swaps

GET/conversionsList conversions POST/conversionsExecute a conversion against a firm quote GET/conversions/{id}Retrieve a conversion POST/conversions/{id}/reconcileRe-check a conversion with its original provider GET/conversions/pairsList supported conversion pairs POST/quotesCreate a conversion quote GET/quotes/{id}Retrieve a quote

Customers

GET/customersList customers POST/customersCreate a customer GET/customers/{id}Retrieve a customer PATCH/customers/{id}Update a customer POST/customers/{id}/freezeFreeze a customer POST/customers/{id}/unfreezeUnfreeze a customer GET/customers/{id}/verificationRetrieve verification history

Flights & Travel

GET/flights/bookingsList flight bookings POST/flights/bookingsCreate a flight booking GET/flights/bookings/{id}Retrieve a flight booking POST/flights/searchSearch flight offers

Global Digital Services

POST/digital-services/batchesCreate a bulk digital service batch GET/digital-services/batches/{id}Retrieve a bulk batch with per-row status GET/digital-services/productsList digital service products GET/digital-services/products/{id}Retrieve a digital service product GET/digital-services/purchasesList digital service purchases POST/digital-services/purchasesPurchase a digital service GET/digital-services/purchases/{id}Retrieve a digital service purchase POST/digital-services/quotesQuote a digital service purchase

Identity verification (KYC)

POST/customers/{id}/submit-kycVerify a customer's identity (BVN/NIN, selfie match, watchlist screening)

Inventory & products

GET/inventory/productsList products and stock POST/inventory/productsCreate a product GET/inventory/products/{id}Retrieve a product PATCH/inventory/products/{id}Update a product POST/inventory/products/{id}/stockSet stock count GET/inventory/reviewsList product reviews GET/inventory/storesList stores

Merchant Hub

GET/merchant/disputesList merchant disputes GET/merchant/disputes/{id}Retrieve a merchant dispute GET/merchant/settlementsList merchant settlements GET/merchant/terminalsList POS terminals GET/merchant/terminals/{id}Retrieve a POS terminal GET/merchant/transactionsList merchant transactions

OTC trading

GET/otc/balancesOTC balances including reserved amounts GET/otc/markets/{pair}Market summary for one pair GET/otc/order-book/{pair}Aggregated order book depth GET/otc/ordersList orders POST/otc/ordersPlace a funded limit or market order GET/otc/orders/{id}Retrieve an order POST/otc/orders/{id}/cancelCancel the unfilled remainder of an order GET/otc/pairsList OTC trading pairs GET/otc/swap/{id}Retrieve a swap POST/otc/swap/executeExecute a swap against a firm quote POST/otc/swap/quoteRequest a firm swap quote GET/otc/trade-historyYour executed OTC trades GET/otc/trades/{pair}Recent public trades

Payroll

GET/payroll/employeesList payroll employees GET/payroll/employees/{id}Retrieve a payroll employee GET/payroll/payrollsList payrolls GET/payroll/runsList payroll runs POST/payroll/runsRun a payroll GET/payroll/runs/{id}Retrieve a payroll run GET/payroll/runs/{id}/payslipsList payslips for a run

Rates

GET/public/ratesPublic conversion rates (no API key)GET/public/rates/{pair}Retrieve one public rate (no API key)GET/ratesConversion rates for any pair type GET/rates/{pair}Retrieve one rate GET/rates/bestBest executable rate across all routes GET/rates/currenciesList every currency and asset we quote

Remittance & transfers

GET/beneficiariesList beneficiaries POST/beneficiariesSave a payout beneficiary DELETE/beneficiaries/{id}Archive a beneficiary GET/beneficiaries/{id}Retrieve a beneficiary POST/beneficiaries/{id}/verifyName-check a Nigerian bank beneficiary GET/transfersList transfers POST/transfersSend a transfer GET/transfers/{id}Retrieve a transfer POST/transfers/{id}/reconcileRe-check a transfer with its provider GET/transfers/corridorsList payout corridors, methods and limits POST/transfers/quotePrice a transfer before sending it

Savings

GET/savings/plansList savings plans POST/savings/plansOpen a savings plan GET/savings/plans/{id}Retrieve a savings plan GET/savings/ratesCurrent savings rates

Store refunds

POST/bpay-payments/{id}/refundsRefund a BpayTag payment (dashboard approval required)GET/refundsList refunds POST/refundsRefund a store order GET/refunds/{id}Retrieve a refund POST/refunds/{id}/retry-payoutRetry the buyer payout for a refund

Virtual accounts service

GET/deposit-accountsList receiving accounts, including preserved historical ones POST/sandbox/depositsSimulate a deposit (test credentials only)GET/virtual-accountsList virtual accounts POST/virtual-accountsIssue a Naira virtual account GET/virtual-accounts/{id}Retrieve a virtual account POST/virtual-accounts/{id}/closeClose a virtual account POST/virtual-accounts/{id}/freezeFreeze a virtual account GET/virtual-accounts/{id}/transactionsList deposits into a virtual account POST/virtual-accounts/{id}/unfreezeUnfreeze a virtual account

Webhooks

GET/webhook-deliveriesList webhook deliveries POST/webhook-deliveries/{id}/replayReplay a webhook delivery POST/webhook-deliveries/replayBulk replay failed webhook deliveries GET/webhook-endpointsList webhook endpoints POST/webhook-endpointsCreate a webhook endpoint DELETE/webhook-endpoints/{id}Delete a webhook endpoint GET/webhook-endpoints/{id}Retrieve a webhook endpoint PATCH/webhook-endpoints/{id}Update a webhook endpoint POST/webhook-endpoints/{id}/rotate-secretRotate an endpoint signing secret GET/webhook-eventsList webhook events GET/webhook-events/{id}Retrieve a webhook event POST/webhook-events/{id}/resendResend an event to one endpoint

API reference

Balances & transactions

Bank payouts

Blockchain addresses & withdrawals

Business financing

Cards

Checkout page

Conversions & swaps

Customers

Flights & Travel

Global Digital Services

Identity verification (KYC)

Inventory & products

Merchant Hub

OTC trading

Payroll

Rates

Remittance & transfers

Savings

Store refunds

Virtual accounts service

Webhooks

Build financial workflows that execute.