Refund Virtual Account Order

POST

/v1/virtual-account/order/refund

Refund Virtual Account Order

Creates an independent refund child (RE*) for a successful original PayIn or Payout (VA*).

Identify the original order with orderId (VA*, orderStatus=SUCCESS).

Pass requestId as the merchant idempotency key for this refund call.

The original order stays SUCCESS. Do not wait for original-order orderStatus=REFUNDED.

The API returns the RE* child: orderStatus=PROCESSING, refundStatus=REFUNDING, originalOrderId = the VA* order, refundOrderId = null.

Track the final result on the RE* child via Virtual Account Payment Status or order query. Timeout / missing callback must not be treated as success.

Payout funds coming back after success use PAYOUT_REFUND + RE* only.

Refund child states

Stage	`orderStatus`	`refundStatus`
Created / channel not terminal	`PROCESSING`	`REFUNDING`
Funds confirmed and ledger posted	`REFUNDED`	`REFUNDED`
Channel explicitly failed	`FAIL`	`REFUND_FAILED`

Request

Body Params application/json

Example

{
    "orderId": "VA20260826160000000001",
    "requestId": "refund-request-10001"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/v1/virtual-account/order/refund' \
--header 'API-KEY: <api-key>' \
--header 'API-SIGNATURE: <api-key>' \
--header 'API-TIMESTAMP: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "orderId": "VA20260826160000000001",
    "requestId": "refund-request-10001"
}'

Responses

🟢200OK

application/json

Bodyapplication/json

Example

{"status": 200, "message": "ok", "data": {"orderId": "RE20260826170000000001", "orderType": "PAYIN_REFUND", "refundStatus": "REFUNDING", "originalOrderId": "VA20260826160000000001", "refundOrderId": null, "amount": "100.00", "currency": "BRL", "requestId": "refund-request-10001", "businessType": "PAYIN_REFUND", "orderStatus": "PROCESSING"}, "traceId": "uuid"}

Get Virtual Account Order Detail

List RFI Sub Virtual Account

Refund Virtual Account Order