API create list of virtual accounts

• This is the API used to create a list of virtual accounts in the collection service.

Sequence Diagram:

• API:

  • Path: v2/col/requests

  • Method: POST

  • Request: Content-Type: application/json

Request Parameter

Parameter	Data Type	Required	Description
requestId	String	Y	The ID of the request. (UUID is generated by merchant)
virtualAccounts	Array	Y	The array contains the list of virtual accounts. Refer to VirtualAccounts

VirtualAccounts

Parameter	Data Type	Required	Description
accountName	String	Y	Bank account name Validate [A-Z0-9]{5,200}
virtualAccountRequestId	String	Y	The ID of seller/business is provided by merchant. This value is unique.
accountAddress	String	Y	The address of account. (includes the district, province)
frontIdCard	String	N	The file name of photo of the front of the ID card
backIdCard	String	N	The file name of photo of the back of the ID card
profileImg	String	N	The file name of portrait
businessRegistration	String	N	The file name of the business license.
serviceInformation	Object	N	Extra data about VA for classification purpose. Refer: ServiceInformation

ServiceInformation

Parameter	Data Type	Required	Description
code	String(20) (alphanumeric)	N	Service code which is defined by the merchants. This code will be used to filter the VAs and grouped Reconciliations on Merchant Portal
groupId	String(20) (alphanumeric)	N	Id of VA group which is defined by the merchants. This id will be used to filter the VAs on Merchant Portal
desc	String(255)	N	Description of VA

Response Data

Parameter	Data Type	Description
code	Number	Error code, refer to table of error codes.
data	Object	Ref to data object.
message	String	Error description.

data object

Parameter	Data Type	Description
requestId	String	The requestId in the request body.
merchantId	String	The ID of the merchant
status	String	The status of virtual account creation request. PASSED: Waiting for approval FAILED: Failed request
message	String	Error message detail.