Skip to content

Payments API ​

The buyer pays an escrow through the hosted checkout at https://rekberpay.com/escrow/<id>/pay, or your app can drive the same steps with these endpoints: list the methods, start a payment, show the QRIS or transfer details, and poll the status. Jasa Pembayaran orders use the same flow under /v1/jasabayar/:id/...; see Jasa Pembayaran.

Manual methods (static QRIS and bank transfer) need one more step: after paying, the buyer calls claim-payment and RekberPay checks the transfer before the escrow becomes paid.

A manual bank transfer also carries a unique code of Rp1 to Rp999. The buyer transfers pay_total (amount plus unique_code), not amount. If you show your own transfer instructions, read Manual bank transfer and the unique code.

Endpoints ​

MethodPathEndpointAuth
GET/v1/gateways/available-methodsList payment methodsNone
GET/v1/escrows/fee-estimateEstimate the escrow feeKey or session
GET/v1/escrows/:id/fee-previewPreview the fee of an escrowKey or session
POST/v1/escrows/:id/payStart a paymentKey or session
GET/v1/escrows/:id/payment-statusGet the payment statusKey or session
POST/v1/escrows/:id/claim-paymentReport a manual transferKey or session

List payment methods ​

GET/v1/gateways/available-methods

The payment gateways that are switched on right now and the methods each one supports. Changes show up within about a minute. With amount it also prices each method for that amount, so the payer sees the total before paying. The same list serves escrows, Jasa Pembayaran orders and live enterprise milestones (Pay a milestone).

  • Auth: None needed. A signed-in caller (session cookie or personal API key) gets the manual QRIS image as a link signed for them. A workspace API key (rpe_...) is refused with 401 WORKSPACE_KEY_ONLY.
  • Rate limit: 100 requests a minute per IP address without a session, 300 a minute per user with one.
  • Idempotency: Not needed. Reading has no side effects.

Query parameters ​

NameTypeRequiredDescription
amountintegerNoRupiah the payer will pay before the method fee, 1 to 12 digits. Adds surcharge, payment_fee, fee_bearer, seller_fee and payer_total to every method, and leaves out a method that cannot take this amount. Anything else is ignored
kindstringNoWhat is being paid: escrow (default), jasabayar, enterprise or platform (a Platform checkout). The method fee of a manual method on an escrow follows RekberPay's current setting; for the others the payer always bears it
per_methodstringNo1 for gateways that price each method apart: every method stays in supported_methods, with its own fee rule in method_fees and, with amount, its own quote in method_quotes. Without it, such a gateway is shown with only its first method and that method's fee in the top-level fields

The example run below had both manual method fees set to 0. With the default fees (see Manual method fees) manual QRIS answers "fee_mode": "tiered" and manual bank transfer "fee_fixed": 1000. Only one automatic gateway offers QRIS at a time.

Example request ​

bash
curl https://api.rekberpay.com/v1/gateways/available-methods
js
const res = await fetch('https://api.rekberpay.com/v1/gateways/available-methods', {
});
const data = await res.json();
python
import os

import requests

resp = requests.get(
    "https://api.rekberpay.com/v1/gateways/available-methods",
    timeout=30,
)
print(resp.status_code, resp.json())
php
<?php

$ch = curl_init('https://api.rekberpay.com/v1/gateways/available-methods');
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

json
{
    "success": true,
    "data": [
        {
            "provider": "manual_qris",
            "display_name": "Manual QRIS (static)",
            "supported_methods": [
                "qris"
            ],
            "is_manual": true,
            "is_wallet": false,
            "fee_percent": 0,
            "fee_fixed": 0,
            "fee_mode": "flat",
            "fee_tier_threshold_idr": 0,
            "fee_below_fixed_idr": 0,
            "fee_below_percent": 0,
            "fee_above_percent": 0,
            "config": {
                "qris_image_url": "https://api.rekberpay.com/uploads/escrow/1779846015565_f14a5645.jpg"
            }
        },
        {
            "provider": "bank_transfer_manual",
            "display_name": "Bank Transfer (Manual)",
            "supported_methods": [
                "bank_transfer"
            ],
            "is_manual": true,
            "is_wallet": false,
            "fee_percent": 0,
            "fee_fixed": 0,
            "fee_mode": "flat",
            "fee_tier_threshold_idr": 0,
            "fee_below_fixed_idr": 0,
            "fee_below_percent": 0,
            "fee_above_percent": 0,
            "config": {
                "bank_name": "Bank Mandiri",
                "account_number": "1234567890",
                "account_holder": "PT RekberPay Indonesia"
            }
        }
    ]
}
FieldTypeDescription
providerstringGateway slug. Pass it as provider to choose this gateway
supported_methodsstring[]Values for method in Start a payment
is_manualbooleantrue when RekberPay checks the transfer by hand. The buyer must call claim-payment
is_walletbooleantrue for the RekberPay balance. It cannot pay an enterprise milestone
fee_modestringflat (fee_percent plus fee_fixed) or tiered (below fee_tier_threshold_idr a fixed fee_below_fixed_idr plus fee_below_percent percent, from it fee_above_percent percent)
fee_percentnumberSurcharge percentage added to the amount. For a tiered rule, the larger of fee_above_percent and fee_below_percent
fee_fixednumberFixed surcharge in rupiah. For a tiered rule, fee_below_fixed_idr
surcharge, payment_fee, fee_bearer, seller_fee, payer_totalnumber, number, string, number, numberOnly with amount. payment_fee is the method fee, fee_bearer (buyer or seller) who bears it, surcharge what is added to the payer's total, and payer_total is amount plus surcharge
min_amount, max_amountnumberOnly on the wallet: the amount limits (max_amount is null without a cap)
va_channels, default_va_channelstring[], stringOnly on a gateway with virtual accounts: the banks the payer may pick as channel (for example bca, bni, bri, mandiri) and the bank used when none is picked
cstore_channels, cstore_store_feesstring[], objectOnly when cstore is offered: the stores (alfamart, indomaret) to pass as channel, and what each store is expected to add at its cashier, in rupiah
method_fees, method_quotesobjectOnly with per_method=1, on a gateway that prices methods apart: the fee fields per method, and with amount the quote per method
configobjectOnly on manual methods: what to show the buyer. qris_image_url for QRIS, or bank_name, account_number and account_holder for a transfer

Errors ​

StatusCodeCause
429RATE_LIMITEDOver the rate limit. Wait for Retry-After seconds

Estimate the escrow fee ​

GET/v1/escrows/fee-estimate

What the seller receives for an amount, before any escrow exists. Use it on price forms instead of computing the fee yourself. The caller is priced as the seller, so their loyalty level discount and their best unused escrow fee voucher are included. Reading the estimate never uses a voucher up; that happens at release.

  • Auth: A personal API key (Authorization: Bearer <key>) or a session cookie with X-CSRF-Token on writes.
  • Rate limit: 300 requests a minute per user, shared by every route.
  • Idempotency: Not needed. Reading has no side effects.

Query parameters ​

NameTypeRequiredDescription
amountintegerYesRupiah, 1,000 to 500,000,000

Example request ​

bash
curl "https://api.rekberpay.com/v1/escrows/fee-estimate?amount=250000" \
  -H "Authorization: Bearer $REKBERPAY_API_KEY"
js
const res = await fetch('https://api.rekberpay.com/v1/escrows/fee-estimate?amount=250000', {
    headers: {
        Authorization: `Bearer ${process.env.REKBERPAY_API_KEY}`,
    },
});
const data = await res.json();
python
import os

import requests

resp = requests.get(
    "https://api.rekberpay.com/v1/escrows/fee-estimate?amount=250000",
    headers={
        "Authorization": f"Bearer {os.environ['REKBERPAY_API_KEY']}",
    },
    timeout=30,
)
print(resp.status_code, resp.json())
php
<?php

$ch = curl_init('https://api.rekberpay.com/v1/escrows/fee-estimate?amount=250000');
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

json
{
    "success": true,
    "data": {
        "gross": 250000,
        "fee": 7500,
        "net": 242500,
        "manual_payment_fee": 0,
        "fee_type": "percentage",
        "fee_value": 3,
        "fee_before_discount": 7500,
        "loyalty_discount_percent": 0,
        "loyalty_discount_idr": 0,
        "voucher_code": null,
        "voucher_discount_idr": 0
    }
}
FieldTypeDescription
grossintegerThe amount
feeintegerRekberPay fee, paid by the seller on release, after discounts
netintegerWhat the seller receives
manual_payment_feeintegerA manual transfer or QRIS fee the seller bears, taken at release. 0 in an estimate and whenever the buyer bears that fee
fee_type, fee_valuestring, numberThe fee rule: percentage or fixed and its value
fee_before_discountintegerThe fee before the loyalty discount and the voucher
loyalty_discount_percentnumberThe seller's loyalty level discount on the fee, 0 to 100
loyalty_discount_idrintegerRupiah the loyalty discount takes off
voucher_codestring | nullThe escrow fee voucher that applies, if any
voucher_discount_idrintegerRupiah the voucher takes off, after the loyalty discount

Errors ​

StatusCodeCause
400INVALID_AMOUNTamount is missing or out of range
401UNAUTHORIZED, SESSION_EXPIRED, INVALID_TOKENNo session or API key, the session expired, or the key is wrong or revoked
401WORKSPACE_KEY_ONLYA workspace key (rpe_...) was sent. Those only work under /v1/enterprise
403ACCOUNT_INACTIVE, SUSPENDEDThe account is closed, being deleted or suspended
429RATE_LIMITEDOver the rate limit. Wait for Retry-After seconds

A real INVALID_AMOUNT answer:

400 Bad Request

json
{
    "success": false,
    "error": {
        "code": "INVALID_AMOUNT",
        "message": "Nominal harus antara Rp1.000 dan Rp500.000.000."
    }
}

Preview the fee of an escrow ​

GET/v1/escrows/:id/fee-preview

The same breakdown as the estimate, for an existing escrow, priced with this escrow's seller's loyalty discount and fee voucher. When the buyer pays (or paid) with a manual method whose fee the seller bears, manual_payment_fee shows it and net is lower by that much. Once the escrow is released it shows the fee that was actually booked.

  • Auth: A personal API key (Authorization: Bearer <key>) or a session cookie with X-CSRF-Token on writes.
  • Who can call: The seller. The fee is not shown to the buyer.
  • Rate limit: 300 requests a minute per user, shared by every route.
  • Idempotency: Not needed. Reading has no side effects.

Path parameters ​

NameTypeDescription
idUUIDThe escrow ID

Example request ​

bash
curl https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/fee-preview \
  -H "Authorization: Bearer $REKBERPAY_API_KEY"
js
const res = await fetch('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/fee-preview', {
    headers: {
        Authorization: `Bearer ${process.env.REKBERPAY_API_KEY}`,
    },
});
const data = await res.json();
python
import os

import requests

resp = requests.get(
    "https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/fee-preview",
    headers={
        "Authorization": f"Bearer {os.environ['REKBERPAY_API_KEY']}",
    },
    timeout=30,
)
print(resp.status_code, resp.json())
php
<?php

$ch = curl_init('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/fee-preview');
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

json
{
    "success": true,
    "data": {
        "escrow_id": "33333330-3333-4333-8333-333333333333",
        "gross": 250000,
        "fee": 7500,
        "net": 242500,
        "manual_payment_fee": 0,
        "fee_type": "percentage",
        "fee_value": 3,
        "fee_before_discount": 7500,
        "loyalty_discount_percent": 0,
        "loyalty_discount_idr": 0,
        "voucher_code": null,
        "voucher_discount_idr": 0
    }
}

Errors ​

StatusCodeCause
403FORBIDDENYou are not the seller of the escrow
404ESCROW_NOT_FOUNDNo escrow with this ID
401UNAUTHORIZED, SESSION_EXPIRED, INVALID_TOKENNo session or API key, the session expired, or the key is wrong or revoked
401WORKSPACE_KEY_ONLYA workspace key (rpe_...) was sent. Those only work under /v1/enterprise
403ACCOUNT_INACTIVE, SUSPENDEDThe account is closed, being deleted or suspended
429RATE_LIMITEDOver the rate limit. Wait for Retry-After seconds

Start a payment ​

POST/v1/escrows/:id/pay

Starts a payment with the chosen method and returns what to show the buyer: a QRIS image, virtual account, transfer details, a store payment code or a gateway page.

  • Auth: A personal API key (Authorization: Bearer <key>) or a session cookie with X-CSRF-Token on writes.
  • Who can call: The buyer, with a confirmed email and a complete profile, while the escrow is pending_payment. When the buyer seat is still empty, the caller takes it first, with the same checks as joining, and then pays as the buyer. The seller can never pay.
  • Rate limit: 10 payment starts a minute per user, on top of the shared 300 requests a minute.
  • Idempotency: Send an Idempotency-Key header (UUID v4). A retry with the same key and body returns the first answer with Idempotent-Replay: true.

If the payment itself then fails (for example the balance is too low), the caller keeps the buyer seat.

Picking a method again is safe:

  • The same manual method, while its payment is the newest and still open, answers 200 OK with that payment and "resumed": true instead of making a new one. The same happens for an automatic QRIS whose code can still be scanned.
  • Switching to another method makes a new payment. An older open QRIS of the escrow is cancelled where the gateway allows it. If the older one turns out to be paid already, the answer is 409 ESCROW_ALREADY_PAID and that payment funds the escrow.
  • An escrow holds at most 5 open automatic payments at once (429 TOO_MANY_PAYMENT_LINKS). Use one of them or wait until it expires.

Path parameters ​

NameTypeDescription
idUUIDThe escrow ID

Body (JSON) ​

NameTypeRequiredDescription
methodstringYesA method from supported_methods (for example qris, bank_transfer or cstore), or wallet to pay from the RekberPay balance when that is switched on
providerstringNoA specific gateway. When left out, an automatic gateway that offers the method is chosen first, then a manual one. A gateway that prices methods apart is only used when you name it
channelstringNoWith bank_transfer on a gateway that lists va_channels: the virtual account bank, for example bca. With cstore it is required: alfamart or indomaret from cstore_channels. Not allowed with wallet

Example request ​

bash
curl -X POST https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/pay \
  -H "Authorization: Bearer $REKBERPAY_API_KEY" \
  -H "Idempotency-Key: 66666660-6666-4666-8666-666666666666" \
  -H "Content-Type: application/json" \
  -d '{
    "method": "qris"
  }'
js
const res = await fetch('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/pay', {
    method: 'POST',
    headers: {
        Authorization: `Bearer ${process.env.REKBERPAY_API_KEY}`,
        'Content-Type': 'application/json',
        'Idempotency-Key': '66666660-6666-4666-8666-666666666666',
    },
    body: JSON.stringify({
        method: "qris"
    }),
});
const data = await res.json();
python
import os

import requests

resp = requests.post(
    "https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/pay",
    headers={
        "Authorization": f"Bearer {os.environ['REKBERPAY_API_KEY']}",
        "Idempotency-Key": "66666660-6666-4666-8666-666666666666",
    },
    json={
        "method": "qris",
    },
    timeout=30,
)
print(resp.status_code, resp.json())
php
<?php

$ch = curl_init('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/pay');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('REKBERPAY_API_KEY'),
        'Content-Type: application/json',
        'Idempotency-Key: 66666660-6666-4666-8666-666666666666',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'method' => 'qris',
    ]),
]);
$response = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);

Example response ​

201 Created

json
{
    "success": true,
    "data": {
        "payment_link_id": "77777770-7777-4777-8777-777777777777",
        "gateway_order_id": "RBP-33333330-1791901398340-ba720621",
        "method": "qris",
        "provider": "manual_qris",
        "qr_code_url": "https://api.rekberpay.com/uploads/escrow/1779846015565_f14a5645.jpg",
        "expires_at": "2026-10-13T15:23:18.340Z",
        "amount": 250000,
        "escrow_amount": 250000,
        "surcharge": 0,
        "payment_fee": 0,
        "fee_bearer": "buyer",
        "seller_fee": 0
    }
}
FieldTypeDescription
payment_link_idUUIDPayment ID. payment-status returns it as id
gateway_order_idstringThe reference of this payment. Quote it to support
methodstringThe method used
providerstringThe gateway that was chosen
qr_code_urlstringQRIS image. Only for QRIS methods
va_number, va_bankstringVirtual account number and its bank. Only for virtual account methods
payment_urlstringHosted gateway page. Only for gateways that have one
deep_link_urlstringA link that opens the payer's banking or wallet app, when the gateway gives one
expires_atstringWhen this payment session ends
amountintegerThe escrow amount plus surcharge. This is the figure to pay, except for a manual bank transfer, where the buyer transfers pay_total
escrow_amountintegerThe escrow amount alone
surchargeintegerWhat the method fee adds to the buyer's total. 0 when the seller bears it
payment_feeintegerThe method fee, whoever bears it
fee_bearerstringbuyer or seller: who bears payment_fee. Only a manual method on an escrow can be seller
seller_feeintegerThe part of payment_fee taken from the seller at release
pay_total, unique_code, qr_expires_atinteger, integer, stringAn exact total to pay. A manual bank transfer (rekber and Jasa Pembayaran) always has one, and so do some automatic QRIS payments: transfer exactly pay_total, which is amount plus a unique_code of Rp1 to Rp999, down to the last 3 digits. amount keeps its meaning. The code is part of the transfer fee and is not refunded. See Manual bank transfer and the unique code. A QRIS payment must be paid before qr_expires_at, when the QR stops working
payment_name, store_feestring, integerOnly for cstore: the name to give the cashier, and the fee the store adds. The payment code is in va_number and va_bank names the store
resumedbooleantrue on a 200 OK that shows an open payment again instead of making a new one

A manual bank transfer answers with the account to pay into in va_number and va_bank, and the exact figure in pay_total:

json
{
    "success": true,
    "data": {
        "payment_link_id": "77777771-7777-4777-8777-777777777777",
        "gateway_order_id": "RBP-33333330-1791901398340-c41d9e02",
        "method": "bank_transfer",
        "provider": "bank_transfer_manual",
        "va_number": "1234567890",
        "va_bank": "bank_mandiri",
        "expires_at": "2026-11-10T03:12:44.000Z",
        "amount": 251000,
        "escrow_amount": 250000,
        "surcharge": 1000,
        "payment_fee": 1000,
        "fee_bearer": "buyer",
        "seller_fee": 0,
        "pay_total": 251347,
        "unique_code": 347
    }
}

The buyer transfers Rp251.347, then calls claim-payment.

Fields that do not apply to the method are left out. A wallet payment settles at once and answers 201 with payment_link_id, method and provider (wallet), status: "paid", amount, escrow_amount, surcharge and new_balance. When expires_at passes, start a new payment with a new Idempotency-Key.

Errors ​

StatusCodeCause
400MISSING_METHODNo method in the body
400UNSUPPORTED_METHODNo enabled gateway supports the method, or the named provider is not available
400INVALID_CHANNELchannel is not a bank or store this gateway offers, is missing for cstore, or was sent with wallet
400AMOUNT_OUT_OF_RANGEThe total is outside what this method takes. Pick another method
400WALLET_DISABLEDPaying from the balance is switched off
400BELOW_MIN_AMOUNT, ABOVE_MAX_AMOUNTThe amount is outside the wallet limits
402INSUFFICIENT_BALANCEThe balance does not cover the total
403NOT_BUYERYou are the seller, or another user already holds the buyer seat
403EMAIL_NOT_VERIFIEDYou signed up with email and password and have not confirmed the email yet
409PROFILE_INCOMPLETEYour account has no name or WhatsApp number yet, or has not accepted the Terms
409ACCOUNT_NOT_ACTIVETaking the empty buyer seat failed because an account is not active
409PAYMENT_IN_PROGRESSAn earlier QRIS of this escrow could not be cancelled yet. Use it, or wait until it expires
429TOO_MANY_PAYMENT_LINKSThe escrow already has 5 open automatic payments
429TOO_MANY_OPEN_PAYMENTSYou have too many open QRIS payments. Finish or cancel one first
400, 403, 429NONKYC_LIMIT_AMOUNT, NONKYC_LIMIT_LIFETIME, NONKYC_LIMIT_DAILYTaking the empty buyer seat would put your account without KYC over a limit. See limits
403NONKYC_LIMIT_SELLER_AT_PAYMENTA signed-link escrow whose seller has no room left in their account limit. Ask the seller
404ESCROW_NOT_FOUNDNo escrow with this ID
409INVALID_STATEThe escrow is not waiting for payment
409ESCROW_ALREADY_PAIDAn earlier payment of this escrow turned out to be paid already. Nothing was charged and the escrow is funded by that payment
409COUNTERPARTY_SUSPENDEDThe seller is suspended, flagged for fraud or closing its account. Nothing was charged and no payment code was made
500WALLET_PAYMENT_FAILEDThe balance payment failed. Nothing was charged
502GATEWAY_ERRORThe gateway refused the charge. Try again or pick another method
503NO_GATEWAYS, ADAPTER_NOT_LOADED, GATEWAY_MISCONFIGUREDNo gateway, or not this one, is available right now. Try again later or pick another method
503UNIQUE_CODE_BUSYA manual bank transfer found no free unique code for this total. Nothing was charged. Try again in a moment or pick another method
401UNAUTHORIZED, SESSION_EXPIRED, INVALID_TOKENNo session or API key, the session expired, or the key is wrong or revoked
401WORKSPACE_KEY_ONLYA workspace key (rpe_...) was sent. Those only work under /v1/enterprise
403CSRF_FAILEDSession call without the matching X-CSRF-Token header
403ACCOUNT_INACTIVE, SUSPENDEDThe account is closed, being deleted or suspended
429RATE_LIMITEDOver the rate limit. Wait for Retry-After seconds

An UNSUPPORTED_METHOD answer:

400 Bad Request

json
{
    "success": false,
    "error": {
        "code": "UNSUPPORTED_METHOD",
        "message": "Pembayaran lewat gopay sedang tidak tersedia. Pilih metode pembayaran lain."
    }
}

A real NOT_BUYER answer:

403 Forbidden

json
{
    "success": false,
    "error": {
        "code": "NOT_BUYER",
        "message": "Hanya pembeli di rekber ini yang bisa membayar."
    }
}

Get the payment status ​

GET/v1/escrows/:id/payment-status

The latest payment attempt for the escrow. Poll it every 5 seconds while status is pending or awaiting_confirmation, stop at paid, failed or expired, and show a "payment pending" message after about two minutes. This answer is from after RekberPay confirmed the transfer. Only the newest attempt is shown: after the buyer switches method, the older one is no longer returned.

  • Auth: A personal API key (Authorization: Bearer <key>) or a session cookie with X-CSRF-Token on 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 ​

NameTypeDescription
idUUIDThe escrow ID

Example request ​

bash
curl https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/payment-status \
  -H "Authorization: Bearer $REKBERPAY_API_KEY"
js
const res = await fetch('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/payment-status', {
    headers: {
        Authorization: `Bearer ${process.env.REKBERPAY_API_KEY}`,
    },
});
const data = await res.json();
python
import os

import requests

resp = requests.get(
    "https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/payment-status",
    headers={
        "Authorization": f"Bearer {os.environ['REKBERPAY_API_KEY']}",
    },
    timeout=30,
)
print(resp.status_code, resp.json())
php
<?php

$ch = curl_init('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/payment-status');
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

json
{
    "success": true,
    "data": {
        "id": "77777770-7777-4777-8777-777777777777",
        "escrow_id": "33333330-3333-4333-8333-333333333333",
        "provider": "manual_qris",
        "method": "qris",
        "gateway_order_id": "RBP-33333330-1791901398340-ba720621",
        "amount": "250000.00",
        "status": "paid",
        "qr_url": "https://api.rekberpay.com/uploads/escrow/1779846015565_f14a5645.jpg",
        "va_number": null,
        "redirect_url": null,
        "expires_at": "2026-10-13T15:23:18.340Z",
        "created_at": "2026-10-13T14:23:18.340Z",
        "updated_at": "2026-10-13T14:23:18.364Z",
        "paid_at": "2026-10-13T14:23:18.364Z",
        "surcharge_idr": "0.00",
        "surcharge_bearer": "buyer"
    }
}
FieldTypeDescription
statusstringpending (waiting for the money), awaiting_confirmation (a manual transfer was reported and RekberPay is checking it), paid, expired, failed, rejected (RekberPay could not confirm the transfer), fraud (refused by RekberPay) or superseded (replaced by another payment, or retired when the escrow was cancelled). Treat an unknown value as not paid
amountstringThe escrow amount plus the method fee, with two decimals. For a manual bank transfer the buyer transfers pay_total
qr_urlstring | nullQRIS image, when the method has one
va_numberstring | nullVirtual account number, when the method has one
redirect_urlstring | nullHosted gateway page, when there is one
paid_atstring | nullWhen the payment was confirmed
surcharge_idrstring | nullThe method fee of this payment, with two decimals
surcharge_bearerstring | nullbuyer or seller: who bears surcharge_idr
va_bank, payment_name, store_fee, pay_total, unique_code, qr_expires_atmixedPresent only when they apply, as in Start a payment

Errors ​

StatusCodeCause
403FORBIDDENYou are not a party to the escrow
404ESCROW_NOT_FOUNDNo escrow with this ID
404NO_PAYMENTNo payment was started yet. Not a failure
401UNAUTHORIZED, SESSION_EXPIRED, INVALID_TOKENNo session or API key, the session expired, or the key is wrong or revoked
401WORKSPACE_KEY_ONLYA workspace key (rpe_...) was sent. Those only work under /v1/enterprise
403ACCOUNT_INACTIVE, SUSPENDEDThe account is closed, being deleted or suspended
429RATE_LIMITEDOver the rate limit. Wait for Retry-After seconds

A real NO_PAYMENT answer:

404 Not Found

json
{
    "success": false,
    "error": {
        "code": "NO_PAYMENT",
        "message": "Belum ada pembayaran untuk rekber ini."
    }
}

Report a manual transfer ​

POST/v1/escrows/:id/claim-payment

The buyer's "I have paid" button for manual QRIS and bank transfer. The escrow moves from pending_payment to pending_review and the payment to awaiting_confirmation while RekberPay checks the transfer. No money moves in this call. Send {} as the body.

  • Auth: A personal API key (Authorization: Bearer <key>) or a session cookie with X-CSRF-Token on writes.
  • Who can call: The buyer, after paying with a manual method.
  • Rate limit: 300 requests a minute per user, shared by every route.
  • Idempotency: Send an Idempotency-Key header (UUID v4). A retry with the same key and body returns the first answer with Idempotent-Replay: true.

Path parameters ​

NameTypeDescription
idUUIDThe escrow ID

Example request ​

bash
curl -X POST https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/claim-payment \
  -H "Authorization: Bearer $REKBERPAY_API_KEY" \
  -H "Idempotency-Key: 88888880-8888-4888-8888-888888888888" \
  -H "Content-Type: application/json" \
  -d '{}'
js
const res = await fetch('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/claim-payment', {
    method: 'POST',
    headers: {
        Authorization: `Bearer ${process.env.REKBERPAY_API_KEY}`,
        'Content-Type': 'application/json',
        'Idempotency-Key': '88888880-8888-4888-8888-888888888888',
    },
    body: JSON.stringify({}),
});
const data = await res.json();
python
import os

import requests

resp = requests.post(
    "https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/claim-payment",
    headers={
        "Authorization": f"Bearer {os.environ['REKBERPAY_API_KEY']}",
        "Idempotency-Key": "88888880-8888-4888-8888-888888888888",
    },
    json={},
    timeout=30,
)
print(resp.status_code, resp.json())
php
<?php

$ch = curl_init('https://api.rekberpay.com/v1/escrows/33333330-3333-4333-8333-333333333333/claim-payment');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('REKBERPAY_API_KEY'),
        'Content-Type: application/json',
        'Idempotency-Key: 88888880-8888-4888-8888-888888888888',
    ],
    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

json
{
    "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_review",
        "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",
        "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.352Z",
        "user_role": "buyer"
    }
}

Errors ​

StatusCodeCause
403NOT_BUYEROnly the buyer can claim
403EMAIL_NOT_VERIFIEDYou signed up with email and password and have not confirmed the email yet
403NONKYC_LIMIT_SELLER_AT_PAYMENTA signed-link escrow whose seller has no room left in their account limit. Ask the seller
404ESCROW_NOT_FOUNDNo escrow with this ID
409NO_MANUAL_PAYMENTThere is no manual payment waiting
409INVALID_STATEThe escrow is no longer pending_payment
401UNAUTHORIZED, SESSION_EXPIRED, INVALID_TOKENNo session or API key, the session expired, or the key is wrong or revoked
401WORKSPACE_KEY_ONLYA workspace key (rpe_...) was sent. Those only work under /v1/enterprise
403CSRF_FAILEDSession call without the matching X-CSRF-Token header
403ACCOUNT_INACTIVE, SUSPENDEDThe account is closed, being deleted or suspended
429RATE_LIMITEDOver the rate limit. Wait for Retry-After seconds

A real INVALID_STATE answer:

409 Conflict

json
{
    "success": false,
    "error": {
        "code": "INVALID_STATE",
        "message": "Tidak dapat klaim pembayaran dari status: pending_review"
    }
}

See also ​

Escrow, payment services and B2B deals for Indonesian businesses.