Skip to main content
Payluk is a merchant platform: your account holds a set of customers (role merchant_user) who act as buyers and sellers. Almost every escrow and payment action is performed on behalf of one of these customers via the customer-id header, so this is step 1 of any integration.
Creating and managing customers needs your key to belong to a merchant super-admin account. Acting as a customer (wallet, payments, escrows) is done by passing their ID in the customer-id header. See Merchant customers and Authentication.

Endpoints

RouteMethod & pathWhat it does
Create merchant customerPOST /v1/customer/createOnboards a buyer or seller under your account. Body: firstname, lastname, email, phone, countryId. Returns the customer id you’ll use as customer-id. Super-admin key required.
List merchant customersGET /v1/customersPaginated list of every customer on your account. Supports page / limit.
Get merchant customerGET /v1/customer/get/{customerId}Fetch a single customer’s profile by ID.
Update customer permissionsPUT /v1/customer/permissions/{customerId}Toggle canBuy / canSell. A customer with canBuy: false is rejected at payment time; canSell: false blocks selling.
Block customerPUT /v1/customer/block/{customerId}Suspends a customer’s activity (status → blocked).
Unblock customerPUT /v1/customer/unblock/{customerId}Restores a blocked customer (status → active).
Get customer walletGET /v1/walletReturns mainBalance (spendable) and escrowBalance (locked in open escrows). Requires the customer-id header.

Typical order

1

Create the seller and the buyer

Two POST /v1/customer/create calls. Keep both returned IDs.
2

Set permissions

Give the seller canSell and the buyer canBuy.
3

Use them everywhere else

Pass the right customer-id on escrow, payment and dispute calls. Check balances any time with GET /v1/wallet.
Next: create the deal, or see the full end-to-end journey.