Skip to main content
POST
Create an escrow project

Headers

Authorization
enum<string>
default:NONE
required

Reserved for PCX-managed applications. External API integrations must always send the literal string NONE — this is the only accepted value.

Available options:
NONE
Example:

"NONE"

X-Api-Key
string
default:NONE
required

Your API key. This is the only supported credential.

Example:

"pcx_abc123_xxxx"

Body

application/json
label
string
required

Display name for the escrow project

org_ref
string
required

Your own reference for the project

Required string length: 1 - 100
currency
string
required

Currency of the escrow pool

total_amount
number<float>
required

Total project amount; must be greater than 0

milestones
object[]

Optional milestones to create inline

parties
object[]

Optional parties to register inline

Response

Escrow entity created

status
enum<string>
Available options:
success,
error
Example:

"success"

message
string
data
object