Get an escrow project
curl --request GET \
--url https://prod-api.pcxpay.com/v1/virtual-accounts/escrow/{escrow_id} \
--header 'Authorization: <authorization>' \
--header 'X-Api-Key: <x-api-key>'import requests
url = "https://prod-api.pcxpay.com/v1/virtual-accounts/escrow/{escrow_id}"
headers = {
"Authorization": "<authorization>",
"X-Api-Key": "<x-api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: '<authorization>', 'X-Api-Key': '<x-api-key>'}
};
fetch('https://prod-api.pcxpay.com/v1/virtual-accounts/escrow/{escrow_id}', 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/{escrow_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"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"
"net/http"
"io"
)
func main() {
url := "https://prod-api.pcxpay.com/v1/virtual-accounts/escrow/{escrow_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("X-Api-Key", "<x-api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://prod-api.pcxpay.com/v1/virtual-accounts/escrow/{escrow_id}")
.header("Authorization", "<authorization>")
.header("X-Api-Key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod-api.pcxpay.com/v1/virtual-accounts/escrow/{escrow_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["X-Api-Key"] = '<x-api-key>'
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"
}Projects
Get an escrow project
Fetches the full escrow entity, including its milestones, parties, contracts, and payment links. Org-scoped — the escrow must belong to the caller’s organisation. Requires the escrow feature.
GET
/
virtual-accounts
/
escrow
/
{escrow_id}
Get an escrow project
curl --request GET \
--url https://prod-api.pcxpay.com/v1/virtual-accounts/escrow/{escrow_id} \
--header 'Authorization: <authorization>' \
--header 'X-Api-Key: <x-api-key>'import requests
url = "https://prod-api.pcxpay.com/v1/virtual-accounts/escrow/{escrow_id}"
headers = {
"Authorization": "<authorization>",
"X-Api-Key": "<x-api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: '<authorization>', 'X-Api-Key': '<x-api-key>'}
};
fetch('https://prod-api.pcxpay.com/v1/virtual-accounts/escrow/{escrow_id}', 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/{escrow_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"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"
"net/http"
"io"
)
func main() {
url := "https://prod-api.pcxpay.com/v1/virtual-accounts/escrow/{escrow_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("X-Api-Key", "<x-api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://prod-api.pcxpay.com/v1/virtual-accounts/escrow/{escrow_id}")
.header("Authorization", "<authorization>")
.header("X-Api-Key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod-api.pcxpay.com/v1/virtual-accounts/escrow/{escrow_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["X-Api-Key"] = '<x-api-key>'
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"
}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"