Introduction - Puplar

Base URL

All API requests are made to:

https://api.puplar.com

Business and live/test mode are inferred from your secret key (sk_test_… / sk_live_…).

Amounts

Unless noted otherwise, monetary amount values are in minor units (kobo for ngn, cents for usd). Wallet and checkout currencies are ngn and usd. Crypto rails use token codes usdc and usdt (see Payouts and Crypto).

Response format

Every success response follows the same envelope:

{
  "message": "Customer created",
  "data": { ... }
}

Validation failures return HTTP 422 with issues in data:

{
  "message": "Invalid email address",
  "data": [
    { "path": "email", "message": "Invalid email address", "location": "body" }
  ]
}

See the Errors guide for full details.

Pagination

Endpoints that return lists accept page and limit query parameters:

Parameter	Default	Max
`page`	`1`	—
`limit`	`20`	`100`

Example:

GET /customers?page=2&limit=50

Error codes

Status	Meaning
`400`	Business rule violation or bad request
`401`	Missing or invalid API key
`403`	Forbidden — IP not whitelisted for this key
`404`	Resource not found
`409`	Conflict — duplicate payout/payment `reference`, or a refund already in progress
`422`	Schema validation failed
`429`	Rate limit exceeded (100 req / 15 min per IP)
`500`	Internal server error

​Base URL

​Amounts

​Response format

​Pagination

​Error codes

Base URL

Amounts

Response format

Pagination

Error codes