Payluk API · v1.0
Build on escrow, wallets, and payouts
The Payluk API covers onboarding, webhooks, seller and buyer flows, disputes, wallets, withdrawals, and stablecoin (cNGN) deposits. Use this hub to jump into the topics that matter, then open the full reference for request and response schemas.
# Example request GET /v1/wallet/balance Accept: application/json Authorization: Bearer <api_key> # Escrow lifecycle (simplified) pending → funded → released # See: Escrow status lifecycle in docs
API fundamentals
Auth, environments, limits, and escrow concepts — read these before integrating.
Introduction
Overview of the Payluk API — escrow, wallets, and how the reference is organized.
Authentication
How to authenticate requests and manage API credentials for your integration.
Environment
Sandbox vs production endpoints and how to switch safely during development.
Rate limiting & errors
Throttling, error shapes, and how to handle retries in production traffic.
Pagination
List endpoints and cursor/page patterns for large result sets.
Escrow status lifecycle
States an escrow moves through from creation to release or dispute.
Fee structure
How fees apply across flows so you can quote costs in your product.
Get started
Wire up webhooks and onboarding so your backend can trust every event from Payluk.
Onboarding
First-time setup to get keys, environments, and a test customer in place.
Setup webhook
Register endpoints to receive payment and escrow lifecycle events.
Webhook
Payload shapes, retries, and verifying events from Payluk.
IP whitelisting
Lock down server-to-server calls when your security policy requires it.
Product surfaces
Customers, seller and buyer APIs, disputes, payments history, categories, countries, and address whitelisting are all documented in the reference sidebar — open it to browse every operation.
Checkout & SDK
Checkout JS, payment token verification, and client-side flows.
Customers
Create and manage customers, permissions, and account status.
Seller
Payment links, transactions, claims, and responding to disputes.
Buyer
Pay escrow, open disputes, and confirm receipt to release funds.
Wallet & transfers
Balances, transfers, withdrawals, banks, virtual accounts, and cards.
Deposits & cNGN
Crypto deposit wallets, testnet cNGN, and topping up for tests.
Full endpoint list & Try It console
Explore every route, query param, and example response in the official Payluk API reference on ReadMe.