Cancel Order VA API

Cancel a VA order via SePay API for BIDV, Sacombank, Vietcombank, VietinBank and Shinhan Bank accounts. Only Pending orders can be cancelled.

||

Cancel Order

DELETE
https://userapi.sepay.vn/v2/bank-accounts/{ba_xid}/orders/{order_xid}
Note

Only orders with Pending status can be cancelled. On cancel, the system also moves every Unpaid VA of the order to Cancelled.

Path Parameters

ba_xidstringrequired

Bank account UUID

order_xidstringrequired

Order UUID

Code Examples

>
>
>
curl --request DELETE \
--url https://userapi.sepay.vn/v2/bank-accounts/f9e8d7c6-b5a4-3210-fedc-ba0987654321/orders/b2c3d4e5-f6a7-8901-bcde-f12345678902 \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response (HTTP 204)

Empty body.

Cancellation rules by bank

BehaviorBIDVSacombankVietcombankVietinBankShinhan Bank
Cancel order and Unpaid VAsYesYesYesYesYes
May refuse to cancelNoNoYes: 403 vcb_cancel_not_allowed, 500 vcb_cancel_error, or 503 vcb_connection_errorNoYes: 500 shinhan_cancel_error or 503 shinhan_connection_error
Vietcombank orders

A Vietcombank order may not be cancellable if the invoice is already paid or cancelled on the Vietcombank side. See the error table below.

Shinhan Bank orders

SePay cancels every Unpaid VA of the order at the bank first, then closes the order. Those VA numbers therefore stop accepting money the moment you get a successful response. If the bank refuses the cancellation, the order stays Pending and you can retry, because repeating the cancellation has no side effect.

Errors

HTTPerror_codeDescription
403vcb_cancel_not_allowedVietcombank: invoice is already paid or cancelled, can no longer be cancelled. Contact SePay if you need help.
422invalid_stateOrder status does not allow cancellation (only Pending orders can be cancelled)
500vcb_cancel_errorVietcombank: unexpected error while cancelling. Contact SePay support.
503vcb_connection_errorVietcombank: service temporarily disrupted. Please try again in a few minutes.