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, phone and countryId. This requires your key to belong to a merchant super-admin account. 
{
  "firstname": "Ada",
  "lastname": "Eze",
  "email": "[email protected]",
  "phone": "+2348012345678",
  "countryId": "665f1b2c9a1e4d0012ab3c40"
}

​
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: 
customer-id: 665f1b2c9a1e4d0012ab3c01
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. 
{ "mainBalance": 50000, "escrowBalance": 1000000, "currency": "NGN" }