Create virtual account

Create a new virtual account for a customer with account name, master account number, limit, and limit amount

SecurityoAuth2
Request
path Parameters
customerUID
required
string

Customer Id

Request Body schema: application/json

Account Info

accountName
required
string <= 255 characters

Name for the account. Only letters, numbers, and spaces are allowed.

masterAccountNumber
required
string <= 255 characters

Master Account Number of the partner

limit
required
string

Cost Center associated with the customer entity

Enum: "Monthly" "Quarterly" "HalfYearly" "Annually"
limitAmount
required
number <double>
productCode
required
string

product code

purpose
string

purpose

submittedBy
string

User who submitted the request

Responses
200

OK

400

Bad request

401

You are not authorized to access the resource

403

Accessing the resource you were trying to reach is forbidden

404

The resource you were trying to reach is not found

500

Internal server error

503

Service unavailable

default

Successful

post/v2/{customerUID}/virtual-accounts
Request samples
application/json
{
  • "accountName": "xyz 123",
  • "masterAccountNumber": "xyz 123",
  • "limit": "Monthly",
  • "limitAmount": 0,
  • "productCode": "string",
  • "purpose": "string",
  • "submittedBy": "string"
}
Response samples
application/json
{
  • "accountName": "xyz 123",
  • "accountNumber": 1234567890,
  • "productCode": "string",
  • "routingNumber": 123456789,
  • "accountBalance": 10000.5,
  • "accountStatus": "Active",
  • "accountPurpose": "Payment processing",
  • "accountCreatedOn": "2024-01-15T10:30:00Z",
  • "customerShortName": "ABC Corp",
  • "customerLegalName": "ABC Corporation Inc.",
  • "customerId": "CUST001",
  • "customerEmailAddress": "contact@abccorp.com",
  • "customerPhoneNumber": "+1-555-123-4567",
  • "masterAccountName": "Master Account 001",
  • "masterAccountNumber": "MASTER001",
  • "limit": "Monthly",
  • "limitAmount": 50000,
  • "purpose": "Payment processing"
}