API Reference

Payout Request (Internal Transfer)

Request

[POST] /api/v1/transfer/internal
Content-Type: application/json
x-client-id: <client_id>
x-signature: <signature>
x-timestamp: <timestamp>

Body

variableconditiontypedescription
account_idrequiredstringAccount bank number
amountrequiredfloatmin=0,max=1000000000
to_account_idrequiredstringTo VA account bank number
currency_coderequiredstringVND/USD
noteoptionalstring

📘

Please refer session Common > Bank List to get Bank code

Response

Content-Type: application/json

Body

NameTypeDescription
idstringpayment id
statusstringwaiting_confirm,processing,success
reference_idstringReference ID
bank_payment_numberstringBank payment number
remaining_tryintBeneficiary account number

Errors

StatusMesssage
201Success
401Unauthorized

Example

[POST] /api/v1/transfer/internal

Request

{
    "account_id": "81981386-f480-4ff8-ba27-ff921779fb16",
    "amount": 938000,
    "to_account_id": "72780f7f-bad9-46c0-8ef0-c3320affb430",
    "currency_code": "VND",
    "is_internal_transfer": true,
    "note": "[Open API] note for external transfer",
    "user_id": "bf86cfd4-39c6-4c88-9b4c-0fb0b93610bf"
}

Response

{
  "message": {
    "content": "Bạn vừa thực hiện tạo thành công %s"
  },
  "code": 102001,
  "request_id": "f3fe9810-c9a9-4f56-93b1-b54ef6dbcac8",
  "data": {
    "id": "a5ab9910-cdc8-4b6b-a5aa-0d3ffd72f34e",
    "status": "Success",
    "reference_id": "REF123456789",
    "bank_payment_number": "BPN987654321",
    "remaining_try": 2
  }
}