Escrows API
An escrow holds the buyer's money until the buyer confirms the item arrived. A partner integration usually creates escrows from signed links; a marketplace that manages its own users can create them directly. The buyer pays through the checkout (Payments), the seller ships, and the buyer confirms, which releases the money to the seller's balance.
IDs in the examples on this page are sample UUIDs.
Endpoints
| Method | Path | Endpoint | Auth |
|---|---|---|---|
POST | /v1/escrows | Create an escrow | Key or session |
POST | /v1/escrows/from-link | Create an escrow from a signed link | Key or session |
GET | /v1/escrows | List your escrows | Key or session |
GET | /v1/escrows/stats | Get escrow totals | Key or session |
GET | /v1/escrows/:id | Get an escrow | Key or session |
GET | /v1/escrows/:id/preview | Preview an escrow | Optional |
POST | /v1/escrows/:id/join | Join an escrow | Key or session |
PATCH | /v1/escrows/:id/status | Change the status | Key or session |
POST | /v1/escrows/:id/send | Mark as shipped | Key or session |
POST | /v1/escrows/:id/confirm | Confirm receipt | Key or session |
POST | /v1/escrows/:id/release | Release the funds | Key or session |
POST | /v1/escrows/:id/cancel | Cancel an escrow | Key or session |
POST | /v1/escrows/:id/cancel-request | Ask to cancel a paid escrow | Key or session |
POST | /v1/escrows/:id/cancel-request/accept | Accept a cancel request | Key or session |
POST | /v1/escrows/:id/cancel-request/decline | Decline a cancel request | Key or session |
POST | /v1/escrows/:id/cancel-request/withdraw | Withdraw a cancel request | Key or session |
GET | /v1/escrows/:id/tracking | Get tracking | Key or session |
POST | /v1/escrows/:id/tracking | Add or change the tracking number | Key or session |
POST | /v1/escrows/:id/tracking/refresh | Refresh tracking | Key or session |
POST | /v1/escrows/:id/extend | Extend the auto-release timer | Key or session |
GET | /v1/escrows/:id/messages | List chat messages | Key or session |
POST | /v1/escrows/:id/messages | Send a chat message | Key or session |
POST | /v1/escrows/:id/rate | Rate the other party | Key or session |
GET | /v1/escrows/:id/my-rating | Get your rating | Key or session |
GET | /v1/escrows/:id/ratings | Get both ratings | Key or session |
Status flow
pending_payment -> pending_review -> paid -> sent -> received -> released
| | | |
+-> cancelled +-------+--------+-> disputed -> released / refunded / hold| Status | Meaning |
|---|---|
pending_payment | Created, waiting for the buyer to pay |
pending_review | The buyer says a manual transfer was made. RekberPay is checking it |
paid | Money is held. The seller can ship |
sent | The seller marked it shipped |
received | The buyer confirmed. Normally released in the same call |
released | The seller was paid (amount minus the fee) |
disputed | A party opened a dispute. RekberPay decides |
hold, refunded, cancelled | Held by RekberPay, refunded to the buyer, or cancelled before payment |
Who may do what: the seller sends (send) from paid; the buyer confirms (receive) from sent; either party disputes from paid, sent or received; either party cancels from pending_payment (not from pending_review: wait for RekberPay to finish checking the transfer). Someone can join the open seat while the escrow is pending_payment, pending_review or paid. Every write on this page honours Idempotency-Key except ratings.
Limits for accounts without KYC
An account that has not passed KYC and has no Akun Resmi badge can only take part in escrows up to three limits: an amount per escrow, a number of escrows per rolling 24 hours, and a lifetime total. RekberPay sets the values (by default Rp10.000.000 per escrow, 25 escrows per 24 hours and Rp10.000.000 in total). The limits apply when you create, join or pay into an escrow, on either side. An unpaid escrow you created or joined counts towards the total until it is cancelled, so cancel escrows that will not go ahead.
| Status | Code | When |
|---|---|---|
400 | NONKYC_LIMIT_AMOUNT | The amount is above the per-escrow limit |
429 | NONKYC_LIMIT_DAILY | The account reached its escrows for the last 24 hours |
403 | NONKYC_LIMIT_LIFETIME | The escrow would pass the lifetime total |
403 | NONKYC_LIMIT_COUNTERPARTY | From a signed link: the seller cannot take this escrow because of their own limits |
403 | NONKYC_LIMIT_SELLER_AT_PAYMENT | Paying a signed-link escrow: the seller has no room left in their total |
A refusal also carries limits, the caller's own view, so you can show what is left without a second call:
{
"success": false,
"error": {
"code": "NONKYC_LIMIT_AMOUNT",
"message": "Akun yang belum verifikasi KYC bisa membuat rekber maksimal Rp10.000.000 per transaksi. Verifikasi KYC untuk menaikkan batas."
},
"limits": {
"capped": true,
"kyc_status": "none",
"per_escrow_max": 10000000,
"daily_max": 25,
"used_24h": 3,
"lifetime_max": 10000000,
"lifetime_used": 1500000,
"lifetime_remaining": 8500000,
"lifetime_reserved_unpaid": 250000,
"lifetime_in_payment": 0
}
}lifetime_reserved_unpaid is the part held by the caller's own unpaid escrows and lifetime_in_payment the part held by payments in progress. An account without limits gets { "capped": false, "kyc_status": "verified" }. The messages never tell the buyer anything about the seller's KYC or usage.
Create an escrow
Creates an escrow with you as the buyer or the seller. Share the join_code or the escrow link with the other side; they take the open seat with POST /v1/escrows/:id/join. When you pass counterparty_email or counterparty_username, RekberPay also emails them an invite.
- Auth: A personal API key (
Authorization: Bearer <key>) or a session cookie withX-CSRF-Tokenon writes. - Who can call: Any signed-in user with a confirmed email and a complete profile (name, WhatsApp number and accepted Terms). You take the side named in
role; the other seat stays open until someone joins. - Rate limit: 20 escrows a minute per user, on top of the shared 300 requests a minute. A replayed
Idempotency-Keydoes not count. - Idempotency: Send an
Idempotency-Keyheader (UUID v4). A retry with the same key and body returns the first answer withIdempotent-Replay: true.
Body (JSON)
| Name | Type | Required | Description |
|---|---|---|---|
role | string | Yes | buyer or seller: your side of the deal |
item_name | string | Yes | 1 to 255 characters, no <, > or " |
amount | integer | Yes | Price in whole rupiah, 1,000 to 500,000,000. Decimals are refused |
category | string | No | goods (default), service or digital |
description | string | No | At most 3,000 characters |
counterparty_email | string | No | Email of the other side, for the invite |
counterparty_username | string | No | Username of the other side, used when no email is given. The escrow stores the user and username, never their email |
source_url | string | No | Link to the listing. Must start with http:// or https:// |
source_screenshot_url | string | No | A RekberPay media URL of a listing screenshot |
attachment_url | string | No | A file you uploaded with POST /v1/upload/escrow. It must be your own upload and not attached anywhere else yet |
deadline_at | string | No | ISO 8601 date-time with offset. Stored and shown only: RekberPay does not act on it. The real automatic release time is auto_completion on Get an escrow |
You cannot invite yourself: an email or username that is your own answers 400 SELF_COUNTERPARTY.
Example request
curl -X POST https://api.rekberpay.com/v1/escrows \
-H "Authorization: Bearer $REKBERPAY_API_KEY" \
-H "Idempotency-Key: 22222220-2222-4222-8222-222222222222" \
-H "Content-Type: application/json" \
-d '{
"role": "seller",
"item_name": "Kamera Fujifilm X-T30 bekas",
"amount": 250000,
"category": "goods",
"description": "Body only, shutter count 8.000, lengkap dengan dus.",
"attachment_url": "https://api.rekberpay.com/uploads/escrow/1791901398283_862e8cf475cf7693efed4855a91995d0_7e10e097a2087a40e3e8e3b659df3f65.png"
}'const res = await fetch('https://api.rekberpay.com/v1/escrows', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.REKBERPAY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': '22222220-2222-4222-8222-222222222222',
},
body: JSON.stringify({
role: "seller",
item_name: "Kamera Fujifilm X-T30 bekas",
amount: 250000,
category: "goods",
description: "Body only, shutter count 8.000, lengkap dengan dus.",
attachment_url: "https://api.rekberpay.com/uploads/escrow/1791901398283_862e8cf475cf7693efed4855a91995d0_7e10e097a2087a40e3e8e3b659df3f65.png"
}),
});
const data = await res.json();import os
import requests
resp = requests.post(
"https://api.rekberpay.com/v1/escrows",
headers={
"Authorization": f"Bearer {os.environ['REKBERPAY_API_KEY']}",
"Idempotency-Key": "22222220-2222-4222-8222-222222222222",
},
json={
"role": "seller",
"item_name": "Kamera Fujifilm X-T30 bekas",
"amount": 250000,
"category": "goods",
"description": "Body only, shutter count 8.000, lengkap dengan dus.",
"attachment_url": "https://api.rekberpay.com/uploads/escrow/1791901398283_862e8cf475cf7693efed4855a91995d0_7e10e097a2087a40e3e8e3b659df3f65.png",
},
timeout=30,
)
print(resp.status_code, resp.json())<?php
$ch = curl_init('https://api.rekberpay.com/v1/escrows');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('REKBERPAY_API_KEY'),
'Content-Type: application/json',
'Idempotency-Key: 22222220-2222-4222-8222-222222222222',
],
CURLOPT_POSTFIELDS => json_encode([
'role' => 'seller',
'item_name' => 'Kamera Fujifilm X-T30 bekas',
'amount' => 250000,
'category' => 'goods',
'description' => 'Body only, shutter count 8.000, lengkap dengan dus.',
'attachment_url' => 'https://api.rekberpay.com/uploads/escrow/1791901398283_862e8cf475cf7693efed4855a91995d0_7e10e097a2087a40e3e8e3b659df3f65.png',
]),
]);
$response = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);Example response
201 Created
{
"success": true,
"data": {
"id": "33333330-3333-4333-8333-333333333333",
"buyer_id": null,
"seller_id": "44444440-4444-4444-8444-444444444444",
"item_name": "Kamera Fujifilm X-T30 bekas",
"amount": "250000.00",
"description": "Body only, shutter count 8.000, lengkap dengan dus.",
"category": "goods",
"status": "pending_payment",
"counterparty_email": null,
"counterparty_username": null,
"source_url": null,
"source_screenshot_url": null,
"attachment_url": "https://api.rekberpay.com/uploads/escrow/1791901398283_862e8cf475cf7693efed4855a91995d0_7e10e097a2087a40e3e8e3b659df3f65.png?exp=1791979200000&sig=c0ffee5b1a9e3d7f4a2c8e6b0d9f1a3c5e7b9d1f3a5c7e9b1d3f5a7c9e1b3d5",
"deadline_at": null,
"auto_release_at": null,
"partner_ref": null,
"partner_sig_version": null,
"paid_at": null,
"released_at": null,
"refunded_at": null,
"cancelled_at": null,
"tracking_courier": null,
"tracking_number": null,
"tracking_status": null,
"tracking_last_checked_at": null,
"tracking_snapshot": null,
"created_at": "2026-10-13T14:23:18.305Z",
"updated_at": "2026-10-13T14:23:18.305Z",
"join_code": "RBP-B91XXZY0"
}
}| Field | Type | Description |
|---|---|---|
id | UUID | Escrow ID. Store it against your order |
status | string | pending_payment on creation |
amount | string | The amount with two decimals |
buyer_id | UUID | null | Filled for the buyer side, null until someone joins |
seller_id | UUID | null | Filled for the seller side, null until someone joins |
join_code | string | Short code the other side can use to find and join the escrow |
counterparty_username | string | null | The username you invited, when you passed counterparty_username |
Errors
| Status | Code | Cause |
|---|---|---|
400 | INVALID_BODY | A field failed validation. error.details.fieldErrors names it. An unknown counterparty_username also answers this, and so does a counterparty (by username, or an email that belongs to an account) that RekberPay suspended, flagged for fraud or is closing |
400 | SELF_COUNTERPARTY | counterparty_email or counterparty_username is your own account |
400 | UPLOAD_INVALID_REF, UPLOAD_NOT_FOUND, UPLOAD_NOT_OWNED, UPLOAD_WRONG_PURPOSE | attachment_url or source_screenshot_url is not one of your own escrow or chat uploads. See Uploads |
409 | UPLOAD_ALREADY_BOUND, UPLOAD_QUOTA | The file is already attached somewhere else, or the escrow has no room for more files. Upload it again |
400 | NONKYC_LIMIT_AMOUNT | Your account has no KYC yet and the amount is above the per-escrow limit. See Limits for accounts without KYC |
403 | EMAIL_NOT_VERIFIED | The account signed up with email and password and has not confirmed its email yet |
403 | NONKYC_LIMIT_LIFETIME | Your account has no KYC yet and this escrow would pass the lifetime total |
409 | PROFILE_INCOMPLETE | The account has no name or WhatsApp number yet, or has not accepted the Terms. The user finishes the profile at rekberpay.com |
409 | ACCOUNT_NOT_ACTIVE | Your account is not active |
429 | NONKYC_LIMIT_DAILY | Your account has no KYC yet and has reached its escrows for the last 24 hours |
500 | DB_ERROR | The escrow was not created. Retry with the same Idempotency-Key |
401 | UNAUTHORIZED, SESSION_EXPIRED, INVALID_TOKEN | No session or API key, the session expired, or the key is wrong or revoked |
401 | WORKSPACE_KEY_ONLY | A workspace key (rpe_...) was sent. Those only work under /v1/enterprise |
403 | CSRF_FAILED | Session call without the matching X-CSRF-Token header |
403 | ACCOUNT_INACTIVE, SUSPENDED | The account is closed, being deleted or suspended |
429 | RATE_LIMITED | Over the rate limit. Wait for Retry-After seconds |
A real INVALID_BODY answer:
400 Bad Request
{
"success": false,
"error": {
"code": "INVALID_BODY",
"message": "Validasi gagal",
"details": {
"formErrors": [],
"fieldErrors": {
"amount": [
"Too small: expected number to be >=1000"
]
}
}
}
}Create an escrow from a signed link
Creates an escrow from a partner link that you signed with HMAC-SHA256. The link carries the amount, seller, item and your order reference; the buyer's key or session makes the call. The escrow is always created at the signed amount. How to sign the link is in Authentication; the Quickstart runs the whole flow.
The API reads amount, seller, item, category, desc, ref, buyer, expires, v and sig from the link's query string and ignores anything else. v must be 1. The link host must be rekberpay.com or a partner host enabled for you.
- Auth: A personal API key (
Authorization: Bearer <key>) or a session cookie withX-CSRF-Tokenon writes. - Who can call: The buyer. The caller becomes the buyer; the seller comes from the signed
sellerparameter. - Rate limit: 300 requests a minute per user, shared by every route.
- Idempotency: Send an
Idempotency-Keyheader (UUID v4). A retry with the same key and body returns the first answer withIdempotent-Replay: true. - Replay: Every link expires (
expires, at most 30 days). A link that names abuyeris single use: a repeat call, with or without anIdempotency-Key, answers200 OKwith the escrow it already created andPartner-Link-Replay: true. A link withoutbuyeris a catalogue link: each call creates a new escrow, at most 3 per buyer and link every 10 minutes. See Replay.
Body (JSON)
| Name | Type | Required | Description |
|---|---|---|---|
link | string | Yes | The signed link, for example https://rekberpay.com/?amount=22500000&category=goods&expires=...&v=1&sig=... |
amount | integer | No | Optional echo of the signed amount. If sent, it must equal the amount in the link exactly, otherwise 422 AMOUNT_MISMATCH. The escrow always uses the signed amount |
Example request
curl -X POST https://api.rekberpay.com/v1/escrows/from-link \
-H "Authorization: Bearer $REKBERPAY_API_KEY" \
-H "Idempotency-Key: fffffff1-ffff-4fff-8fff-ffffffffffff" \
-H "Content-Type: application/json" \
-d '{
"link": "https://rekberpay.com/?amount=22500000&category=goods&expires=1792506198&item=iPhone%2015%20Pro%20256GB&ref=MARKETPLACE_398882&seller=44444440-4444-4444-8444-444444444444&v=1&sig=9d41c7a2e8b5f30c6a1d4e7b2f9c8a0d3e5b6c71f4a2d8e9b0c3a5f7d1e6b42c"
}'const res = await fetch('https://api.rekberpay.com/v1/escrows/from-link', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.REKBERPAY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': 'fffffff1-ffff-4fff-8fff-ffffffffffff',
},
body: JSON.stringify({
link: "https://rekberpay.com/?amount=22500000&category=goods&expires=1792506198&item=iPhone%2015%20Pro%20256GB&ref=MARKETPLACE_398882&seller=44444440-4444-4444-8444-444444444444&v=1&sig=9d41c7a2e8b5f30c6a1d4e7b2f9c8a0d3e5b6c71f4a2d8e9b0c3a5f7d1e6b42c",
}),
});
const data = await res.json();import os
import requests
resp = requests.post(
"https://api.rekberpay.com/v1/escrows/from-link",
headers={
"Authorization": f"Bearer {os.environ['REKBERPAY_API_KEY']}",
"Idempotency-Key": "fffffff1-ffff-4fff-8fff-ffffffffffff",
},
json={
"link": "https://rekberpay.com/?amount=22500000&category=goods&expires=1792506198&item=iPhone%2015%20Pro%20256GB&ref=MARKETPLACE_398882&seller=44444440-4444-4444-8444-444444444444&v=1&sig=9d41c7a2e8b5f30c6a1d4e7b2f9c8a0d3e5b6c71f4a2d8e9b0c3a5f7d1e6b42c",
},
timeout=30,
)
print(resp.status_code, resp.json())<?php
$ch = curl_init('https://api.rekberpay.com/v1/escrows/from-link');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('REKBERPAY_API_KEY'),
'Content-Type: application/json',
'Idempotency-Key: fffffff1-ffff-4fff-8fff-ffffffffffff',
],
CURLOPT_POSTFIELDS => json_encode([
'link' => 'https://rekberpay.com/?amount=22500000&category=goods&expires=1792506198&item=iPhone%2015%20Pro%20256GB&ref=MARKETPLACE_398882&seller=44444440-4444-4444-8444-444444444444&v=1&sig=9d41c7a2e8b5f30c6a1d4e7b2f9c8a0d3e5b6c71f4a2d8e9b0c3a5f7d1e6b42c',
]),
]);
$response = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);Example response
201 Created
{
"success": true,
"data": {
"id": "11111112-1111-4111-8111-111111111111",
"buyer_id": "11111110-1111-4111-8111-111111111111",
"seller_id": "44444440-4444-4444-8444-444444444444",
"item_name": "iPhone 15 Pro 256GB",
"amount": "22500000.00",
"description": "",
"category": "goods",
"status": "pending_payment",
"counterparty_email": null,
"counterparty_username": null,
"source_url": null,
"source_screenshot_url": null,
"attachment_url": null,
"deadline_at": null,
"auto_release_at": null,
"partner_ref": "MARKETPLACE_398882",
"partner_sig_version": 1,
"paid_at": null,
"released_at": null,
"refunded_at": null,
"cancelled_at": null,
"tracking_courier": null,
"tracking_number": null,
"tracking_status": null,
"tracking_last_checked_at": null,
"tracking_snapshot": null,
"created_at": "2026-10-13T14:23:18.887Z",
"updated_at": "2026-10-13T14:23:18.887Z"
}
}partner_ref is the ref from the link, stored for your reconciliation. amount is the signed amount from the link. The buyer's checkout page is https://rekberpay.com/escrow/<id>/pay.
What a repeat call does depends on the link:
- Single-use link (it names a
buyer): any repeat call answers200 OKwith the escrow it already created and the headerPartner-Link-Replay: true. - Catalogue link (no
buyer):partner_refis not a uniqueness key. The same link sent again with a newIdempotency-Keycreates another escrow (up to 3 per buyer and link every 10 minutes). A retry with the sameIdempotency-Keyreturns the stored answer.
Errors
| Status | Code | Cause |
|---|---|---|
400 | INVALID_BODY | link missing or not a valid URL, or a body amount that is not an integer from 1,000 to 500,000,000 |
400 | INVALID_URL | link is not a URL |
400 | SIGNATURE_REQUIRED | The link has partner parameters, amount included, but no sig |
400 | INVALID_ENCODING | item or desc has broken percent-encoding |
422 | HOST_NOT_ALLOWED | The link host is not permitted |
422 | UNSUPPORTED_SIG_VERSION | v is not 1 |
422 | SIG_INCOMPLETE | A signed link needs amount, ref, expires and v |
422 | INVALID_EXPIRES, LINK_EXPIRED, EXPIRES_TOO_FAR | expires is not a unix time, is in the past, or is more than 30 days away |
422 | SIG_MISMATCH | The signature does not match |
422 | INVALID_AMOUNT | The signed amount is not plain digits from 1000 to 500000000 |
422 | AMOUNT_MISMATCH | A body amount was sent and does not equal the signed amount |
422 | INVALID_SELLER, SELLER_NOT_FOUND, SELLER_IS_BUYER | seller is not a UUID v4, does not exist, or is the caller |
422 | BUYER_MISMATCH | The link names a buyer who is not the caller |
422 | INVALID_REF | ref is longer than 64 characters |
409 | LINK_ALREADY_USED | The single-use link was already used and its escrow is gone |
409 | COUNTERPARTY_SUSPENDED | The seller is suspended, flagged for fraud or closing its account |
429 | LINK_USE_LIMITED | This buyer already made 3 escrows from this catalogue link in the last 10 minutes |
400, 403, 429 | NONKYC_LIMIT_AMOUNT, NONKYC_LIMIT_LIFETIME, NONKYC_LIMIT_DAILY | The caller has no KYC yet and is over a limit. See Limits for accounts without KYC |
403 | NONKYC_LIMIT_COUNTERPARTY | The seller cannot take this escrow because of their own limits. |
403 | EMAIL_NOT_VERIFIED | The caller signed up with email and password and has not confirmed the email yet |
409 | PROFILE_INCOMPLETE | The caller has no name or WhatsApp number yet, or has not accepted the Terms |
409 | ACCOUNT_NOT_ACTIVE | The buyer or the seller account is not active |
422 | INVALID_CATEGORY, INVALID_ITEM | category is not allowed, or item is empty |
500 | DB_ERROR | The escrow was not created. Retry with the same Idempotency-Key |
503 | LINK_SIGNING_NOT_CONFIGURED | Link signing is not available right now |
401 | UNAUTHORIZED, SESSION_EXPIRED, INVALID_TOKEN | No session or API key, the session expired, or the key is wrong or revoked |
401 | WORKSPACE_KEY_ONLY | A workspace key (rpe_...) was sent. Those only work under /v1/enterprise |
403 | CSRF_FAILED | Session call without the matching X-CSRF-Token header |
403 | ACCOUNT_INACTIVE, SUSPENDED | The account is closed, being deleted or suspended |
429 | RATE_LIMITED | Over the rate limit. Wait for Retry-After seconds |
A real SIG_MISMATCH answer:
422 Unprocessable Entity
{
"success": false,
"error": {
"code": "SIG_MISMATCH",
"message": "Signature verification failed."
}
}List your escrows
Escrows where you are the buyer or the seller, newest first. Each item adds user_role (buyer or seller).
- Auth: A personal API key (
Authorization: Bearer <key>) or a session cookie withX-CSRF-Tokenon writes. - Rate limit: 300 requests a minute per user, shared by every route.
- Idempotency: Not needed. Reading has no side effects.
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
status | string | No | Only this status, for example paid |
active | string | No | 1 for escrows still in progress. Takes precedence over status |
q | string | No | Search on ID prefix, item name and category. Up to 60 characters |
fields | string | No | summary for a lighter list: only id, buyer_id, seller_id, item_name, amount, status, created_at, dispute_resolution, user_role and other_username (the other party's username, null before they join) |
page | integer | No | Default 1 |
limit | integer | No | 1 to 50. Default 20 |
active=1 covers pending_payment, pending_review, paid, sent, received, hold and disputed. dispute_resolution is set on a released or refunded escrow that ended through a dispute: buyer_win, seller_win or split (the money was divided). It is null otherwise.
Example request
curl "https://api.rekberpay.com/v1/escrows?limit=3" \
-H "Authorization: Bearer $REKBERPAY_API_KEY"const res = await fetch('https://api.rekberpay.com/v1/escrows?limit=3', {
headers: {
Authorization: `Bearer ${process.env.REKBERPAY_API_KEY}`,
},
});
const data = await res.json();import os
import requests
resp = requests.get(
"https://api.rekberpay.com/v1/escrows?limit=3",
headers={
"Authorization": f"Bearer {os.environ['REKBERPAY_API_KEY']}",
},
timeout=30,
)
print(resp.status_code, resp.json())<?php
$ch = curl_init('https://api.rekberpay.com/v1/escrows?limit=3');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('REKBERPAY_API_KEY'),
],
]);
$response = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);Example response
200 OK
{
"success": true,
"data": [
{
"id": "11111112-1111-4111-8111-111111111111",
"buyer_id": "11111110-1111-4111-8111-111111111111",
"seller_id": "44444440-4444-4444-8444-444444444444",
"item_name": "iPhone 15 Pro 256GB",
"amount": "22500000.00",
"description": "",
"category": "goods",
"status": "pending_payment",
"counterparty_email": null,
"counterparty_username": null,
"source_url": null,
"source_screenshot_url": null,
"attachment_url": null,
"deadline_at": null,
"created_at": "2026-10-13T14:23:18.887Z",
"updated_at": "2026-10-13T14:23:18.887Z",
"dispute_resolution": null,
"user_role": "buyer"
},
{
"id": "ddddddd1-dddd-4ddd-8ddd-dddddddddddd",
"buyer_id": "11111110-1111-4111-8111-111111111111",
"seller_id": null,
"item_name": "Sepatu lari ukuran 42",
"amount": "450000.00",
"description": "",
"category": "goods",
"status": "cancelled",
"counterparty_email": null,
"counterparty_username": null,
"source_url": null,
"source_screenshot_url": null,
"attachment_url": null,
"deadline_at": null,
"created_at": "2026-10-13T14:23:18.869Z",
"updated_at": "2026-10-13T14:23:18.874Z",
"dispute_resolution": null,
"user_role": "buyer"
},
{
"id": "55555551-5555-4555-8555-555555555555",
"buyer_id": "11111110-1111-4111-8111-111111111111",
"seller_id": "44444440-4444-4444-8444-444444444444",
"item_name": "Jasa desain logo toko",
"amount": "300000.00",
"description": "",
"category": "service",
"status": "disputed",
"counterparty_email": "[email protected]",
"counterparty_username": null,
"source_url": null,
"source_screenshot_url": null,
"attachment_url": null,
"deadline_at": null,
"created_at": "2026-10-13T14:23:18.794Z",
"updated_at": "2026-10-13T14:23:18.823Z",
"dispute_resolution": null,
"user_role": "buyer"
}
],
"pagination": {
"page": 1,
"limit": 3,
"total": 4,
"total_pages": 2
}
}Errors
| Status | Code | Cause |
|---|---|---|
401 | UNAUTHORIZED, SESSION_EXPIRED, INVALID_TOKEN | No session or API key, the session expired, or the key is wrong or revoked |
401 | WORKSPACE_KEY_ONLY | A workspace key (rpe_...) was sent. Those only work under /v1/enterprise |
403 | ACCOUNT_INACTIVE, SUSPENDED | The account is closed, being deleted or suspended |
429 | RATE_LIMITED | Over the rate limit. Wait for Retry-After seconds |
Get escrow totals
Counts and rupiah totals across your escrows, for a dashboard header.
- Auth: A personal API key (
Authorization: Bearer <key>) or a session cookie withX-CSRF-Tokenon writes. - Rate limit: 300 requests a minute per user, shared by every route.
- Idempotency: Not needed. Reading has no side effects.
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
dashboard | string | No | 1 adds chart data: daily (7 items, oldest first, each { days_ago, count, amount } for a rolling 24 hour window), status_counts (escrows per status, only statuses with at least one), pending_payment_value (rupiah waiting for payment) and released_this_month_value (rupiah released since the start of this month, Jakarta time) |
Example request
curl https://api.rekberpay.com/v1/escrows/stats \
-H "Authorization: Bearer $REKBERPAY_API_KEY"const res = await fetch('https://api.rekberpay.com/v1/escrows/stats', {
headers: {
Authorization: `Bearer ${process.env.REKBERPAY_API_KEY}`,
},
});
const data = await res.json();import os
import requests
resp = requests.get(
"https://api.rekberpay.com/v1/escrows/stats",
headers={
"Authorization": f"Bearer {os.environ['REKBERPAY_API_KEY']}",
},
timeout=30,
)
print(resp.status_code, resp.json())<?php
$ch = curl_init('https://api.rekberpay.com/v1/escrows/stats');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('REKBERPAY_API_KEY'),
],
]);
$response = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);Example response
200 OK
{
"success": true,
"data": {
"total_transactions": 4,
"total_value": 23500000,
"active_escrows": 2,
"disputed_count": 1,
"released_value": 250000,
"held_value": 300000,
"buyer_held_value": 300000,
"seller_receivable_value": 0,
"active_value": 300000,
"pending_review_value": 0
}
}| Field | Type | Description |
|---|---|---|
total_transactions | integer | Escrows you are part of |
total_value | number | Rupiah across all of them |
active_escrows | integer | Escrows still in progress |
disputed_count | integer | Escrows in dispute |
held_value | number | Your own money held as a buyer (same as buyer_held_value) |
seller_receivable_value | number | Money held for you as a seller |
active_value | number | Money RekberPay holds across your escrows in progress |
pending_review_value | number | Manual transfers you reported as a buyer that RekberPay has not confirmed yet. Not counted as held |
released_value | number | Total released |
Errors
| Status | Code | Cause |
|---|---|---|
401 | UNAUTHORIZED, SESSION_EXPIRED, INVALID_TOKEN | No session or API key, the session expired, or the key is wrong or revoked |
401 | WORKSPACE_KEY_ONLY | A workspace key (rpe_...) was sent. Those only work under /v1/enterprise |
403 | ACCOUNT_INACTIVE, SUSPENDED | The account is closed, being deleted or suspended |
429 | RATE_LIMITED | Over the rate limit. Wait for Retry-After seconds |
Get an escrow
The full state of one escrow: status and timestamps, both parties' names and emails, join_code, available_actions (what you can do next), auto_completion (the next automatic release or refund, if any), extend_info, the payment summary and the tracking fields.
- Auth: A personal API key (
Authorization: Bearer <key>) or a session cookie withX-CSRF-Tokenon writes. - Who can call: The buyer or the seller.
- Rate limit: 300 requests a minute per user, shared by every route.
- Idempotency: Not needed. Reading has no side effects.
Path parameters
| Name | Type | Description |
|---|---|---|
id | UUID | The escrow ID |
Example request
curl https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333 \
-H "Authorization: Bearer $REKBERPAY_API_KEY"const res = await fetch('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333', {
headers: {
Authorization: `Bearer ${process.env.REKBERPAY_API_KEY}`,
},
});
const data = await res.json();import os
import requests
resp = requests.get(
"https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333",
headers={
"Authorization": f"Bearer {os.environ['REKBERPAY_API_KEY']}",
},
timeout=30,
)
print(resp.status_code, resp.json())<?php
$ch = curl_init('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('REKBERPAY_API_KEY'),
],
]);
$response = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);Example response
200 OK
{
"success": true,
"data": {
"id": "33333330-3333-4333-8333-333333333333",
"buyer_id": "11111110-1111-4111-8111-111111111111",
"seller_id": "44444440-4444-4444-8444-444444444444",
"item_name": "Kamera Fujifilm X-T30 bekas",
"amount": "250000.00",
"description": "Body only, shutter count 8.000, lengkap dengan dus.",
"category": "goods",
"status": "sent",
"counterparty_email": null,
"counterparty_username": null,
"source_url": null,
"source_screenshot_url": null,
"attachment_url": "https://api.rekberpay.com/uploads/escrow/1791901398283_862e8cf475cf7693efed4855a91995d0_7e10e097a2087a40e3e8e3b659df3f65.png?exp=1791979200000&sig=c0ffee5b1a9e3d7f4a2c8e6b0d9f1a3c5e7b9d1f3a5c7e9b1d3f5a7c9e1b3d5",
"deadline_at": null,
"auto_release_at": null,
"delivered_at": null,
"paid_at": "2026-10-13T14:23:18.363Z",
"released_at": null,
"tracking_courier": "jne",
"tracking_number": "CGK0123456789",
"tracking_status": "On Process",
"tracking_last_checked_at": "2026-10-13T14:23:18.721Z",
"custom_delivery_days": null,
"auto_release_extend_count": 0,
"created_at": "2026-10-13T14:23:18.305Z",
"updated_at": "2026-10-13T14:23:18.721Z",
"dispute_resolution": null,
"buyer_email": "[email protected]",
"buyer_full_name": "Rina Wijaya",
"buyer_username": "rina.wijaya",
"seller_email": null,
"seller_full_name": "Budi Santoso",
"seller_username": "budi.santoso",
"join_code": "RBP-B91XXZY0",
"auto_completion": {
"kind": "auto_release_after_delivery",
"at": null,
"pendingEvent": true
},
"extend_info": {
"max_count": 1,
"hours": 48,
"used": 0,
"can_extend": false
},
"user_role": "buyer",
"available_actions": [
"receive",
"dispute"
],
"payment_amount": 250000,
"payment_provider": "manual_qris",
"payment_method": "qris",
"payment_surcharge": 0,
"tracking": {
"courier": "jne",
"courier_name": "JNE",
"number": "CGK0123456789",
"status": "On Process",
"last_checked_at": "2026-10-13T14:23:18.721Z",
"track_url": "https://www.jne.co.id/id/tracking/trace?awb=CGK0123456789"
}
}
}| Field | Type | Description |
|---|---|---|
user_role | string | Your side: buyer or seller |
available_actions | string[] | Actions you can take now: pay and cancel (buyer, pending_payment), cancel (seller, pending_payment), send (seller, paid), receive (buyer, sent), release (buyer, received), dispute (both, paid, sent or received). Empty in every other status |
join_code | string | The short code the other side can use to join. Only parties see it |
buyer_email, seller_email | string | null | Only your own email is filled. The other party is shown by name and username |
auto_completion | object | The next automatic step: kind, at and pendingEvent. See below |
extend_info | object | null | max_count, hours and used for the buyer's extensions, and can_extend. null when the settings could not be read |
payment_amount, payment_provider, payment_method | number, string, string | The latest payment attempt: what the buyer pays, through which gateway and method. Left out before any payment was started |
payment_surcharge | integer | What the latest payment adds on top of the escrow amount. 0 without a payment |
tracking | object | null | The saved courier and AWB with the courier's own track_url. The live journey is in Get tracking |
cancel_request | object | null | The open request to cancel by agreement: requested_by (buyer or seller), requested_at, expires_at and reason. null when there is none or it lapsed |
dispute_resolution | string | null | buyer_win, seller_win or split when a released or refunded escrow ended through a dispute |
released_at | string | null | When the money was released to the seller |
auto_completion.kind is one of:
| Kind | What happens |
|---|---|
auto_refund_unshipped | Paid, not shipped yet. If the seller does not ship by at, the buyer is refunded. The payment fee is not returned; payment_fee shows how much it was |
auto_release_digital | Service or digital item sent. Released to the seller at at unless the buyer confirms or disputes first |
auto_release_no_tracking | Goods sent without a trackable courier. Released at at |
auto_release_after_delivery | Goods sent with a trackable courier, not delivered yet. at is null and pendingEvent is true until the courier reports delivery |
auto_release_delivered | The courier reported delivery. Released at at |
none | Nothing automatic is planned (not paid yet, disputed, on hold or finished) |
Errors
| Status | Code | Cause |
|---|---|---|
403 | FORBIDDEN | You are not a party to the escrow |
404 | NOT_FOUND | No escrow with this ID |
401 | UNAUTHORIZED, SESSION_EXPIRED, INVALID_TOKEN | No session or API key, the session expired, or the key is wrong or revoked |
401 | WORKSPACE_KEY_ONLY | A workspace key (rpe_...) was sent. Those only work under /v1/enterprise |
403 | ACCOUNT_INACTIVE, SUSPENDED | The account is closed, being deleted or suspended |
429 | RATE_LIMITED | Over the rate limit. Wait for Retry-After seconds |
Preview an escrow
A small public view for share and invite links: item, amount, status, which seats are filled and the parties' public usernames. Names and emails are only filled in for a party. User IDs are never returned.
- Auth: Optional. It works signed out; with a session or API key it also tells you whether you are a party.
- Rate limit: 100 requests a minute per IP address.
- Idempotency: Not needed. Reading has no side effects.
Path parameters
| Name | Type | Description |
|---|---|---|
id | UUID | The escrow ID |
Example request
curl https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/previewconst res = await fetch('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/preview', {
});
const data = await res.json();import os
import requests
resp = requests.get(
"https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/preview",
timeout=30,
)
print(resp.status_code, resp.json())<?php
$ch = curl_init('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/preview');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
]);
$response = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);Example response
200 OK
{
"success": true,
"data": {
"id": "33333330-3333-4333-8333-333333333333",
"item_name": "Kamera Fujifilm X-T30 bekas",
"description": "Body only, shutter count 8.000, lengkap dengan dus.",
"amount": "250000.00",
"status": "pending_payment",
"category": "goods",
"has_buyer": false,
"has_seller": true,
"is_party": false,
"buyer_full_name": null,
"buyer_username": null,
"buyer_email": null,
"seller_full_name": null,
"seller_username": "budi.santoso",
"seller_email": null,
"buyer_account_status": null,
"seller_account_status": "active",
"buyer_fraud_flagged_at": null,
"seller_fraud_flagged_at": null,
"created_at": "2026-10-13T14:23:18.305Z"
}
}| Field | Type | Description |
|---|---|---|
has_buyer | boolean | Whether the buyer seat is filled |
has_seller | boolean | Whether the seller seat is filled |
is_party | boolean | true when the caller is the buyer or the seller |
buyer_account_status, seller_account_status | string | null | active, suspended, fraud_flagged or unavailable (closing its account); null for an empty seat. Anything but active cannot be joined or paid |
buyer_fraud_flagged_at, seller_fraud_flagged_at | string | null | When a fraud_flagged party was flagged, for a warning. null for everyone else |
buyer_username, seller_username | string | null | Public usernames, shown to anyone. buyer_full_name, seller_full_name and the emails stay null unless you are a party (and you only see your own email) |
Errors
| Status | Code | Cause |
|---|---|---|
404 | NOT_FOUND | No escrow with this ID |
429 | RATE_LIMITED | Over the rate limit. Wait for Retry-After seconds |
Join an escrow
Takes the open seat of an escrow that someone else created. Anyone with the link can join, so share it only with your counterparty. Joining works while the escrow is pending_payment, pending_review or paid. The body is ignored; send {}.
- Auth: A personal API key (
Authorization: Bearer <key>) or a session cookie withX-CSRF-Tokenon writes. - Who can call: Any signed-in user with a confirmed email and a complete profile who is not already a party. You take the empty seat.
- Rate limit: 300 requests a minute per user, shared by every route.
- Idempotency: Send an
Idempotency-Keyheader (UUID v4). A retry with the same key and body returns the first answer withIdempotent-Replay: true.
Path parameters
| Name | Type | Description |
|---|---|---|
id | UUID | The escrow ID |
Example request
curl -X POST https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/join \
-H "Authorization: Bearer $REKBERPAY_API_KEY" \
-H "Idempotency-Key: 55555550-5555-4555-8555-555555555555" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/join', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.REKBERPAY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': '55555550-5555-4555-8555-555555555555',
},
body: JSON.stringify({}),
});
const data = await res.json();import os
import requests
resp = requests.post(
"https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/join",
headers={
"Authorization": f"Bearer {os.environ['REKBERPAY_API_KEY']}",
"Idempotency-Key": "55555550-5555-4555-8555-555555555555",
},
json={},
timeout=30,
)
print(resp.status_code, resp.json())<?php
$ch = curl_init('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/join');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('REKBERPAY_API_KEY'),
'Content-Type: application/json',
'Idempotency-Key: 55555550-5555-4555-8555-555555555555',
],
CURLOPT_POSTFIELDS => json_encode(new stdClass()),
]);
$response = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);Example response
200 OK
{
"success": true,
"data": {
"id": "33333330-3333-4333-8333-333333333333",
"buyer_id": "11111110-1111-4111-8111-111111111111",
"seller_id": "44444440-4444-4444-8444-444444444444",
"item_name": "Kamera Fujifilm X-T30 bekas",
"amount": "250000.00",
"description": "Body only, shutter count 8.000, lengkap dengan dus.",
"category": "goods",
"status": "pending_payment",
"counterparty_email": null,
"counterparty_username": null,
"source_url": null,
"source_screenshot_url": null,
"attachment_url": "https://api.rekberpay.com/uploads/escrow/1791901398283_862e8cf475cf7693efed4855a91995d0_7e10e097a2087a40e3e8e3b659df3f65.png?exp=1791979200000&sig=c0ffee5b1a9e3d7f4a2c8e6b0d9f1a3c5e7b9d1f3a5c7e9b1d3f5a7c9e1b3d5",
"deadline_at": null,
"auto_release_at": null,
"partner_ref": null,
"partner_sig_version": null,
"paid_at": null,
"released_at": null,
"refunded_at": null,
"cancelled_at": null,
"tracking_courier": null,
"tracking_number": null,
"tracking_status": null,
"tracking_last_checked_at": null,
"tracking_snapshot": null,
"created_at": "2026-10-13T14:23:18.305Z",
"updated_at": "2026-10-13T14:23:18.320Z"
}
}Errors
| Status | Code | Cause |
|---|---|---|
404 | NOT_FOUND | No escrow with this ID |
409 | ALREADY_PARTY | You are already the buyer or the seller |
409 | FULL | Both seats are taken |
409 | NOT_JOINABLE | The escrow is past paid, or was cancelled |
409 | SEAT_TAKEN | Someone else took the seat at the same moment |
409 | COUNTERPARTY_SUSPENDED | The party already in the escrow is suspended, flagged for fraud or closing its account. Paying into the open seat answers the same |
409 | ACCOUNT_NOT_ACTIVE | Your account or the other party's is not active |
409 | PROFILE_INCOMPLETE | Your account has no name or WhatsApp number yet, or has not accepted the Terms |
400, 403, 429 | NONKYC_LIMIT_AMOUNT, NONKYC_LIMIT_LIFETIME, NONKYC_LIMIT_DAILY | Your account has no KYC yet and is over a limit. See Limits for accounts without KYC |
403 | EMAIL_NOT_VERIFIED | You signed up with email and password and have not confirmed the email yet |
401 | UNAUTHORIZED, SESSION_EXPIRED, INVALID_TOKEN | No session or API key, the session expired, or the key is wrong or revoked |
401 | WORKSPACE_KEY_ONLY | A workspace key (rpe_...) was sent. Those only work under /v1/enterprise |
403 | CSRF_FAILED | Session call without the matching X-CSRF-Token header |
403 | ACCOUNT_INACTIVE, SUSPENDED | The account is closed, being deleted or suspended |
429 | RATE_LIMITED | Over the rate limit. Wait for Retry-After seconds |
A real ALREADY_PARTY answer:
409 Conflict
{
"success": false,
"error": {
"code": "ALREADY_PARTY",
"message": "Anda sudah terdaftar sebagai pihak dalam escrow ini"
}
}Change the status
One endpoint for the status actions. {"action": "send"} does the same as POST /v1/escrows/:id/send, and so on for receive, release, dispute and cancel. Prefer the dedicated endpoints below; they read better in logs.
- Auth: A personal API key (
Authorization: Bearer <key>) or a session cookie withX-CSRF-Tokenon writes. - Who can call: The buyer or the seller, for the actions their side may take.
- Rate limit: 300 requests a minute per user, shared by every route.
- Idempotency: Send an
Idempotency-Keyheader (UUID v4). A retry with the same key and body returns the first answer withIdempotent-Replay: true.
Path parameters
| Name | Type | Description |
|---|---|---|
id | UUID | The escrow ID |
Body (JSON)
| Name | Type | Required | Description |
|---|---|---|---|
action | string | Yes | send, receive, release, dispute or cancel |
courier, tracking_number, custom_delivery_days | string, string, integer | No | With send: the same fields as Mark as shipped |
reason_category, description | string | No | With dispute: the same fields as Open a dispute, but both optional. Without them the dispute is opened as other with a short default text; a missing description takes a default text for the category. The answer adds dispute_id |
receive sent twice is safe: when the escrow is already received or released, the answer is 200 OK with its current state.
Example request
curl -X PATCH https://api.rekberpay.com/v1/escrows/bbbbbbb1-bbbb-4bbb-8bbb-bbbbbbbbbbbb/status \
-H "Authorization: Bearer $REKBERPAY_API_KEY" \
-H "Idempotency-Key: ccccccc1-cccc-4ccc-8ccc-cccccccccccc" \
-H "Content-Type: application/json" \
-d '{
"action": "cancel"
}'const res = await fetch('https://api.rekberpay.com/v1/escrows/bbbbbbb1-bbbb-4bbb-8bbb-bbbbbbbbbbbb/status', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${process.env.REKBERPAY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': 'ccccccc1-cccc-4ccc-8ccc-cccccccccccc',
},
body: JSON.stringify({
action: "cancel"
}),
});
const data = await res.json();import os
import requests
resp = requests.patch(
"https://api.rekberpay.com/v1/escrows/bbbbbbb1-bbbb-4bbb-8bbb-bbbbbbbbbbbb/status",
headers={
"Authorization": f"Bearer {os.environ['REKBERPAY_API_KEY']}",
"Idempotency-Key": "ccccccc1-cccc-4ccc-8ccc-cccccccccccc",
},
json={
"action": "cancel",
},
timeout=30,
)
print(resp.status_code, resp.json())<?php
$ch = curl_init('https://api.rekberpay.com/v1/escrows/bbbbbbb1-bbbb-4bbb-8bbb-bbbbbbbbbbbb/status');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('REKBERPAY_API_KEY'),
'Content-Type: application/json',
'Idempotency-Key: ccccccc1-cccc-4ccc-8ccc-cccccccccccc',
],
CURLOPT_POSTFIELDS => json_encode([
'action' => 'cancel',
]),
]);
$response = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);Example response
200 OK
{
"success": true,
"data": {
"id": "bbbbbbb1-bbbb-4bbb-8bbb-bbbbbbbbbbbb",
"buyer_id": null,
"seller_id": "44444440-4444-4444-8444-444444444444",
"item_name": "Voucher game 100K",
"amount": "100000.00",
"description": "",
"category": "digital",
"status": "cancelled",
"counterparty_email": null,
"counterparty_username": null,
"source_url": null,
"source_screenshot_url": null,
"attachment_url": null,
"deadline_at": null,
"auto_release_at": null,
"partner_ref": null,
"partner_sig_version": null,
"paid_at": null,
"released_at": null,
"refunded_at": null,
"cancelled_at": "2026-10-13T14:23:18.859Z",
"tracking_courier": null,
"tracking_number": null,
"tracking_status": null,
"tracking_last_checked_at": null,
"tracking_snapshot": null,
"created_at": "2026-10-13T14:23:18.853Z",
"updated_at": "2026-10-13T14:23:18.859Z",
"user_role": "seller",
"available_actions": []
}
}Errors
| Status | Code | Cause |
|---|---|---|
400 | INVALID_BODY | action is missing |
403 | ACTION_NOT_ALLOWED | The action is not one of the five above |
400 | INVALID_STATUS | dispute while the escrow is not paid, sent or received |
400 | INVALID_CATEGORY, INVALID_DESCRIPTION | dispute with an unknown reason_category, or a description that is not text or is over 3,000 characters |
409 | ACCOUNT_NOT_ACTIVE | dispute while one of the parties is not active |
409 | PAYMENT_IN_PROGRESS | cancel while a payment is still open. See Cancel an escrow |
403 | NOT_A_PARTY | You are not the buyer or the seller |
404 | NOT_FOUND | No escrow with this ID |
400 | INVALID_TRANSITION | The action is not allowed from the current status for your side of the escrow |
409 | CONCURRENT_MODIFICATION | The escrow changed while the call ran (for example an action by RekberPay). Read it again |
401 | UNAUTHORIZED, SESSION_EXPIRED, INVALID_TOKEN | No session or API key, the session expired, or the key is wrong or revoked |
401 | WORKSPACE_KEY_ONLY | A workspace key (rpe_...) was sent. Those only work under /v1/enterprise |
403 | CSRF_FAILED | Session call without the matching X-CSRF-Token header |
403 | ACCOUNT_INACTIVE, SUSPENDED | The account is closed, being deleted or suspended |
429 | RATE_LIMITED | Over the rate limit. Wait for Retry-After seconds |
A real INVALID_TRANSITION answer:
400 Bad Request
{
"success": false,
"error": {
"code": "INVALID_TRANSITION",
"message": "Aksi \"release\" tidak valid dari status \"cancelled\" sebagai seller"
}
}Mark as shipped
Marks the item as sent. For physical goods you can attach the courier and tracking number (resi) here or later with POST /v1/escrows/:id/tracking. With a trackable courier the release timer waits for the courier to report delivery. For a courier that cannot be tracked, send custom_delivery_days, the expected transit time, so the buyer's timer has an end.
- Auth: A personal API key (
Authorization: Bearer <key>) or a session cookie withX-CSRF-Tokenon writes. - Who can call: The seller, once the escrow is
paid. - Rate limit: 300 requests a minute per user, shared by every route.
- Idempotency: Send an
Idempotency-Keyheader (UUID v4). A retry with the same key and body returns the first answer withIdempotent-Replay: true.
Path parameters
| Name | Type | Description |
|---|---|---|
id | UUID | The escrow ID |
Body (JSON)
| Name | Type | Required | Description |
|---|---|---|---|
courier | string | No | Courier slug from the couriers list in Get tracking, for example jne. Needs tracking_number |
tracking_number | string | No | AWB, 3 to 64 characters. Needs courier |
custom_delivery_days | integer | No | Expected transit days for goods without a trackable courier, 1 to limits.custom_delivery_max_days from Get tracking. Required when you send an AWB of a courier that cannot be tracked. Not allowed for service or digital escrows or with a trackable courier |
Example request
curl -X POST https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/send \
-H "Authorization: Bearer $REKBERPAY_API_KEY" \
-H "Idempotency-Key: 99999990-9999-4999-8999-999999999999" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/send', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.REKBERPAY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': '99999990-9999-4999-8999-999999999999',
},
body: JSON.stringify({}),
});
const data = await res.json();import os
import requests
resp = requests.post(
"https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/send",
headers={
"Authorization": f"Bearer {os.environ['REKBERPAY_API_KEY']}",
"Idempotency-Key": "99999990-9999-4999-8999-999999999999",
},
json={},
timeout=30,
)
print(resp.status_code, resp.json())<?php
$ch = curl_init('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/send');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('REKBERPAY_API_KEY'),
'Content-Type: application/json',
'Idempotency-Key: 99999990-9999-4999-8999-999999999999',
],
CURLOPT_POSTFIELDS => json_encode(new stdClass()),
]);
$response = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);Example response
200 OK
{
"success": true,
"data": {
"id": "33333330-3333-4333-8333-333333333333",
"buyer_id": "11111110-1111-4111-8111-111111111111",
"seller_id": "44444440-4444-4444-8444-444444444444",
"item_name": "Kamera Fujifilm X-T30 bekas",
"amount": "250000.00",
"description": "Body only, shutter count 8.000, lengkap dengan dus.",
"category": "goods",
"status": "sent",
"counterparty_email": null,
"counterparty_username": null,
"source_url": null,
"source_screenshot_url": null,
"attachment_url": "https://api.rekberpay.com/uploads/escrow/1791901398283_862e8cf475cf7693efed4855a91995d0_7e10e097a2087a40e3e8e3b659df3f65.png?exp=1791979200000&sig=c0ffee5b1a9e3d7f4a2c8e6b0d9f1a3c5e7b9d1f3a5c7e9b1d3f5a7c9e1b3d5",
"deadline_at": null,
"auto_release_at": "2026-10-16T14:23:18.383Z",
"partner_ref": null,
"partner_sig_version": null,
"paid_at": "2026-10-13T14:23:18.363Z",
"released_at": null,
"refunded_at": null,
"cancelled_at": null,
"tracking_courier": null,
"tracking_number": null,
"tracking_status": null,
"tracking_last_checked_at": null,
"tracking_snapshot": null,
"created_at": "2026-10-13T14:23:18.305Z",
"updated_at": "2026-10-13T14:23:18.383Z",
"user_role": "seller",
"available_actions": [
"dispute"
],
"shipping": {
"mode": "none",
"courier": null,
"tracking_number": null,
"custom_delivery_days": null,
"auto_release_hours": 72
}
}
}| Field | Type | Description |
|---|---|---|
shipping.mode | string | tracked (goods with a trackable courier: the release timer starts at delivery), estimate (goods with custom_delivery_days), none (goods without tracking) or digital (service or digital) |
shipping.auto_release_hours | integer | null | Hours from now until the automatic release, or null while it waits for delivery (or when automatic release is off) |
auto_release_at | string | null | The release time itself, when it is already known |
Errors
| Status | Code | Cause |
|---|---|---|
400 | UNKNOWN_COURIER | courier is not a known slug |
400 | TRACKING_INCOMPLETE | courier and tracking_number must come together |
400 | INVALID_TRACKING_NUMBER | The AWB is not 3 to 64 characters |
400 | CUSTOM_DAYS_REQUIRED, CUSTOM_DAYS_NOT_APPLICABLE, CUSTOM_DAYS_OUT_OF_RANGE, CUSTOM_DELIVERY_DISABLED | Transit days are missing for an untracked courier, not allowed here, out of range (error.details.max_days gives the maximum), or switched off |
409 | AWB_IN_USE | The AWB is already on another live escrow. The same buyer and seller may share one AWB for combined shipping |
409 | AWB_PREDATES_PAYMENT | The courier recorded this AWB before the escrow was paid |
403 | NOT_A_PARTY | You are not the buyer or the seller |
404 | NOT_FOUND | No escrow with this ID |
400 | INVALID_TRANSITION | The action is not allowed from the current status for your side of the escrow |
409 | CONCURRENT_MODIFICATION | The escrow changed while the call ran (for example an action by RekberPay). Read it again |
401 | UNAUTHORIZED, SESSION_EXPIRED, INVALID_TOKEN | No session or API key, the session expired, or the key is wrong or revoked |
401 | WORKSPACE_KEY_ONLY | A workspace key (rpe_...) was sent. Those only work under /v1/enterprise |
403 | CSRF_FAILED | Session call without the matching X-CSRF-Token header |
403 | ACCOUNT_INACTIVE, SUSPENDED | The account is closed, being deleted or suspended |
429 | RATE_LIMITED | Over the rate limit. Wait for Retry-After seconds |
A real TRACKING_INCOMPLETE answer:
400 Bad Request
{
"success": false,
"error": {
"code": "TRACKING_INCOMPLETE",
"message": "Isi nomor resi untuk kurir ini."
}
}Confirm receipt
The buyer confirms the item arrived as described. The escrow moves to received and, in the same call, to released: the seller's balance is credited with the amount minus the RekberPay fee. The answer below shows "status": "released". Confirming again is safe: an escrow that is already received or released answers 200 OK with its current state. In the rare case that RekberPay acts on the escrow at the same moment, the answer can stay at received; read the escrow again.
- Auth: A personal API key (
Authorization: Bearer <key>) or a session cookie withX-CSRF-Tokenon writes. - Who can call: The buyer, once the escrow is
sent. - Rate limit: 300 requests a minute per user, shared by every route.
- Idempotency: Send an
Idempotency-Keyheader (UUID v4). A retry with the same key and body returns the first answer withIdempotent-Replay: true.
Path parameters
| Name | Type | Description |
|---|---|---|
id | UUID | The escrow ID |
Example request
curl -X POST https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/confirm \
-H "Authorization: Bearer $REKBERPAY_API_KEY" \
-H "Idempotency-Key: fffffff0-ffff-4fff-8fff-ffffffffffff" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/confirm', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.REKBERPAY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': 'fffffff0-ffff-4fff-8fff-ffffffffffff',
},
body: JSON.stringify({}),
});
const data = await res.json();import os
import requests
resp = requests.post(
"https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/confirm",
headers={
"Authorization": f"Bearer {os.environ['REKBERPAY_API_KEY']}",
"Idempotency-Key": "fffffff0-ffff-4fff-8fff-ffffffffffff",
},
json={},
timeout=30,
)
print(resp.status_code, resp.json())<?php
$ch = curl_init('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/confirm');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('REKBERPAY_API_KEY'),
'Content-Type: application/json',
'Idempotency-Key: fffffff0-ffff-4fff-8fff-ffffffffffff',
],
CURLOPT_POSTFIELDS => json_encode(new stdClass()),
]);
$response = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);Example response
200 OK
{
"success": true,
"data": {
"id": "33333330-3333-4333-8333-333333333333",
"buyer_id": "11111110-1111-4111-8111-111111111111",
"seller_id": "44444440-4444-4444-8444-444444444444",
"item_name": "Kamera Fujifilm X-T30 bekas",
"amount": "250000.00",
"description": "Body only, shutter count 8.000, lengkap dengan dus.",
"category": "goods",
"status": "released",
"counterparty_email": null,
"counterparty_username": null,
"source_url": null,
"source_screenshot_url": null,
"attachment_url": "https://api.rekberpay.com/uploads/escrow/1791901398283_862e8cf475cf7693efed4855a91995d0_7e10e097a2087a40e3e8e3b659df3f65.png?exp=1791979200000&sig=c0ffee5b1a9e3d7f4a2c8e6b0d9f1a3c5e7b9d1f3a5c7e9b1d3f5a7c9e1b3d5",
"deadline_at": null,
"auto_release_at": null,
"partner_ref": null,
"partner_sig_version": null,
"paid_at": "2026-10-13T14:23:18.363Z",
"released_at": "2026-10-13T14:23:18.000Z",
"refunded_at": null,
"cancelled_at": null,
"tracking_courier": "jne",
"tracking_number": "CGK0123456789",
"tracking_status": "On Process",
"tracking_last_checked_at": "2026-10-13T14:23:18.721Z",
"tracking_snapshot": "{\"found\":true,\"courier\":\"jne\",\"awb\":\"CGK0123456789\",\"status\":\"On Process\",\"recipient\":\"(On Process)\",\"origin\":null,\"destination\":null,\"events\":[{\"date\":\"-\",\"description\":\"Dalam pengiriman\"}],\"checkedAt\":\"2026-10-13T14:23:18.720Z\"}",
"created_at": "2026-10-13T14:23:18.305Z",
"updated_at": "2026-10-13T14:23:18.753Z",
"user_role": "buyer",
"available_actions": []
}
}Errors
| Status | Code | Cause |
|---|---|---|
403 | NOT_A_PARTY | You are not the buyer or the seller |
404 | NOT_FOUND | No escrow with this ID |
400 | INVALID_TRANSITION | The action is not allowed from the current status for your side of the escrow |
409 | CONCURRENT_MODIFICATION | The escrow changed while the call ran (for example an action by RekberPay). Read it again |
401 | UNAUTHORIZED, SESSION_EXPIRED, INVALID_TOKEN | No session or API key, the session expired, or the key is wrong or revoked |
401 | WORKSPACE_KEY_ONLY | A workspace key (rpe_...) was sent. Those only work under /v1/enterprise |
403 | CSRF_FAILED | Session call without the matching X-CSRF-Token header |
403 | ACCOUNT_INACTIVE, SUSPENDED | The account is closed, being deleted or suspended |
429 | RATE_LIMITED | Over the rate limit. Wait for Retry-After seconds |
Release the funds
Releases an escrow that is still received. Confirm receipt normally releases in the same call, so you only need this when an escrow was left in received. Called on an escrow that is already released, it answers 400 INVALID_TRANSITION, as in this real example.
- Auth: A personal API key (
Authorization: Bearer <key>) or a session cookie withX-CSRF-Tokenon writes. - Who can call: The buyer, while the escrow is
received. - Rate limit: 300 requests a minute per user, shared by every route.
- Idempotency: Send an
Idempotency-Keyheader (UUID v4). A retry with the same key and body returns the first answer withIdempotent-Replay: true.
Path parameters
| Name | Type | Description |
|---|---|---|
id | UUID | The escrow ID |
Example request
curl -X POST https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/release \
-H "Authorization: Bearer $REKBERPAY_API_KEY" \
-H "Idempotency-Key: 11111111-1111-4111-8111-111111111111" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/release', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.REKBERPAY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': '11111111-1111-4111-8111-111111111111',
},
body: JSON.stringify({}),
});
const data = await res.json();import os
import requests
resp = requests.post(
"https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/release",
headers={
"Authorization": f"Bearer {os.environ['REKBERPAY_API_KEY']}",
"Idempotency-Key": "11111111-1111-4111-8111-111111111111",
},
json={},
timeout=30,
)
print(resp.status_code, resp.json())<?php
$ch = curl_init('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/release');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('REKBERPAY_API_KEY'),
'Content-Type: application/json',
'Idempotency-Key: 11111111-1111-4111-8111-111111111111',
],
CURLOPT_POSTFIELDS => json_encode(new stdClass()),
]);
$response = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);Example response
400 Bad Request
{
"success": false,
"error": {
"code": "INVALID_TRANSITION",
"message": "Aksi \"release\" tidak valid dari status \"released\" sebagai buyer"
}
}Errors
| Status | Code | Cause |
|---|---|---|
403 | NOT_A_PARTY | You are not the buyer or the seller |
404 | NOT_FOUND | No escrow with this ID |
400 | INVALID_TRANSITION | The action is not allowed from the current status for your side of the escrow |
409 | CONCURRENT_MODIFICATION | The escrow changed while the call ran (for example an action by RekberPay). Read it again |
401 | UNAUTHORIZED, SESSION_EXPIRED, INVALID_TOKEN | No session or API key, the session expired, or the key is wrong or revoked |
401 | WORKSPACE_KEY_ONLY | A workspace key (rpe_...) was sent. Those only work under /v1/enterprise |
403 | CSRF_FAILED | Session call without the matching X-CSRF-Token header |
403 | ACCOUNT_INACTIVE, SUSPENDED | The account is closed, being deleted or suspended |
429 | RATE_LIMITED | Over the rate limit. Wait for Retry-After seconds |
Cancel an escrow
Cancels an escrow before anything was paid. While a payment is still open (a QRIS, virtual account or transfer that has not expired, or a manual transfer RekberPay is checking) the cancel is refused with PAYMENT_IN_PROGRESS. An escrow in pending_review cannot be cancelled. Once money is held, open a dispute instead. The other party is notified.
- Auth: A personal API key (
Authorization: Bearer <key>) or a session cookie withX-CSRF-Tokenon writes. - Who can call: The buyer or the seller, while the escrow is
pending_payment. - Rate limit: 300 requests a minute per user, shared by every route.
- Idempotency: Send an
Idempotency-Keyheader (UUID v4). A retry with the same key and body returns the first answer withIdempotent-Replay: true.
Path parameters
| Name | Type | Description |
|---|---|---|
id | UUID | The escrow ID |
Example request
curl -X POST https://api.rekberpay.com/v1/escrows/ddddddd1-dddd-4ddd-8ddd-dddddddddddd/cancel \
-H "Authorization: Bearer $REKBERPAY_API_KEY" \
-H "Idempotency-Key: eeeeeee1-eeee-4eee-8eee-eeeeeeeeeeee" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.rekberpay.com/v1/escrows/ddddddd1-dddd-4ddd-8ddd-dddddddddddd/cancel', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.REKBERPAY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': 'eeeeeee1-eeee-4eee-8eee-eeeeeeeeeeee',
},
body: JSON.stringify({}),
});
const data = await res.json();import os
import requests
resp = requests.post(
"https://api.rekberpay.com/v1/escrows/ddddddd1-dddd-4ddd-8ddd-dddddddddddd/cancel",
headers={
"Authorization": f"Bearer {os.environ['REKBERPAY_API_KEY']}",
"Idempotency-Key": "eeeeeee1-eeee-4eee-8eee-eeeeeeeeeeee",
},
json={},
timeout=30,
)
print(resp.status_code, resp.json())<?php
$ch = curl_init('https://api.rekberpay.com/v1/escrows/ddddddd1-dddd-4ddd-8ddd-dddddddddddd/cancel');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('REKBERPAY_API_KEY'),
'Content-Type: application/json',
'Idempotency-Key: eeeeeee1-eeee-4eee-8eee-eeeeeeeeeeee',
],
CURLOPT_POSTFIELDS => json_encode(new stdClass()),
]);
$response = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);Example response
200 OK
{
"success": true,
"data": {
"id": "ddddddd1-dddd-4ddd-8ddd-dddddddddddd",
"buyer_id": "11111110-1111-4111-8111-111111111111",
"seller_id": null,
"item_name": "Sepatu lari ukuran 42",
"amount": "450000.00",
"description": "",
"category": "goods",
"status": "cancelled",
"counterparty_email": null,
"counterparty_username": null,
"source_url": null,
"source_screenshot_url": null,
"attachment_url": null,
"deadline_at": null,
"auto_release_at": null,
"partner_ref": null,
"partner_sig_version": null,
"paid_at": null,
"released_at": null,
"refunded_at": null,
"cancelled_at": "2026-10-13T14:23:18.874Z",
"tracking_courier": null,
"tracking_number": null,
"tracking_status": null,
"tracking_last_checked_at": null,
"tracking_snapshot": null,
"created_at": "2026-10-13T14:23:18.869Z",
"updated_at": "2026-10-13T14:23:18.874Z",
"user_role": "buyer",
"available_actions": []
}
}Errors
| Status | Code | Cause |
|---|---|---|
403 | NOT_A_PARTY | You are not the buyer or the seller |
404 | NOT_FOUND | No escrow with this ID |
400 | INVALID_TRANSITION | The action is not allowed from the current status for your side of the escrow |
409 | CONCURRENT_MODIFICATION | The escrow changed while the call ran (for example an action by RekberPay). Read it again |
409 | PAYMENT_IN_PROGRESS | A payment for this escrow is still open. Wait until it completes or expires |
401 | UNAUTHORIZED, SESSION_EXPIRED, INVALID_TOKEN | No session or API key, the session expired, or the key is wrong or revoked |
401 | WORKSPACE_KEY_ONLY | A workspace key (rpe_...) was sent. Those only work under /v1/enterprise |
403 | CSRF_FAILED | Session call without the matching X-CSRF-Token header |
403 | ACCOUNT_INACTIVE, SUSPENDED | The account is closed, being deleted or suspended |
429 | RATE_LIMITED | Over the rate limit. Wait for Retry-After seconds |
A real INVALID_TRANSITION answer:
400 Bad Request
{
"success": false,
"error": {
"code": "INVALID_TRANSITION",
"message": "Aksi \"cancel\" tidak valid dari status \"cancelled\" sebagai buyer"
}
}Ask to cancel a paid escrow
Asks the other party to cancel an escrow that is already paid. One request can be open at a time, and it lapses 48 hours after it was made. Each party can ask at most twice per escrow, counting requests that were declined, withdrawn or lapsed. If the other party accepts, the buyer gets the money back in their RekberPay balance and the escrow ends refunded. The payment fee is not refunded. While a request is open, the escrow is not released automatically. Opening a dispute closes an open request. The other party is notified.
Get an escrow returns the open request as cancel_request, or null when there is none.
- Auth: A personal API key (
Authorization: Bearer <key>) or a session cookie withX-CSRF-Tokenon writes. - Who can call: The buyer or the seller, while the escrow is
paidorsent. - Rate limit: 300 requests a minute per user, shared by every route.
- Idempotency: Send an
Idempotency-Keyheader (UUID v4). A retry with the same key and body returns the first answer withIdempotent-Replay: true.
Path parameters
| Name | Type | Description |
|---|---|---|
id | UUID | The escrow ID |
Body
| Field | Type | Required | Description |
|---|---|---|---|
reason | string | No | Why you want to cancel, up to 500 characters. Shown to the other party |
Example request
curl -X POST https://api.rekberpay.com/v1/escrows/ddddddd1-dddd-4ddd-8ddd-dddddddddddd/cancel-request \
-H "Authorization: Bearer $REKBERPAY_API_KEY" \
-H "Idempotency-Key: eeeeeee2-eeee-4eee-8eee-eeeeeeeeeeee" \
-H "Content-Type: application/json" \
-d '{"reason":"Stok habis"}'const res = await fetch('https://api.rekberpay.com/v1/escrows/ddddddd1-dddd-4ddd-8ddd-dddddddddddd/cancel-request', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.REKBERPAY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': 'eeeeeee2-eeee-4eee-8eee-eeeeeeeeeeee',
},
body: JSON.stringify({ reason: 'Stok habis' }),
});
const data = await res.json();import os
import requests
resp = requests.post(
"https://api.rekberpay.com/v1/escrows/ddddddd1-dddd-4ddd-8ddd-dddddddddddd/cancel-request",
headers={
"Authorization": f"Bearer {os.environ['REKBERPAY_API_KEY']}",
"Idempotency-Key": "eeeeeee2-eeee-4eee-8eee-eeeeeeeeeeee",
},
json={"reason": "Stok habis"},
timeout=30,
)
print(resp.status_code, resp.json())<?php
$ch = curl_init('https://api.rekberpay.com/v1/escrows/ddddddd1-dddd-4ddd-8ddd-dddddddddddd/cancel-request');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('REKBERPAY_API_KEY'),
'Content-Type: application/json',
'Idempotency-Key: eeeeeee2-eeee-4eee-8eee-eeeeeeeeeeee',
],
CURLOPT_POSTFIELDS => json_encode(['reason' => 'Stok habis']),
]);
$response = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);Example response
200 OK
{
"success": true,
"data": {
"escrow_status": "paid",
"cancel_request": {
"requested_by": "seller",
"requested_at": "2026-11-08T09:00:00.000Z",
"expires_at": "2026-11-11T09:00:00.000Z",
"reason": "Stok habis"
}
}
}Errors
| Status | Code | Cause |
|---|---|---|
400 | INVALID_BODY | reason is not text or is longer than 500 characters |
403 | NOT_PARTY | You are not the buyer or the seller |
404 | NOT_FOUND | No escrow with this ID |
409 | INVALID_STATUS | The escrow is not paid or sent (for example a dispute was opened) |
409 | CANCEL_REQUEST_EXISTS | A request is already waiting for an answer |
409 | CANCEL_REQUEST_LIMIT | You already asked twice for this escrow. Open a dispute if there is still a problem |
401 | UNAUTHORIZED, SESSION_EXPIRED, INVALID_TOKEN | No session or API key, the session expired, or the key is wrong or revoked |
403 | CSRF_FAILED | Session call without the matching X-CSRF-Token header |
429 | RATE_LIMITED | Over the rate limit. Wait for Retry-After seconds |
Accept a cancel request
Accepts the other party's open request. The escrow moves to refunded and the buyer's balance is credited in the same step. The payment fee is not refunded. This cannot be undone.
- Auth: A personal API key (
Authorization: Bearer <key>) or a session cookie withX-CSRF-Tokenon writes. - Who can call: The party who did not make the request.
- Rate limit: 300 requests a minute per user, shared by every route.
- Idempotency: Send an
Idempotency-Keyheader (UUID v4). A retry with the same key and body returns the first answer withIdempotent-Replay: true.
Path parameters
| Name | Type | Description |
|---|---|---|
id | UUID | The escrow ID |
Example request
curl -X POST https://api.rekberpay.com/v1/escrows/ddddddd1-dddd-4ddd-8ddd-dddddddddddd/cancel-request/accept \
-H "Authorization: Bearer $REKBERPAY_API_KEY" \
-H "Idempotency-Key: eeeeeee3-eeee-4eee-8eee-eeeeeeeeeeee" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.rekberpay.com/v1/escrows/ddddddd1-dddd-4ddd-8ddd-dddddddddddd/cancel-request/accept', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.REKBERPAY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': 'eeeeeee3-eeee-4eee-8eee-eeeeeeeeeeee',
},
body: JSON.stringify({}),
});
const data = await res.json();import os
import requests
resp = requests.post(
"https://api.rekberpay.com/v1/escrows/ddddddd1-dddd-4ddd-8ddd-dddddddddddd/cancel-request/accept",
headers={
"Authorization": f"Bearer {os.environ['REKBERPAY_API_KEY']}",
"Idempotency-Key": "eeeeeee3-eeee-4eee-8eee-eeeeeeeeeeee",
},
json={},
timeout=30,
)
print(resp.status_code, resp.json())<?php
$ch = curl_init('https://api.rekberpay.com/v1/escrows/ddddddd1-dddd-4ddd-8ddd-dddddddddddd/cancel-request/accept');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('REKBERPAY_API_KEY'),
'Content-Type: application/json',
'Idempotency-Key: eeeeeee3-eeee-4eee-8eee-eeeeeeeeeeee',
],
CURLOPT_POSTFIELDS => json_encode(new stdClass()),
]);
$response = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);Example response
200 OK
{
"success": true,
"data": {
"escrow_status": "refunded",
"cancel_request": null
}
}Errors
| Status | Code | Cause |
|---|---|---|
403 | NOT_PARTY | You are not the buyer or the seller |
403 | OWN_REQUEST | You made this request. Wait for the other party or withdraw it |
404 | NOT_FOUND | No escrow with this ID |
409 | INVALID_STATUS | The escrow is not paid or sent (for example a dispute was opened) |
409 | NO_CANCEL_REQUEST | There is no open request to answer |
409 | CANCEL_REQUEST_EXPIRED | The request lapsed |
409 | CONCURRENT_MODIFICATION | The escrow changed while the call ran. Read it again |
409 | ACCOUNT_NOT_ACTIVE | One of the parties is not active |
401 | UNAUTHORIZED, SESSION_EXPIRED, INVALID_TOKEN | No session or API key, the session expired, or the key is wrong or revoked |
403 | CSRF_FAILED | Session call without the matching X-CSRF-Token header |
429 | RATE_LIMITED | Over the rate limit. Wait for Retry-After seconds |
Decline a cancel request
Declines the other party's open request. The escrow carries on, the requester is notified, and a dispute stays available.
- Auth: A personal API key (
Authorization: Bearer <key>) or a session cookie withX-CSRF-Tokenon writes. - Who can call: The party who did not make the request.
- Rate limit: 300 requests a minute per user, shared by every route.
- Idempotency: Send an
Idempotency-Keyheader (UUID v4). A retry with the same key and body returns the first answer withIdempotent-Replay: true.
Path parameters
| Name | Type | Description |
|---|---|---|
id | UUID | The escrow ID |
Example request
curl -X POST https://api.rekberpay.com/v1/escrows/ddddddd1-dddd-4ddd-8ddd-dddddddddddd/cancel-request/decline \
-H "Authorization: Bearer $REKBERPAY_API_KEY" \
-H "Idempotency-Key: eeeeeee4-eeee-4eee-8eee-eeeeeeeeeeee" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.rekberpay.com/v1/escrows/ddddddd1-dddd-4ddd-8ddd-dddddddddddd/cancel-request/decline', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.REKBERPAY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': 'eeeeeee4-eeee-4eee-8eee-eeeeeeeeeeee',
},
body: JSON.stringify({}),
});
const data = await res.json();import os
import requests
resp = requests.post(
"https://api.rekberpay.com/v1/escrows/ddddddd1-dddd-4ddd-8ddd-dddddddddddd/cancel-request/decline",
headers={
"Authorization": f"Bearer {os.environ['REKBERPAY_API_KEY']}",
"Idempotency-Key": "eeeeeee4-eeee-4eee-8eee-eeeeeeeeeeee",
},
json={},
timeout=30,
)
print(resp.status_code, resp.json())<?php
$ch = curl_init('https://api.rekberpay.com/v1/escrows/ddddddd1-dddd-4ddd-8ddd-dddddddddddd/cancel-request/decline');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('REKBERPAY_API_KEY'),
'Content-Type: application/json',
'Idempotency-Key: eeeeeee4-eeee-4eee-8eee-eeeeeeeeeeee',
],
CURLOPT_POSTFIELDS => json_encode(new stdClass()),
]);
$response = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);Example response
200 OK
{
"success": true,
"data": {
"escrow_status": "paid",
"cancel_request": null
}
}Errors
| Status | Code | Cause |
|---|---|---|
403 | NOT_PARTY | You are not the buyer or the seller |
403 | OWN_REQUEST | You made this request. Wait for the other party or withdraw it |
404 | NOT_FOUND | No escrow with this ID |
409 | INVALID_STATUS | The escrow is not paid or sent (for example a dispute was opened) |
409 | NO_CANCEL_REQUEST | There is no open request to answer |
409 | CANCEL_REQUEST_EXPIRED | The request lapsed |
409 | CONCURRENT_MODIFICATION | The escrow changed while the call ran. Read it again |
401 | UNAUTHORIZED, SESSION_EXPIRED, INVALID_TOKEN | No session or API key, the session expired, or the key is wrong or revoked |
403 | CSRF_FAILED | Session call without the matching X-CSRF-Token header |
429 | RATE_LIMITED | Over the rate limit. Wait for Retry-After seconds |
Withdraw a cancel request
Takes back your own open request. The escrow carries on.
- Auth: A personal API key (
Authorization: Bearer <key>) or a session cookie withX-CSRF-Tokenon writes. - Who can call: The party who made the request.
- Rate limit: 300 requests a minute per user, shared by every route.
- Idempotency: Send an
Idempotency-Keyheader (UUID v4). A retry with the same key and body returns the first answer withIdempotent-Replay: true.
Path parameters
| Name | Type | Description |
|---|---|---|
id | UUID | The escrow ID |
Example request
curl -X POST https://api.rekberpay.com/v1/escrows/ddddddd1-dddd-4ddd-8ddd-dddddddddddd/cancel-request/withdraw \
-H "Authorization: Bearer $REKBERPAY_API_KEY" \
-H "Idempotency-Key: eeeeeee5-eeee-4eee-8eee-eeeeeeeeeeee" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.rekberpay.com/v1/escrows/ddddddd1-dddd-4ddd-8ddd-dddddddddddd/cancel-request/withdraw', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.REKBERPAY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': 'eeeeeee5-eeee-4eee-8eee-eeeeeeeeeeee',
},
body: JSON.stringify({}),
});
const data = await res.json();import os
import requests
resp = requests.post(
"https://api.rekberpay.com/v1/escrows/ddddddd1-dddd-4ddd-8ddd-dddddddddddd/cancel-request/withdraw",
headers={
"Authorization": f"Bearer {os.environ['REKBERPAY_API_KEY']}",
"Idempotency-Key": "eeeeeee5-eeee-4eee-8eee-eeeeeeeeeeee",
},
json={},
timeout=30,
)
print(resp.status_code, resp.json())<?php
$ch = curl_init('https://api.rekberpay.com/v1/escrows/ddddddd1-dddd-4ddd-8ddd-dddddddddddd/cancel-request/withdraw');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('REKBERPAY_API_KEY'),
'Content-Type: application/json',
'Idempotency-Key: eeeeeee5-eeee-4eee-8eee-eeeeeeeeeeee',
],
CURLOPT_POSTFIELDS => json_encode(new stdClass()),
]);
$response = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);Example response
200 OK
{
"success": true,
"data": {
"escrow_status": "sent",
"cancel_request": null
}
}Errors
| Status | Code | Cause |
|---|---|---|
403 | NOT_PARTY | You are not the buyer or the seller |
404 | NOT_FOUND | No escrow with this ID |
409 | INVALID_STATUS | The escrow is not paid or sent (for example a dispute was opened) |
409 | NO_CANCEL_REQUEST | There is no open request, or the open one is not yours |
409 | CANCEL_REQUEST_EXPIRED | The request lapsed |
409 | CONCURRENT_MODIFICATION | The escrow changed while the call ran. Read it again |
401 | UNAUTHORIZED, SESSION_EXPIRED, INVALID_TOKEN | No session or API key, the session expired, or the key is wrong or revoked |
403 | CSRF_FAILED | Session call without the matching X-CSRF-Token header |
429 | RATE_LIMITED | Over the rate limit. Wait for Retry-After seconds |
Get tracking
The saved courier and AWB, a live journey snapshot from the courier, and the list of couriers for a "mark shipped" form. The snapshot comes from the courier and can be about 10 minutes old. When the courier has no result it returns snapshot.found: false rather than failing. tracking and snapshot are null until a resi is attached.
- Auth: A personal API key (
Authorization: Bearer <key>) or a session cookie withX-CSRF-Tokenon writes. - Who can call: The buyer or the seller.
- Rate limit: 300 requests a minute per user, shared by every route.
- Idempotency: Not needed. Reading has no side effects.
Path parameters
| Name | Type | Description |
|---|---|---|
id | UUID | The escrow ID |
Example request
curl https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/tracking \
-H "Authorization: Bearer $REKBERPAY_API_KEY"const res = await fetch('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/tracking', {
headers: {
Authorization: `Bearer ${process.env.REKBERPAY_API_KEY}`,
},
});
const data = await res.json();import os
import requests
resp = requests.get(
"https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/tracking",
headers={
"Authorization": f"Bearer {os.environ['REKBERPAY_API_KEY']}",
},
timeout=30,
)
print(resp.status_code, resp.json())<?php
$ch = curl_init('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/tracking');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('REKBERPAY_API_KEY'),
],
]);
$response = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);Example response
200 OK
{
"success": true,
"data": {
"tracking": {
"courier": "jne",
"courier_name": "JNE",
"number": "CGK0123456789",
"track_url": "https://www.jne.co.id/id/tracking/trace?awb=CGK0123456789"
},
"snapshot": {
"found": true,
"courier": "jne",
"awb": "CGK0123456789",
"status": "On Process",
"recipient": "(On Process)",
"origin": null,
"destination": null,
"events": [
{
"date": "-",
"description": "Dalam pengiriman"
}
],
"checkedAt": "2026-10-13T14:23:18.659Z"
},
"couriers": [
{
"slug": "jne",
"name": "JNE",
"trackable": true
},
{
"slug": "jnt",
"name": "J&T Express",
"trackable": true
},
{
"slug": "jntcargo",
"name": "J&T Cargo",
"trackable": true
}
],
"limits": {
"custom_delivery_max_days": 60,
"awb_edit_window_hours": 12
}
}
}Lists are cut to the first 3 items and long text is shortened here.
| Field | Type | Description |
|---|---|---|
tracking | object | null | Saved courier, courier_name, number and the courier's own track_url |
snapshot | object | null | Live result: found, status and events, newest first |
couriers | array | { slug, name, trackable } for every supported courier |
limits | object | custom_delivery_max_days: the most days custom_delivery_days may be (0 when declaring a delivery time is off). awb_edit_window_hours: how long after the first AWB the seller may correct it once |
Errors
| Status | Code | Cause |
|---|---|---|
403 | FORBIDDEN | You are not a party to the escrow |
404 | NOT_FOUND | No escrow with this ID |
401 | UNAUTHORIZED, SESSION_EXPIRED, INVALID_TOKEN | No session or API key, the session expired, or the key is wrong or revoked |
401 | WORKSPACE_KEY_ONLY | A workspace key (rpe_...) was sent. Those only work under /v1/enterprise |
403 | ACCOUNT_INACTIVE, SUSPENDED | The account is closed, being deleted or suspended |
429 | RATE_LIMITED | Over the rate limit. Wait for Retry-After seconds |
Add or change the tracking number
Attaches a courier and AWB after shipping, or corrects a mistyped one. A seller can change a saved AWB once, within the edit window after it was first entered (limits.awb_edit_window_hours in Get tracking). Sending the same courier and AWB again changes nothing and answers "changed": false. For goods with a trackable courier, attaching the AWB stops any running release timer: the timer starts again when the courier reports delivery. With a courier that cannot be tracked, a running timer is kept (or started if none was running). Service and digital escrows keep their timer.
- Auth: A personal API key (
Authorization: Bearer <key>) or a session cookie withX-CSRF-Tokenon writes. - Who can call: The seller, while the escrow is
sentand not yet delivered. - Rate limit: 300 requests a minute per user, shared by every route.
- Idempotency: Send an
Idempotency-Keyheader (UUID v4). A retry with the same key and body returns the first answer withIdempotent-Replay: true.
Path parameters
| Name | Type | Description |
|---|---|---|
id | UUID | The escrow ID |
Body (JSON)
| Name | Type | Required | Description |
|---|---|---|---|
courier | string | Yes | Courier slug, 1 to 32 characters |
tracking_number | string | Yes | AWB, 3 to 64 characters |
Example request
curl -X POST https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/tracking \
-H "Authorization: Bearer $REKBERPAY_API_KEY" \
-H "Idempotency-Key: aaaaaaa0-aaaa-4aaa-8aaa-aaaaaaaaaaaa" \
-H "Content-Type: application/json" \
-d '{
"courier": "jne",
"tracking_number": "CGK0123456789"
}'const res = await fetch('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/tracking', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.REKBERPAY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': 'aaaaaaa0-aaaa-4aaa-8aaa-aaaaaaaaaaaa',
},
body: JSON.stringify({
courier: "jne",
tracking_number: "CGK0123456789"
}),
});
const data = await res.json();import os
import requests
resp = requests.post(
"https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/tracking",
headers={
"Authorization": f"Bearer {os.environ['REKBERPAY_API_KEY']}",
"Idempotency-Key": "aaaaaaa0-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
},
json={
"courier": "jne",
"tracking_number": "CGK0123456789",
},
timeout=30,
)
print(resp.status_code, resp.json())<?php
$ch = curl_init('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/tracking');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('REKBERPAY_API_KEY'),
'Content-Type: application/json',
'Idempotency-Key: aaaaaaa0-aaaa-4aaa-8aaa-aaaaaaaaaaaa',
],
CURLOPT_POSTFIELDS => json_encode([
'courier' => 'jne',
'tracking_number' => 'CGK0123456789',
]),
]);
$response = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);Example response
200 OK
{
"success": true,
"data": {
"courier": "jne",
"courier_name": "JNE",
"tracking_number": "CGK0123456789",
"track_url": "https://www.jne.co.id/id/tracking/trace?awb=CGK0123456789",
"changed": true
}
}Errors
| Status | Code | Cause |
|---|---|---|
400 | INVALID_BODY | Courier or AWB missing or too long |
400 | INVALID_COURIER | Unknown courier slug |
403 | FORBIDDEN | Only the seller can add a resi |
404 | NOT_FOUND | No escrow with this ID |
409 | NOT_SHIPPED | The escrow is not sent |
409 | ALREADY_DELIVERED | The courier already reported delivery |
409 | CHANGE_LIMIT_REACHED | The AWB was already changed once |
409 | EDIT_WINDOW_CLOSED | The edit window after the first AWB has passed |
409 | TRACKING_CHANGED | The AWB or the delivery status changed while the call ran. Read the escrow and try again |
409 | AWB_IN_USE | The AWB is already on another live escrow. The same buyer and seller may share one AWB for combined shipping |
409 | AWB_PREDATES_PAYMENT | The courier recorded this AWB before the escrow was paid |
401 | UNAUTHORIZED, SESSION_EXPIRED, INVALID_TOKEN | No session or API key, the session expired, or the key is wrong or revoked |
401 | WORKSPACE_KEY_ONLY | A workspace key (rpe_...) was sent. Those only work under /v1/enterprise |
403 | CSRF_FAILED | Session call without the matching X-CSRF-Token header |
403 | ACCOUNT_INACTIVE, SUSPENDED | The account is closed, being deleted or suspended |
429 | RATE_LIMITED | Over the rate limit. Wait for Retry-After seconds |
Refresh tracking
Asks the courier for a fresh snapshot, skipping the cache. The answer has the same tracking and snapshot as Get tracking.
- Auth: A personal API key (
Authorization: Bearer <key>) or a session cookie withX-CSRF-Tokenon writes. - Who can call: The buyer or the seller.
- Rate limit: Once per escrow every 5 minutes, plus the shared 300 a minute.
- Idempotency: Send an
Idempotency-Keyheader (UUID v4). A retry with the same key and body returns the first answer withIdempotent-Replay: true.
Path parameters
| Name | Type | Description |
|---|---|---|
id | UUID | The escrow ID |
Example request
curl -X POST https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/tracking/refresh \
-H "Authorization: Bearer $REKBERPAY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/tracking/refresh', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.REKBERPAY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({}),
});
const data = await res.json();import os
import requests
resp = requests.post(
"https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/tracking/refresh",
headers={
"Authorization": f"Bearer {os.environ['REKBERPAY_API_KEY']}",
},
json={},
timeout=30,
)
print(resp.status_code, resp.json())<?php
$ch = curl_init('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/tracking/refresh');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('REKBERPAY_API_KEY'),
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode(new stdClass()),
]);
$response = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);Example response
200 OK
{
"success": true,
"data": {
"tracking": {
"courier": "jne",
"courier_name": "JNE",
"number": "CGK0123456789",
"track_url": "https://www.jne.co.id/id/tracking/trace?awb=CGK0123456789"
},
"snapshot": {
"found": true,
"courier": "jne",
"awb": "CGK0123456789",
"status": "On Process",
"recipient": "(On Process)",
"origin": null,
"destination": null,
"events": [
{
"date": "-",
"description": "Dalam pengiriman"
}
],
"checkedAt": "2026-10-13T14:23:18.720Z"
}
}
}Errors
| Status | Code | Cause |
|---|---|---|
400 | NO_TRACKING | No courier or AWB is attached yet |
403 | FORBIDDEN | You are not a party to the escrow |
404 | NOT_FOUND | No escrow with this ID |
401 | UNAUTHORIZED, SESSION_EXPIRED, INVALID_TOKEN | No session or API key, the session expired, or the key is wrong or revoked |
401 | WORKSPACE_KEY_ONLY | A workspace key (rpe_...) was sent. Those only work under /v1/enterprise |
403 | CSRF_FAILED | Session call without the matching X-CSRF-Token header |
403 | ACCOUNT_INACTIVE, SUSPENDED | The account is closed, being deleted or suspended |
429 | RATE_LIMITED | Over the rate limit. Wait for Retry-After seconds |
A real RATE_LIMITED answer:
429 Too Many Requests
{
"success": false,
"error": {
"code": "RATE_LIMITED",
"message": "Tunggu sebentar sebelum memuat ulang status lagi."
}
}Extend the auto-release timer
Pushes the automatic release back when the buyer needs more time to check the item. How many hours and how many times come from extend_info on Get an escrow. It only works while a timer is running: for a tracked shipment the timer starts when the courier reports delivery, so the real answer below is 409 NO_ACTIVE_TIMER.
- Auth: A personal API key (
Authorization: Bearer <key>) or a session cookie withX-CSRF-Tokenon writes. - Who can call: The buyer.
- Rate limit: 300 requests a minute per user, shared by every route.
- Idempotency: Send an
Idempotency-Keyheader (UUID v4). A retry with the same key and body returns the first answer withIdempotent-Replay: true.
Path parameters
| Name | Type | Description |
|---|---|---|
id | UUID | The escrow ID |
Example request
curl -X POST https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/extend \
-H "Authorization: Bearer $REKBERPAY_API_KEY" \
-H "Idempotency-Key: bbbbbbb0-bbbb-4bbb-8bbb-bbbbbbbbbbbb" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/extend', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.REKBERPAY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': 'bbbbbbb0-bbbb-4bbb-8bbb-bbbbbbbbbbbb',
},
body: JSON.stringify({}),
});
const data = await res.json();import os
import requests
resp = requests.post(
"https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/extend",
headers={
"Authorization": f"Bearer {os.environ['REKBERPAY_API_KEY']}",
"Idempotency-Key": "bbbbbbb0-bbbb-4bbb-8bbb-bbbbbbbbbbbb",
},
json={},
timeout=30,
)
print(resp.status_code, resp.json())<?php
$ch = curl_init('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/extend');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('REKBERPAY_API_KEY'),
'Content-Type: application/json',
'Idempotency-Key: bbbbbbb0-bbbb-4bbb-8bbb-bbbbbbbbbbbb',
],
CURLOPT_POSTFIELDS => json_encode(new stdClass()),
]);
$response = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);Example response
409 Conflict
{
"success": false,
"error": {
"code": "NO_ACTIVE_TIMER",
"message": "Belum ada timer rilis otomatis yang berjalan untuk diperpanjang."
}
}When a timer is running, the answer is 200 OK with data.auto_release_at (the new release time), extend_count (extensions used on this escrow), extend_max_count and added_hours. The timer only moves later, never earlier.
Errors
| Status | Code | Cause |
|---|---|---|
403 | BUYER_ONLY | Only the buyer can extend |
404 | NOT_FOUND | No escrow with this ID |
409 | NOT_EXTENDABLE | The escrow is not in a status with a release timer |
409 | NO_ACTIVE_TIMER | No timer is running yet |
409 | EXTEND_DISABLED | Extending is switched off |
409 | EXTEND_LIMIT_REACHED | The buyer already used every extension |
409 | CONCURRENT_MODIFICATION | The escrow changed while the call ran |
401 | UNAUTHORIZED, SESSION_EXPIRED, INVALID_TOKEN | No session or API key, the session expired, or the key is wrong or revoked |
401 | WORKSPACE_KEY_ONLY | A workspace key (rpe_...) was sent. Those only work under /v1/enterprise |
403 | CSRF_FAILED | Session call without the matching X-CSRF-Token header |
403 | ACCOUNT_INACTIVE, SUSPENDED | The account is closed, being deleted or suspended |
429 | RATE_LIMITED | Over the rate limit. Wait for Retry-After seconds |
List chat messages
The chat between buyer and seller, oldest first. Without a cursor you get the newest limit messages. For polling, send the newest created_at you have as after and its id as after_id to get only new messages; two messages written in the same millisecond are then never missed. Each message shows sender_email only for your own messages; the other party's is null. sender_participant_role is buyer, seller, admin (RekberPay, shown as "Admin RekberPay") or system (is_system: 1, an automatic note). attachments lists every file of a message in order, each with its url and mime (null when not known); a message holds up to 5 files and attachment_url stays the first one. During a dispute this chat is also the dispute thread: RekberPay replies here.
- Auth: A personal API key (
Authorization: Bearer <key>) or a session cookie withX-CSRF-Tokenon writes. - Who can call: The buyer or the seller.
- Rate limit: 300 requests a minute per user, shared by every route.
- Idempotency: Not needed. Reading has no side effects.
Path parameters
| Name | Type | Description |
|---|---|---|
id | UUID | The escrow ID |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | No | 1 to 200. Default 50 |
after | string | No | ISO 8601 time. Only messages after it |
after_id | string | No | The id of the message at after. With it, the cursor is the pair (created_at, id) |
before | string | No | ISO 8601 time. Only messages before it, for older history |
Example request
curl "https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/messages?limit=20" \
-H "Authorization: Bearer $REKBERPAY_API_KEY"const res = await fetch('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/messages?limit=20', {
headers: {
Authorization: `Bearer ${process.env.REKBERPAY_API_KEY}`,
},
});
const data = await res.json();import os
import requests
resp = requests.get(
"https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/messages?limit=20",
headers={
"Authorization": f"Bearer {os.environ['REKBERPAY_API_KEY']}",
},
timeout=30,
)
print(resp.status_code, resp.json())<?php
$ch = curl_init('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/messages?limit=20');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('REKBERPAY_API_KEY'),
],
]);
$response = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);Example response
200 OK
{
"success": true,
"data": [
{
"id": "ddddddd0-dddd-4ddd-8ddd-dddddddddddd",
"escrow_id": "33333330-3333-4333-8333-333333333333",
"sender_id": "11111110-1111-4111-8111-111111111111",
"body": "Paket sudah sampai di kantor pos, saya ambil sore ini.",
"attachment_url": null,
"attachments": [],
"is_system": 0,
"created_at": "2026-10-13T14:23:18.734Z",
"sender_email": "[email protected]",
"sender_full_name": "Rina Wijaya",
"sender_role": "user",
"sender_participant_role": "buyer"
},
{
"id": "eeeeeee0-eeee-4eee-8eee-eeeeeeeeeeee",
"escrow_id": "33333330-3333-4333-8333-333333333333",
"sender_id": "44444440-4444-4444-8444-444444444444",
"body": "Siap, kabari kalau sudah dicek ya.",
"attachment_url": null,
"attachments": [],
"is_system": 0,
"created_at": "2026-10-13T14:23:18.739Z",
"sender_email": null,
"sender_full_name": "Budi Santoso",
"sender_role": "user",
"sender_participant_role": "seller"
}
]
}Errors
| Status | Code | Cause |
|---|---|---|
400 | INVALID_CURSOR | after or before is not a date |
403 | NOT_A_PARTY | You are not the buyer or the seller |
404 | NOT_FOUND | No escrow with this ID |
401 | UNAUTHORIZED, SESSION_EXPIRED, INVALID_TOKEN | No session or API key, the session expired, or the key is wrong or revoked |
401 | WORKSPACE_KEY_ONLY | A workspace key (rpe_...) was sent. Those only work under /v1/enterprise |
403 | ACCOUNT_INACTIVE, SUSPENDED | The account is closed, being deleted or suspended |
429 | RATE_LIMITED | Over the rate limit. Wait for Retry-After seconds |
Send a chat message
Posts a message, up to 5 files, or both, and notifies the other party. A message with only files is stored with the text [Lampiran]. While the escrow is disputed, the message also counts as a dispute message: RekberPay sees it in the case and the dispute moves to under_review.
- Auth: A personal API key (
Authorization: Bearer <key>) or a session cookie withX-CSRF-Tokenon writes. - Who can call: The buyer or the seller.
- Rate limit: 300 requests a minute per user, shared by every route.
- Idempotency: Send an
Idempotency-Keyheader (UUID v4). A retry with the same key and body returns the first answer withIdempotent-Replay: true.
Path parameters
| Name | Type | Description |
|---|---|---|
id | UUID | The escrow ID |
Body (JSON)
| Name | Type | Required | Description |
|---|---|---|---|
content | string | Yes, unless a file is sent | At most 3,000 characters, no <, > or " |
attachment_url | string | null | No | A file you uploaded with POST /v1/upload/chat (or escrow), not attached anywhere else yet. An escrow holds at most 200 files |
attachment_urls | string[] | No | More files, same rules, in the order to show them. With attachment_url the message holds attachment_url first, then these; a repeated URL counts once. At most 5 files in all |
Example request
curl -X POST https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/messages \
-H "Authorization: Bearer $REKBERPAY_API_KEY" \
-H "Idempotency-Key: ccccccc0-cccc-4ccc-8ccc-cccccccccccc" \
-H "Content-Type: application/json" \
-d '{
"content": "Paket sudah sampai di kantor pos, saya ambil sore ini."
}'const res = await fetch('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/messages', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.REKBERPAY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': 'ccccccc0-cccc-4ccc-8ccc-cccccccccccc',
},
body: JSON.stringify({
content: "Paket sudah sampai di kantor pos, saya ambil sore ini."
}),
});
const data = await res.json();import os
import requests
resp = requests.post(
"https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/messages",
headers={
"Authorization": f"Bearer {os.environ['REKBERPAY_API_KEY']}",
"Idempotency-Key": "ccccccc0-cccc-4ccc-8ccc-cccccccccccc",
},
json={
"content": "Paket sudah sampai di kantor pos, saya ambil sore ini.",
},
timeout=30,
)
print(resp.status_code, resp.json())<?php
$ch = curl_init('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/messages');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('REKBERPAY_API_KEY'),
'Content-Type: application/json',
'Idempotency-Key: ccccccc0-cccc-4ccc-8ccc-cccccccccccc',
],
CURLOPT_POSTFIELDS => json_encode([
'content' => 'Paket sudah sampai di kantor pos, saya ambil sore ini.',
]),
]);
$response = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);Example response
201 Created
{
"success": true,
"data": {
"id": "ddddddd0-dddd-4ddd-8ddd-dddddddddddd",
"escrow_id": "33333330-3333-4333-8333-333333333333",
"sender_id": "11111110-1111-4111-8111-111111111111",
"body": "Paket sudah sampai di kantor pos, saya ambil sore ini.",
"attachment_url": null,
"attachments": [],
"is_system": 0,
"created_at": "2026-10-13T14:23:18.734Z",
"sender_email": "[email protected]",
"sender_full_name": "Rina Wijaya",
"sender_role": "user",
"sender_participant_role": "buyer"
}
}Errors
| Status | Code | Cause |
|---|---|---|
400 | INVALID_BODY | content or a file URL is not text, or more than 5 files ("Maksimal 5 file per pesan.") |
400 | EMPTY_MESSAGE | No text and no attachment |
400 | TOO_LONG | More than 3,000 characters |
400 | INVALID_ATTACHMENT_URL | A file is not a RekberPay upload |
400 | INVALID_CONTENT | The text has <, > or " |
400 | UPLOAD_INVALID_REF, UPLOAD_NOT_FOUND, UPLOAD_NOT_OWNED, UPLOAD_WRONG_PURPOSE | A file is not one of your own chat or escrow uploads. Nothing is stored |
409 | UPLOAD_ALREADY_BOUND, UPLOAD_QUOTA | A file is attached somewhere else, or the escrow already holds 200 files |
403 | NOT_A_PARTY | You are not the buyer or the seller |
404 | NOT_FOUND | No escrow with this ID |
401 | UNAUTHORIZED, SESSION_EXPIRED, INVALID_TOKEN | No session or API key, the session expired, or the key is wrong or revoked |
401 | WORKSPACE_KEY_ONLY | A workspace key (rpe_...) was sent. Those only work under /v1/enterprise |
403 | CSRF_FAILED | Session call without the matching X-CSRF-Token header |
403 | ACCOUNT_INACTIVE, SUSPENDED | The account is closed, being deleted or suspended |
429 | RATE_LIMITED | Over the rate limit. Wait for Retry-After seconds |
Rate the other party
Rates your counterparty. Ratings stay private (published_at: null) until both sides have rated, or until 3 days have passed. Then they appear on the public profile.
- Auth: A personal API key (
Authorization: Bearer <key>) or a session cookie withX-CSRF-Tokenon writes. - Who can call: The buyer or the seller, once the escrow is
released. - Rate limit: 300 requests a minute per user, shared by every route.
- Idempotency: Not supported. A second rating answers
409 ALREADY_RATED, so a retry is safe.
Path parameters
| Name | Type | Description |
|---|---|---|
id | UUID | The escrow ID |
Body (JSON)
| Name | Type | Required | Description |
|---|---|---|---|
stars | integer | Yes | 1 to 5 |
review | string | No | At most 1,000 characters, no <, > or " |
Example request
curl -X POST https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/rate \
-H "Authorization: Bearer $REKBERPAY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"stars": 5,
"review": "Barang sesuai deskripsi, penjual responsif."
}'const res = await fetch('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/rate', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.REKBERPAY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
stars: 5,
review: "Barang sesuai deskripsi, penjual responsif."
}),
});
const data = await res.json();import os
import requests
resp = requests.post(
"https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/rate",
headers={
"Authorization": f"Bearer {os.environ['REKBERPAY_API_KEY']}",
},
json={
"stars": 5,
"review": "Barang sesuai deskripsi, penjual responsif.",
},
timeout=30,
)
print(resp.status_code, resp.json())<?php
$ch = curl_init('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/rate');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('REKBERPAY_API_KEY'),
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode([
'stars' => 5,
'review' => 'Barang sesuai deskripsi, penjual responsif.',
]),
]);
$response = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);Example response
201 Created
{
"success": true,
"data": {
"id": "33333331-3333-4333-8333-333333333333",
"stars": 5,
"review": "Barang sesuai deskripsi, penjual responsif.",
"published_at": null
}
}Errors
| Status | Code | Cause |
|---|---|---|
400 | INVALID_BODY | stars missing or out of range, or review too long |
400 | NOT_RELEASED | The escrow is not released yet |
400 | NO_COUNTERPARTY | The other seat is empty |
403 | NOT_PARTY | You are not a party to the escrow |
404 | ESCROW_NOT_FOUND | No escrow with this ID |
409 | ALREADY_RATED | You already rated this escrow |
401 | UNAUTHORIZED, SESSION_EXPIRED, INVALID_TOKEN | No session or API key, the session expired, or the key is wrong or revoked |
401 | WORKSPACE_KEY_ONLY | A workspace key (rpe_...) was sent. Those only work under /v1/enterprise |
403 | CSRF_FAILED | Session call without the matching X-CSRF-Token header |
403 | ACCOUNT_INACTIVE, SUSPENDED | The account is closed, being deleted or suspended |
429 | RATE_LIMITED | Over the rate limit. Wait for Retry-After seconds |
A real ALREADY_RATED answer:
409 Conflict
{
"success": false,
"error": {
"code": "ALREADY_RATED",
"message": "Anda sudah memberi penilaian untuk transaksi ini."
}
}Get your rating
The rating you gave on this escrow.
- Auth: A personal API key (
Authorization: Bearer <key>) or a session cookie withX-CSRF-Tokenon writes. - Who can call: The buyer or the seller.
- Rate limit: 300 requests a minute per user, shared by every route.
- Idempotency: Not needed. Reading has no side effects.
Path parameters
| Name | Type | Description |
|---|---|---|
id | UUID | The escrow ID |
Example request
curl https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/my-rating \
-H "Authorization: Bearer $REKBERPAY_API_KEY"const res = await fetch('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/my-rating', {
headers: {
Authorization: `Bearer ${process.env.REKBERPAY_API_KEY}`,
},
});
const data = await res.json();import os
import requests
resp = requests.get(
"https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/my-rating",
headers={
"Authorization": f"Bearer {os.environ['REKBERPAY_API_KEY']}",
},
timeout=30,
)
print(resp.status_code, resp.json())<?php
$ch = curl_init('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/my-rating');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('REKBERPAY_API_KEY'),
],
]);
$response = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);Example response
200 OK
{
"success": true,
"data": {
"id": "33333331-3333-4333-8333-333333333333",
"stars": 5,
"review": "Barang sesuai deskripsi, penjual responsif.",
"created_at": "2026-10-13T14:23:18.000Z",
"published_at": null
}
}Errors
| Status | Code | Cause |
|---|---|---|
404 | NO_RATING | You have not rated this escrow |
401 | UNAUTHORIZED, SESSION_EXPIRED, INVALID_TOKEN | No session or API key, the session expired, or the key is wrong or revoked |
401 | WORKSPACE_KEY_ONLY | A workspace key (rpe_...) was sent. Those only work under /v1/enterprise |
403 | ACCOUNT_INACTIVE, SUSPENDED | The account is closed, being deleted or suspended |
429 | RATE_LIMITED | Over the rate limit. Wait for Retry-After seconds |
Get both ratings
The ratings on this escrow from your point of view. Each side is null until it exists and may be shown to you: you see the other side's rating once it is published. In this example the seller asks before the buyer's rating is published.
- Auth: A personal API key (
Authorization: Bearer <key>) or a session cookie withX-CSRF-Tokenon writes. - Who can call: The buyer or the seller.
- Rate limit: 300 requests a minute per user, shared by every route.
- Idempotency: Not needed. Reading has no side effects.
Path parameters
| Name | Type | Description |
|---|---|---|
id | UUID | The escrow ID |
Example request
curl https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/ratings \
-H "Authorization: Bearer $REKBERPAY_API_KEY"const res = await fetch('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/ratings', {
headers: {
Authorization: `Bearer ${process.env.REKBERPAY_API_KEY}`,
},
});
const data = await res.json();import os
import requests
resp = requests.get(
"https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/ratings",
headers={
"Authorization": f"Bearer {os.environ['REKBERPAY_API_KEY']}",
},
timeout=30,
)
print(resp.status_code, resp.json())<?php
$ch = curl_init('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/ratings');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('REKBERPAY_API_KEY'),
],
]);
$response = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);Example response
200 OK
{
"success": true,
"data": {
"your_rating": null,
"their_rating": null
}
}Errors
| Status | Code | Cause |
|---|---|---|
403 | NOT_PARTY | You are not a party to the escrow |
404 | ESCROW_NOT_FOUND | No escrow with this ID |
401 | UNAUTHORIZED, SESSION_EXPIRED, INVALID_TOKEN | No session or API key, the session expired, or the key is wrong or revoked |
401 | WORKSPACE_KEY_ONLY | A workspace key (rpe_...) was sent. Those only work under /v1/enterprise |
403 | ACCOUNT_INACTIVE, SUSPENDED | The account is closed, being deleted or suspended |
429 | RATE_LIMITED | Over the rate limit. Wait for Retry-After seconds |
See also
- Payments: paying for an escrow
- Disputes: opening and following a dispute
- Creating escrows: the whole flow, step by step
- Errors: the error format and every shared code