4. Confirm Transfer
Introduction:
This API confirms and submits a transfer order. Before calling this endpoint, verify that the expiredAt
timestamp from the Transfer Estimation API has not passed. If it has, please re-estimate the transfer.
Endpoint: /v1/transfer/order-confirm
- Method:
POST
Request
fieldName |
Type |
Required |
Description |
transferId |
string |
Y |
The transfer ID obtained from the Transfer Calculation API |
merchantTranId |
string |
Y |
The merchant’s unique transaction ID |
Response
fieldName |
Type |
Description |
status |
string |
SUCCESS or FAIL indicating the confirmation outcome |
reason |
string |
Explanation for failure (present only when status = FAIL ) |
qrCodeString |
string |
Encoded QR code payload for completing the transfer (e.g., PIX flow) |
expireAt |
string |
QR code expiration timestamp (ISO 8601) |
Response Example
{
"status": 200,
"code": null,
"msg": "OK",
"data": {
"status": "SUCCESS",
"reason": "Vendor rejected",
"qrCodeString": "0002012636...",
"expireAt": "2025-06-20T10:00:00Z",
},
"traceId": "Auto:75f476b99c26423d93c93682dd4ce030"
}
Error Response Example
{
"status": 400,
"code": "CONFIRM0001",
"message": "Transfer expired, please re-calculate.",
"traceId": "e8b6f3c4-1a2d-4f5e-b678-1234567890ab"
}
code |
message |
Meaning |
CONFIRM0001 |
Transfer expired, please re-calculate. |
The transfer validity window has expired. |
CONFIRM0002 |
Invalid transferId: abc123 |
The provided transferId does not exist. |
CONFIRM0003 |
Mismatched merchantTranId |
The provided merchantTranId does not match records. |
CONFIRM0000 |
Internal server error |
An unexpected server error occurred—please retry later. |
- Notes:
- Multiple calls with the same
transferId
and merchantTranId
will return the same QR code if it is still valid.