Create virtual account
Header Parameters
X-Auth-User-IDstring Required
MatchMove provided hash ID for the user
Min length
32
Max length
32
Authorizationstring
Response
200
Object
OK
Response Attributes
idstring Required
VA Hash Identifier
hash_idstring
VA Hash Identifier
account_idstring
Account Identifier
account_nostring
Account Number
account_numberstring Required
Account Number
account_holder_namestring
Account Name
account_bank_namestring Required
Virtual Account Bank. Value can be empty.
account_bank_addressstring Required
Virtual Account Bank Address. Value can be empty.
account_bank_countrystring Required
Virtual Account Bank Country of Issue. Value can be empty.
bank_codestring
VA Bank Code
reversal_destinationobject
Show child attributes
created_atstring Required
Created Date
assigned_atstring
Assigned Date
statusstring Required
A "rejected" status means virtual accounts are unavailable to the customer, while "terminated" indicates that the user account is closed.
Enum values:
activeinactiveterminatedinitialisedpendingrejectedpending_activationfailedremarksstring
virtual account status description
400
Object
Validation error
| Code | Description |
| :--- | :---------- |
| 400 | Error: The {identity document type} identity document type provided on the customer profile is not supported.|
| 400 | Error: A valid identity document number must be provided on the customer’s profile.|
| 400 | Error: A valid identity document issuance country must be provided on the customer’s profile.|
| 400 | Error: A valid birthday must be provided on the customer’s profile.|
| 400 | Error: A valid nationality must be provided on the customer’s profile.|
| 400 | Error: A valid residential address country must be provided on the customer’s profile|
| 400 | Error: Virtual account is currently in an active state|
| 400 | Error: Virtual account is currently in an pending state|
| 400 | Error: Virtual account is currently in an rejected state|
| 400 | Error: Virtual account is currently in an inacitve state|
| 400 | Error: Virtual account is currently in an terminated state|
| 400 | Error: The user risk status is invalid|
| 400 | Error: The user kyc status is invalid|
| 400 | Error: A valid foundation_date must be provided on the business profile|
| 400 | Error: A valid tax_id_type must be provided on the business profile|
| 400 | Error: A valid tax_id_number must be provided on the business profile|
| 400 | Error: A valid tax_id_issuance_country must be provided on the business profile|
| 400 | Error: A valid operational address must be provided on the business profile|
| 400 | Error: A valid foundation address must be provided on the business profile|
Response Attributes
codeinteger Required
descriptionstring Required
linkstring Required
401
Object
Unauthorized request
Response Attributes
codeinteger Required
descriptionstring Required
linkstring Required
403
Object
Forbidden
Response Attributes
codeinteger Required
descriptionstring Required
linkstring Required
404
Object
Resource not found
Response Attributes
codeinteger Required
descriptionstring Required
linkstring Required
500
Object
Internal server Error
Response Attributes
codeinteger Required
descriptionstring Required
linkstring Required
502
Object
Bad Gateway
Response Attributes
codeinteger Required
descriptionstring Required
linkstring Required
503
Object
External Service Error
Response Attributes
codeinteger Required
descriptionstring Required
linkstring Required
504
Object
Gateway timeout
Response Attributes
codeinteger Required
descriptionstring Required
linkstring Required
Was this section helpful?
Response
Was this section helpful?