Payluk API · v1.0
Build on escrow, wallets, and payouts
The Payluk API covers staging and production environments, seller and buyer flows, disputes, wallets, withdrawals, and stablecoin (cNGN) deposits. Start with Quickstart or explore core docs for escrow lifecycle, auth, and webhook integration.
# Example request GET /customer/get/{customerId} 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.
Keys & Environments
Your secret keys must stay on your backend.
Error handling
How Payluk reports errors and what each status code means.
Pagination
List endpoints and cursor/page patterns for large result sets.
Escrow lifecycle
States an escrow moves through from creation to release or dispute.
Fees & settlement
How fees are split, when they're charged, and how funds settle.
Get started
Build your first escrow flow with Quickstart, set up webhooks, and verify every event from Payluk.
Quickstart
Build a sample escrow flow on staging and test your first API calls.
Onboarding
First-time setup to get keys, environments, and a test customer in place.
Escrow webhooks
Signature verification, payload shapes, retries, and best practices.
Dispute resolution
How disputes are raised between your customers and how you, the merchant, resolve them and disburse the held funds.
Milestone escrows
Fund a project upfront and release it in stages as each milestone is confirmed.
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.