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
profileData	Object	N	Virtual account profile data. Refer: ProfileData

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

ProfileData

Parameter	Data Type	Required	Description
merchantId	String	N	Is the ID that has been retrieved by the PSP's system, allocated to the particular merchant
merchantName	String	N	Merchant Name is the registered name, has been retrieved from PSP's system
merchantAddress	String	N	Is the address that Merchant has registered with the PSP platform
tcAcceptantDate	Datetime String (ISO 8601)	N	Is the time when the merchant has accepted the Terms and Conditions to use the service provided by PSP
legalRepresentative	String	N	Full name of the legal representative of the merchant
dob	Datetime String (ISO 8601)	N	Day of birth of legal representative/contact person
nationalIdNumber	String	N	National ID/Passport of the legal representative of the merchant
nationality	String	N	Nationality of the legal representative of the merchant
industrySegment	String	N	Based on the existing PSP system industry classification, the merchant needs to be classified into a particular industry segment.
businessType	String	N	Company/Individual
businessLicenseNumber	String	N	The license number presented in the business license has been submitted to the PSP while on board the merchant
ecomSite	String	N	Ecommerce Site (eg: "SHOPEE", "AMAZON", etc)
shopName	String	N	Shop name on ecommerce site
shopUrl	String	N	Shop URL

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.