New Escrow

Time	Status	User Agent
Retrieving recent requests…

uuid

string

required

Unique identifier of the user joining the escrow

idempotency_key

string

required

A unique client-generated key that ensures an escrow request is processed only once, preventing duplicate escrows during retries.

escrow_type

string

required

Must be set to "recurring" to define this as a recurring escrow.

initiator_role

string

required

The role of the user creating the escrow. Options: buyer, seller.

initiator_id

string

required

The unique identifier (UUID) of the user initiating the escrow.

receiver_id

string

The unique identifier (UUID) of the primary receiver. Can be null if funds are distributed among multiple contributors.

title

string

required

A short, descriptive title for the recurring escrow (e.g., "Monthly Netflix Subscription 2").

currency

string

required

The currency for the transaction (e.g., "NGN", "USD").

amount

number

required

The total amount to be collected or paid per cycle.

description

string

A detailed description of the recurring agreement.

how_dispute_is_handled

string

required

The method for dispute resolution. Default: "arbitration".

who_pay_fees

string

required

Specifies who bears the transaction fees. Options: "buyer", "seller", "both".

cycle

array of objects

An object defining the schedule and rules of the recurring cycle (see table below).

cycle

contributors

array of objects

An array of participant objects for multi-party escrows (see table below). If not provided, it is a standard two-party transaction between the initiator and the receiver.

contributors

payout

object

An object containing the payout details for the seller or contributors. The required fields vary based on the payout_type.

callback_url

string

(Optional) Your webhook URL for receiving updates.

metadata

array

metadata