Escrow

Cancel an existing escrow transaction and initiate buyer refund if applicable.

post/trdp/escrow/cancel

Request

  • Base URL
    https://sandbox-api.starpayethiopia.com/v1/starpay-api
  • URL
    https://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/escrow/cancel
  • Auth
    none declared. Required headers: x-api-secret

Headers

x-api-secretstring required
Example:SplFeYdc/Hc5S1CGmVDtETLYUJY/10a38ejamzwb1YH30h+u8sOK2fpTlyKitpPk

Your StarPay API secret key.

Request body

escrowIdstring required

Unique escrow transaction identifier to cancel.

Example request

{
  "escrowId": "59667344"
}

Response

Escrow cancelled successfully.

statusstring required
timestampstring date-time required
messagestring required

Example response

{
  "status": "success",
  "timestamp": "2026-07-29T11:30:00Z",
  "message": "Escrow cancelled successfully",
  "data": {
    "escrow_id": "59667344",
    "status": "CANCELLED",
    "cancelled_at": "2026-07-29T11:30:00Z"
  }
}

Changes