Cashout Request (External Transfer)

Request

URL

[POST] /api/v1/transfer/external

Headers

Content-Type: application/json
x-client-id: <client_id>
x-signature: <signature>
x-timestamp: <timestamp>

Body

variable	condition	type	description
account_id	required	string	Account bank number
amount	required	float	min=0,max=1000000000
beneficiary_bank_id	required	string	Beneficiary bank ID
beneficiary_account_name	required	string	Beneficiary account name
beneficiary_account_number	required	string	Beneficiary account number
currency_code	required	string	VND/USD
note	optional	string

📘

Please refer session Common > Bank List to get Bank code

Response

Headers

Content-Type: application/json

Body

Name	Type	Description
id	string	payment id
status	string	waiting_confirm,processing,success
reference_id	string	Reference ID
bank_payment_number	string	Bank payment number
remaining_try	int	Beneficiary account number

Errors

Status	Messsage
201	Success
401	Unauthorized

Example

URL

[POST] /api/v1/transfer/external

Request

Body

{
    "account_id": "1AM002110000114",
    "amount": 938000,
    "beneficiary_account_name": "ACCOUNT NAME EXTERNAL BANK",
    "beneficiary_account_number": "ACCOUNT NUMBER EXTERNAL BANK",
    "beneficiary_bank_id": "EXTERNAL BANK ID",
    "currency_code": "VND",
    "note": "[Open API] note for external transfer"
}

Response

Body

{
  "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
  }
}