Skip to main content
POST
Create escrow

Authorizations

Authorization
string
header
required

Your secret key as a Bearer token. The key prefix selects the environment: sk_test_... (test) or sk_live_... (live).

Headers

customer-id
string
required

The merchant customer this request acts on behalf of.

Body

multipart/form-data
amount
integer
required

Escrow amount in kobo-less major units (NGN). Must be a positive integer.

Example:

150000

purpose
string
required

Short title of what is being sold.

Example:

"MacBook Pro 14\""

whoPays
enum<string>
required

Which party pays the Payluk fee.

Available options:
buyer,
seller,
both
Example:

"both"

description
string
Example:

"Space grey, sealed"

maxDelivery
integer

Length of the delivery window, in deliveryTimeline units.

Example:

3

deliveryTimeline
enum<string>
Available options:
minutes,
hours,
days
Example:

"days"

totalQuantity
integer
Example:

1

categoryId
string
Example:

"665f1b2c9a1e4d0012ab3c30"

imageUrl
file

Product image. Attach the field up to 5 times to upload multiple images.

Response

Escrow created.

status
integer
Example:

200

message
string
Example:

"Operation successful"

data
object