Skip to main content
PUT
Edit escrow

Authorizations

Authorization
string
header
required

Your secret key as a Bearer token. The key prefix selects the environment: sk_test_... (staging) or sk_live_... (production); a key on the wrong host is refused with 403 Unauthorized Access. Each key is limited to 10 requests per minute (429 beyond that) and, on production, to the IP addresses on your dashboard allowlist when one is configured.

Headers

customer-id
string

The merchant customer this request acts on behalf of. Omit it to act as your own business account (only a business-type account can sell on its own behalf).

Path Parameters

paymentToken
string
required

The escrow's payment token (e.g. PY_8AB12C9D3045).

Body

multipart/form-data
amount
number
required

Naira with at most two decimal places. Minimum 1000.

Required range: x >= 1000
Example:

150000

purpose
string
required
Example:

"MacBook Pro 14\" (updated)"

whoPays
enum<string>
required
Available options:
buyer,
seller,
both
Example:

"both"

maxDelivery
integer
required
Required range: 1 <= x <= 365
Example:

3

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

"days"

imageUrl
file

Additional image(s) to append.

description
string
totalQuantity
integer
Required range: x >= 1
categoryId
string

Response

Escrow updated.

status
integer
Example:

200

message
string
Example:

"Operation successful"

data
object