We offer three types of Virtual Accounts: Reconciliation, POBO, and COBO. Ordering and updating processes vary depending on the type. Remember, Reconciliation accounts bear your name, while POBO and COBO accounts carry your customers' names.

📘

For detailed information about API usage please consult the API reference

Order Virtual Accounts

Execute a POST /api/v1/virtualaccounts/orders request to order Virtual Accounts.

• orderTypeand customerDetailsList: Specify the type - Reconciliation, Pobo, or Cobo. When ordering Pobo or Cobo, consider adding customer details during the order. If not, you can add them later using POST/api/v1/virtualAccounts/update.

🚧

In certain jurisdictions, customer details must be provided during the order.

• defaultPhysicalAccountId: Assign a "default" physical (master) account to handle payments in unassociated currencies. These payments convert to the default Master Account's currency.
• physicalAccountsList: Link the Virtual Account(s) to one or more physical (master) accounts. The linkage determines the supported currencies, and funds are settled on these Master Accounts.
• orderAmount: Order between 1 and 2,500 Virtual Accounts per call.

Example request body:

{
  "orderedAmount": 1,
  "companyNumber": "Your companyNumber",
  "defaultPhysicalAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "orderType": "Pobo",
  "customerDetailsList": [
    {
      "customerIdentifier": "string",
      "customerType": "P",
      "name": "string",
      "address1": "string",
      "address2": "string",
      "address3": "string",
      "ubOfirstname1": "string",
      "ubOlastname1": "string",
      "ubOfirstname2": "string",
      "ubOlastname2": "string",
      "ubOfirstname3": "string",
      "ubOlastname3": "string",
      "ubOfirstname4": "string",
      "ubOlastname4": "string",
      "ubOfirstname5": "string",
      "ubOlastname5": "string"
    }
  ],
  "physicalAccountsList": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}

Check your order status via GET/api/v1/virtualaccounts/orders/{orderId} or retrieve full order history via GET/api/v1/virtualaccounts/orders.

🚧

Status is "Failed"

If your order status is "Failed", contact Client Services.

Add customer details for POBO and COBO accounts

Ensure you've added customer details before transacting on a POBO or COBO Virtual Account.

To add details to existing "empty" virtual accounts, use POST/api/V1/virtualAccounts/update. You cannot update details for accounts with existing customer information. Fetch "empty" accounts using GET/api/v1/virtualAccounts/fetch.

Example request body:

{
  "companyNumber": "000015106",
  "customerDetailsList": [
    {
      "virtualAccountNumber": "0099394118",
      "customerDetails": {
        "customerIdentifier": "string",
        "customerType": "P",
        "name": "string",
        "address1": "string",
        "address2": "string",
        "address3": "string",
        "ubOfirstname1": "string",
        "ubOlastname1": "string",
        "ubOfirstname2": "string",
        "ubOlastname2": "string",
        "ubOfirstname3": "string",
        "ubOlastname3": "string",
        "ubOfirstname4": "string",
        "ubOlastname4": "string",
        "ubOfirstname5": "string",
        "ubOlastname5": "string"
      }
    }
  ]
}

Check the status via GET/api/v1/virtualAccounts/{virtualAccountNumber}/{companyNumber}/status. If the status is "Failed", contact Client Services.

Closing Virtual Accounts

It is possible to close your Virtual Accounts through our API in two different ways. You can provide the virtual accounts you wish to close in JSON format or a CSV file. More information on how to close Virtual accounts can be found here.