API Reference
Log In
API Reference

New Escrow

Recurring schedules break down an escrow transaction into repeating cycles, releasing funds automatically at predefined intervals while maintaining dispute protection.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Unique identifier of the user joining the escrow

string
required

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

string
required

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

string
required

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

string

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

string
required

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

string
required

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

number
required

The total amount to be collected or paid per cycle.

string

A detailed description of the recurring agreement.

string
required

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

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.

string

(Optional) Your webhook URL for receiving updates.

Response
200
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!