Create an escrow project
curl --request POST \
--url https://prod-api.pcxpay.com/v1/virtual-accounts/escrow \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <x-api-key>' \
--data '
{
"label": "<string>",
"org_ref": "<string>",
"currency": "<string>",
"total_amount": 123,
"milestones": [
{
"label": "<string>",
"expected_disbursement": 123,
"description": "<string>",
"sequence": 2,
"due_date": "<string>"
}
],
"parties": [
{
"party_type": "contractor",
"label": "<string>",
"va_account_number": "<string>",
"user_id": "<string>"
}
]
}
'import requests
url = "https://prod-api.pcxpay.com/v1/virtual-accounts/escrow"
payload = {
"label": "<string>",
"org_ref": "<string>",
"currency": "<string>",
"total_amount": 123,
"milestones": [
{
"label": "<string>",
"expected_disbursement": 123,
"description": "<string>",
"sequence": 2,
"due_date": "<string>"
}
],
"parties": [
{
"party_type": "contractor",
"label": "<string>",
"va_account_number": "<string>",
"user_id": "<string>"
}
]
}
headers = {
"Authorization": "<authorization>",
"X-Api-Key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: '<authorization>',
'X-Api-Key': '<x-api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
label: '<string>',
org_ref: '<string>',
currency: '<string>',
total_amount: 123,
milestones: [
{
label: '<string>',
expected_disbursement: 123,
description: '<string>',
sequence: 2,
due_date: '<string>'
}
],
parties: [
{
party_type: 'contractor',
label: '<string>',
va_account_number: '<string>',
user_id: '<string>'
}
]
})
};
fetch('https://prod-api.pcxpay.com/v1/virtual-accounts/escrow', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://prod-api.pcxpay.com/v1/virtual-accounts/escrow",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'label' => '<string>',
'org_ref' => '<string>',
'currency' => '<string>',
'total_amount' => 123,
'milestones' => [
[
'label' => '<string>',
'expected_disbursement' => 123,
'description' => '<string>',
'sequence' => 2,
'due_date' => '<string>'
]
],
'parties' => [
[
'party_type' => 'contractor',
'label' => '<string>',
'va_account_number' => '<string>',
'user_id' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json",
"X-Api-Key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://prod-api.pcxpay.com/v1/virtual-accounts/escrow"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"org_ref\": \"<string>\",\n \"currency\": \"<string>\",\n \"total_amount\": 123,\n \"milestones\": [\n {\n \"label\": \"<string>\",\n \"expected_disbursement\": 123,\n \"description\": \"<string>\",\n \"sequence\": 2,\n \"due_date\": \"<string>\"\n }\n ],\n \"parties\": [\n {\n \"party_type\": \"contractor\",\n \"label\": \"<string>\",\n \"va_account_number\": \"<string>\",\n \"user_id\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("X-Api-Key", "<x-api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://prod-api.pcxpay.com/v1/virtual-accounts/escrow")
.header("Authorization", "<authorization>")
.header("X-Api-Key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"org_ref\": \"<string>\",\n \"currency\": \"<string>\",\n \"total_amount\": 123,\n \"milestones\": [\n {\n \"label\": \"<string>\",\n \"expected_disbursement\": 123,\n \"description\": \"<string>\",\n \"sequence\": 2,\n \"due_date\": \"<string>\"\n }\n ],\n \"parties\": [\n {\n \"party_type\": \"contractor\",\n \"label\": \"<string>\",\n \"va_account_number\": \"<string>\",\n \"user_id\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod-api.pcxpay.com/v1/virtual-accounts/escrow")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["X-Api-Key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"<string>\",\n \"org_ref\": \"<string>\",\n \"currency\": \"<string>\",\n \"total_amount\": 123,\n \"milestones\": [\n {\n \"label\": \"<string>\",\n \"expected_disbursement\": 123,\n \"description\": \"<string>\",\n \"sequence\": 2,\n \"due_date\": \"<string>\"\n }\n ],\n \"parties\": [\n {\n \"party_type\": \"contractor\",\n \"label\": \"<string>\",\n \"va_account_number\": \"<string>\",\n \"user_id\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "<string>",
"data": {
"escrow_id": "<string>",
"org_id": "<string>",
"org_ref": "<string>",
"label": "<string>",
"created_by": "<string>",
"currency": "<string>",
"total_amount": 123,
"funded_amount": 123,
"disbursed_amount": 123,
"status": "active",
"created_at": "<string>",
"updated_at": "<string>",
"milestones": [
{
"milestone_id": "<string>",
"label": "<string>",
"sequence": 123,
"expected_disbursement": 123,
"status": "pending",
"disbursed_total": 123,
"description": "<string>",
"due_date": "<string>",
"contract_submitted_at": "<string>",
"disbursed_at": "<string>",
"parties": [
{
"party_id": "<string>",
"split_type": "percentage",
"split_value": 123
}
],
"funding_status": "funded",
"covered_amount": 123
}
],
"parties": [
{
"party_id": "<string>",
"party_type": "contractor",
"label": "<string>",
"user_id": "<string>",
"va_account_number": "<string>"
}
],
"contracts": [
{
"contract_id": "<string>",
"milestone_id": "<string>",
"created_at": "<string>",
"status": "approved",
"contractor_confirmations": [
{
"party_id": "<string>",
"confirmed_at": "<string>"
}
],
"client_confirmed_at": "<string>",
"agency_notes": "<string>",
"reviewed_at": "<string>",
"rejection_reason": "<string>"
}
],
"payment_links": [
{
"link_ref": "<string>",
"label": "<string>",
"amount": 123,
"status": "pending",
"created_at": "<string>",
"escrow_id": "<string>"
}
]
}
}{
"message": "<string>",
"status": "error"
}{
"message": "<string>",
"status": "error"
}{
"message": "<string>",
"status": "error"
}{
"message": "<string>",
"status": "error"
}Projects
Create an escrow project
Creates a new escrow entity (project) for the caller’s organisation, optionally with milestones and parties inline. Requires the escrow feature to be enabled for the organisation.
POST
/
virtual-accounts
/
escrow
Create an escrow project
curl --request POST \
--url https://prod-api.pcxpay.com/v1/virtual-accounts/escrow \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <x-api-key>' \
--data '
{
"label": "<string>",
"org_ref": "<string>",
"currency": "<string>",
"total_amount": 123,
"milestones": [
{
"label": "<string>",
"expected_disbursement": 123,
"description": "<string>",
"sequence": 2,
"due_date": "<string>"
}
],
"parties": [
{
"party_type": "contractor",
"label": "<string>",
"va_account_number": "<string>",
"user_id": "<string>"
}
]
}
'import requests
url = "https://prod-api.pcxpay.com/v1/virtual-accounts/escrow"
payload = {
"label": "<string>",
"org_ref": "<string>",
"currency": "<string>",
"total_amount": 123,
"milestones": [
{
"label": "<string>",
"expected_disbursement": 123,
"description": "<string>",
"sequence": 2,
"due_date": "<string>"
}
],
"parties": [
{
"party_type": "contractor",
"label": "<string>",
"va_account_number": "<string>",
"user_id": "<string>"
}
]
}
headers = {
"Authorization": "<authorization>",
"X-Api-Key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: '<authorization>',
'X-Api-Key': '<x-api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
label: '<string>',
org_ref: '<string>',
currency: '<string>',
total_amount: 123,
milestones: [
{
label: '<string>',
expected_disbursement: 123,
description: '<string>',
sequence: 2,
due_date: '<string>'
}
],
parties: [
{
party_type: 'contractor',
label: '<string>',
va_account_number: '<string>',
user_id: '<string>'
}
]
})
};
fetch('https://prod-api.pcxpay.com/v1/virtual-accounts/escrow', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://prod-api.pcxpay.com/v1/virtual-accounts/escrow",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'label' => '<string>',
'org_ref' => '<string>',
'currency' => '<string>',
'total_amount' => 123,
'milestones' => [
[
'label' => '<string>',
'expected_disbursement' => 123,
'description' => '<string>',
'sequence' => 2,
'due_date' => '<string>'
]
],
'parties' => [
[
'party_type' => 'contractor',
'label' => '<string>',
'va_account_number' => '<string>',
'user_id' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json",
"X-Api-Key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://prod-api.pcxpay.com/v1/virtual-accounts/escrow"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"org_ref\": \"<string>\",\n \"currency\": \"<string>\",\n \"total_amount\": 123,\n \"milestones\": [\n {\n \"label\": \"<string>\",\n \"expected_disbursement\": 123,\n \"description\": \"<string>\",\n \"sequence\": 2,\n \"due_date\": \"<string>\"\n }\n ],\n \"parties\": [\n {\n \"party_type\": \"contractor\",\n \"label\": \"<string>\",\n \"va_account_number\": \"<string>\",\n \"user_id\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("X-Api-Key", "<x-api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://prod-api.pcxpay.com/v1/virtual-accounts/escrow")
.header("Authorization", "<authorization>")
.header("X-Api-Key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"org_ref\": \"<string>\",\n \"currency\": \"<string>\",\n \"total_amount\": 123,\n \"milestones\": [\n {\n \"label\": \"<string>\",\n \"expected_disbursement\": 123,\n \"description\": \"<string>\",\n \"sequence\": 2,\n \"due_date\": \"<string>\"\n }\n ],\n \"parties\": [\n {\n \"party_type\": \"contractor\",\n \"label\": \"<string>\",\n \"va_account_number\": \"<string>\",\n \"user_id\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod-api.pcxpay.com/v1/virtual-accounts/escrow")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["X-Api-Key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"<string>\",\n \"org_ref\": \"<string>\",\n \"currency\": \"<string>\",\n \"total_amount\": 123,\n \"milestones\": [\n {\n \"label\": \"<string>\",\n \"expected_disbursement\": 123,\n \"description\": \"<string>\",\n \"sequence\": 2,\n \"due_date\": \"<string>\"\n }\n ],\n \"parties\": [\n {\n \"party_type\": \"contractor\",\n \"label\": \"<string>\",\n \"va_account_number\": \"<string>\",\n \"user_id\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "<string>",
"data": {
"escrow_id": "<string>",
"org_id": "<string>",
"org_ref": "<string>",
"label": "<string>",
"created_by": "<string>",
"currency": "<string>",
"total_amount": 123,
"funded_amount": 123,
"disbursed_amount": 123,
"status": "active",
"created_at": "<string>",
"updated_at": "<string>",
"milestones": [
{
"milestone_id": "<string>",
"label": "<string>",
"sequence": 123,
"expected_disbursement": 123,
"status": "pending",
"disbursed_total": 123,
"description": "<string>",
"due_date": "<string>",
"contract_submitted_at": "<string>",
"disbursed_at": "<string>",
"parties": [
{
"party_id": "<string>",
"split_type": "percentage",
"split_value": 123
}
],
"funding_status": "funded",
"covered_amount": 123
}
],
"parties": [
{
"party_id": "<string>",
"party_type": "contractor",
"label": "<string>",
"user_id": "<string>",
"va_account_number": "<string>"
}
],
"contracts": [
{
"contract_id": "<string>",
"milestone_id": "<string>",
"created_at": "<string>",
"status": "approved",
"contractor_confirmations": [
{
"party_id": "<string>",
"confirmed_at": "<string>"
}
],
"client_confirmed_at": "<string>",
"agency_notes": "<string>",
"reviewed_at": "<string>",
"rejection_reason": "<string>"
}
],
"payment_links": [
{
"link_ref": "<string>",
"label": "<string>",
"amount": 123,
"status": "pending",
"created_at": "<string>",
"escrow_id": "<string>"
}
]
}
}{
"message": "<string>",
"status": "error"
}{
"message": "<string>",
"status": "error"
}{
"message": "<string>",
"status": "error"
}{
"message": "<string>",
"status": "error"
}Headers
Bearer JWT for user-facing flows (Bearer eyJraWQ...), or the literal string NONE when authenticating via API key.
Example:
"Bearer eyJraWQ..."
API key for server-to-server flows, or the literal string NONE when authenticating via JWT.
Example:
"pcx_abc123_xxxx"
Body
application/json
Display name for the escrow project
Your own reference for the project
Required string length:
1 - 100Currency of the escrow pool
Total project amount; must be greater than 0
Optional milestones to create inline
Show child attributes
Show child attributes
Optional parties to register inline
Show child attributes
Show child attributes