using System.Net.Http;
using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-secret", "YOUR_API_SECRET");
var content = new StringContent("{\"escrowId\": \"59667344\", \"merchantId\": \"01344351\"}", Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/escrow/release", content);
Console.WriteLine(await response.Content.ReadAsStringAsync());

const response = await fetch('https://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/escrow/release', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-secret': 'YOUR_API_SECRET'
  },
  body: JSON.stringify({
    escrowId: '59667344',
    merchantId: '01344351'
  })
});
const data = await response.json();
console.log(data);

curl --request POST \
  --url https://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/escrow/release \
  --header 'Content-Type: application/json' \
  --header 'x-api-secret: <x-api-secret>' \
  --data '
{
  "escrowId": "59667344",
  "merchantId": "01344351"
}
'

import requests

url = "https://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/escrow/release"

payload = {
    "escrowId": "59667344",
    "merchantId": "01344351"
}
headers = {
    "x-api-secret": "<x-api-secret>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/escrow/release",
  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([
    'escrowId' => '59667344',
    'merchantId' => '01344351'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-secret: <x-api-secret>"
  ],
]);

$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://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/escrow/release"

	payload := strings.NewReader("{\n  \"escrowId\": \"59667344\",\n  \"merchantId\": \"01344351\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-secret", "<x-api-secret>")
	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://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/escrow/release")
  .header("x-api-secret", "<x-api-secret>")
  .header("Content-Type", "application/json")
  .body("{\n  \"escrowId\": \"59667344\",\n  \"merchantId\": \"01344351\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/escrow/release")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-secret"] = '<x-api-secret>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"escrowId\": \"59667344\",\n  \"merchantId\": \"01344351\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "timestamp": "2026-07-29T11:00:00Z",
  "message": "Escrow allocation released successfully",
  "data": {
    "escrowId": "59667344",
    "merchantId": "01344351",
    "amount": 3000,
    "releaseStatus": "RELEASED",
    "releasedAt": "2026-07-29T11:00:00Z"
  }
}

{
  "status": "error",
  "timestamp": "2025-05-07T07:31:30.824Z",
  "path": "/v2/starpay-api/",
  "error": {
    "code": "BadRequestException",
    "message": "Missing required payload data, pk and payload is required"
  }
}

{
  "message": "Something wrong",
  "status": "error",
  "timestamp": "2025-05-07T07:31:30.824Z",
  "path": "/v2/starpay-api/",
  "error": {
    "code": "GEN_004",
    "message": "An unexpected server error occurred."
  }
}

{
  "message": "Something wrong",
  "status": "error",
  "timestamp": "2025-05-07T07:31:30.824Z",
  "path": "/v2/starpay-api/",
  "error": {
    "code": "ABC_001",
    "message": "not found"
  }
}

{
  "message": "Something wrong",
  "status": "error",
  "timestamp": "2025-05-07T07:31:30.824Z",
  "path": "/v2/starpay-api/",
  "error": {
    "code": "GEN_004",
    "message": "An unexpected server error occurred."
  }
}

POST

trdp

escrow

release

using System.Net.Http;
using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-secret", "YOUR_API_SECRET");
var content = new StringContent("{\"escrowId\": \"59667344\", \"merchantId\": \"01344351\"}", Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/escrow/release", content);
Console.WriteLine(await response.Content.ReadAsStringAsync());

const response = await fetch('https://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/escrow/release', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-secret': 'YOUR_API_SECRET'
  },
  body: JSON.stringify({
    escrowId: '59667344',
    merchantId: '01344351'
  })
});
const data = await response.json();
console.log(data);

curl --request POST \
  --url https://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/escrow/release \
  --header 'Content-Type: application/json' \
  --header 'x-api-secret: <x-api-secret>' \
  --data '
{
  "escrowId": "59667344",
  "merchantId": "01344351"
}
'

import requests

url = "https://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/escrow/release"

payload = {
    "escrowId": "59667344",
    "merchantId": "01344351"
}
headers = {
    "x-api-secret": "<x-api-secret>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/escrow/release",
  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([
    'escrowId' => '59667344',
    'merchantId' => '01344351'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-secret: <x-api-secret>"
  ],
]);

$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://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/escrow/release"

	payload := strings.NewReader("{\n  \"escrowId\": \"59667344\",\n  \"merchantId\": \"01344351\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-secret", "<x-api-secret>")
	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://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/escrow/release")
  .header("x-api-secret", "<x-api-secret>")
  .header("Content-Type", "application/json")
  .body("{\n  \"escrowId\": \"59667344\",\n  \"merchantId\": \"01344351\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/escrow/release")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-secret"] = '<x-api-secret>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"escrowId\": \"59667344\",\n  \"merchantId\": \"01344351\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "timestamp": "2026-07-29T11:00:00Z",
  "message": "Escrow allocation released successfully",
  "data": {
    "escrowId": "59667344",
    "merchantId": "01344351",
    "amount": 3000,
    "releaseStatus": "RELEASED",
    "releasedAt": "2026-07-29T11:00:00Z"
  }
}

{
  "status": "error",
  "timestamp": "2025-05-07T07:31:30.824Z",
  "path": "/v2/starpay-api/",
  "error": {
    "code": "BadRequestException",
    "message": "Missing required payload data, pk and payload is required"
  }
}

{
  "message": "Something wrong",
  "status": "error",
  "timestamp": "2025-05-07T07:31:30.824Z",
  "path": "/v2/starpay-api/",
  "error": {
    "code": "GEN_004",
    "message": "An unexpected server error occurred."
  }
}

{
  "message": "Something wrong",
  "status": "error",
  "timestamp": "2025-05-07T07:31:30.824Z",
  "path": "/v2/starpay-api/",
  "error": {
    "code": "ABC_001",
    "message": "not found"
  }
}

{
  "message": "Something wrong",
  "status": "error",
  "timestamp": "2025-05-07T07:31:30.824Z",
  "path": "/v2/starpay-api/",
  "error": {
    "code": "GEN_004",
    "message": "An unexpected server error occurred."
  }
}

Release Escrow Allocation

Release held escrow funds for a specific merchant allocation once the corresponding product or service has been fulfilled. In marketplace scenarios where an order is split across multiple vendors, each merchant’s allocation can be released independently as their items are shipped or delivered.

Endpoint

POST /trdp/escrow/release

Authentication

Include your API secret in the request header. Header:

x-api-secret (string) — Required. Your StarPay API secret key. Generate this key from the Merchant Portal under API Keys.

Example:

x-api-secret: SplFeYdc/Hc5S1CGmVDtETLYUJY/10a38ejamzwb1YH30h+u8sOK2fpTlyKitpPk

Request Body

escrowId

The unique identifier of the escrow transaction returned during order creation. Type: string — Required Example:

"59667344"

merchantId

The merchant ID corresponding to the allocation you want to release. Type: string — Required Example:

"01344351"

Example Request

curl --request POST \
  --url https://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/escrow/release \
  --header 'Content-Type: application/json' \
  --header 'x-api-secret: SplFeYdc/Hc5S1CGmVDtETLYUJY/10a38ejamzwb1YH30h+u8sOK2fpTlyKitpPk' \
  --data '{
    "escrowId": "59667344",
    "merchantId": "01344351"
  }'

Response

Success Response (`200 OK`)

{
  "status": "success",
  "timestamp": "2026-07-29T11:00:00Z",
  "message": "Escrow allocation released successfully",
  "data": {
    "escrowId": "59667344",
    "merchantId": "01344351",
    "amount": 3000,
    "releaseStatus": "RELEASED",
    "releasedAt": "2026-07-29T11:00:00Z"
  }
}

Notes & Best Practices

Partial Releases: If an order contains multiple merchant allocations, you can call this endpoint separately for each merchant as they fulfill their part of the order.
Idempotency: Releasing an allocation that has already been released will return the existing release confirmation or an error indicating the allocation was previously settled.
Unreleased Allocations: Any remaining unreleased allocations continue to be held securely in escrow until explicitly released or cancelled.

Headers

x-api-secret

string

required

Your StarPay API secret key.

Example:

"SplFeYdc/Hc5S1CGmVDtETLYUJY/10a38ejamzwb1YH30h+u8sOK2fpTlyKitpPk"

Body

application/json

Escrow ID and merchant ID identifying the allocation to release.

escrowId

string

required

Unique escrow transaction identifier.

Example:

"59667344"

merchantId

string

required

Merchant ID to receive payout.

Example:

"01344351"

Response

Escrow allocation released successfully.

status

string

required

Example:

"success"

timestamp

string<date-time>

required

Example:

"2026-07-29T11:00:00Z"

message

string

required

Example:

"Escrow allocation released successfully"

data

object

required

Show child attributes

Get started

Api Reference

Escrow Service

Merchant

Release Escrow Allocation

Release Escrow Allocation

Endpoint

Authentication

Request Body

escrowId

merchantId

Example Request

Response

Success Response (`200 OK`)

Notes & Best Practices

Headers

Body

Response

​Release Escrow Allocation

​Endpoint

​Authentication

​Request Body

​escrowId

​merchantId

​Example Request

​Response

​Success Response (200 OK)

​Notes & Best Practices

Headers

Body

Response

Release Escrow Allocation

Endpoint

Authentication

Request Body

escrowId

merchantId

Example Request

Response

Success Response (`200 OK`)

Notes & Best Practices