Create a virtual account

Requests a STATIC or DYNAMIC virtual account. Use a current four-character bankCode returned by List collection banks for the same account type and service.

Creation is asynchronous. A 201 response returns the account ID and means processing has started; it does not mean bank details are ready. Use List or retrieve virtual accounts until the status becomes COMPLETE or FAILED.

Dynamic accounts are temporary and generally expire 30 minutes after creation. Do not accept or direct payments to an expired account.

Body Params

Static or dynamic virtual account to create.

string
required
length between 4 and 4

Four-character code returned by collection-bank discovery for a DYNAMIC FCAT account.

integer
≥ 0

Expected payment amount. Some available account options require this value and enforce a minimum; when that applies, the API returns the required minimum in its validation message.

string
Defaults to 1

Requested usage frequency. The account still expires at the end of its temporary validity window.

string
required

Customer first name for dynamic account creation.

string
required

Customer last name for dynamic account creation.

boolean
required

Must be true for dynamic account creation.

string
enum
required

The currency for the virtual account.

Allowed:
string
enum
required

The account type.

Allowed:
string

Optional customer reference.

string
enum
Defaults to FCAT

Dynamic accounts currently support the FCAT service only.

Allowed:
Responses

409

A conflicting virtual-account creation is already in progress or exists.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json