Skip to main content
PUT
Convert standard escrow to milestone

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.

Path Parameters

paymentToken
string
required

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

Body

application/json

Splits a standard escrow's amount into milestones. amount is optional: supply it to set a new escrow amount, or omit it to keep the escrow's current amount. Either way the milestone amounts must sum to the target amount.

milestones
object[]
required

At least 2 milestones whose amounts sum to the target amount (the new amount if supplied, otherwise the escrow's existing amount).

Minimum array length: 2
amount
integer

Optional new escrow amount. When omitted, the escrow keeps its current amount.

Example:

200000

Response

Escrow converted to a milestone escrow.

status
integer
Example:

200

message
string
Example:

"Operation successful"

data
object