Skip to main content
Payluk is a merchant platform: your account manages a set of customers (role merchant_user) who act as buyers and sellers. Many API actions are performed on behalf of one of these customers.

Creating customers

Use Create merchant customer with the customer’s name, email and phone. This requires your key to belong to a merchant super-admin account.
Send phone as digits only, with no leading +. Local and international spellings of the same number are both accepted (08012345678, 2348012345678, 8012345678), and each is stored in the local form, so the same person cannot become several customers under different spellings. countryId is optional: omit it and the customer inherits the country on your merchant account. You can pass either the ISO code (NG) or the id from Get countries.

Acting on behalf of a customer

Pass the customer’s ID in the customer-id header. This tells Payluk which customer’s wallet, escrows or cards the request concerns:
See Authentication for the full list of routes that require it.

Permissions & status

Buy / sell permissions

Toggle canBuy and canSell per customer. A customer disabled from buying is rejected at payment time.

Block / unblock

Block a customer to suspend their activity; unblock to restore it.

Wallets

Each customer has a wallet with a mainBalance (spendable) and an escrowBalance (funds locked in open escrows). Read it with Get customer wallet.