Request a virtual account | Redpin

This will initiate the process of creating a virtual account for the customer.

Using the Response: The response includes a unique_identifier that you can use to retrieve the virtual account details. After creating a virtual account, use the unique_identifier from the response with the unique-ref query parameter in the View a virtual account endpoint to get the complete virtual account details.

Example:

$ # Step 1: Create virtual account
$ POST /v1/customers/{customer_id}/virtual-accounts
$ Request Body:
$ {
>   "currency": "EUR",
>   "vban_country": "USA"
> }
$ Response: { "unique_identifier": "6d23072a-ac3e-4146-9b83-7ad384d65707" }
$ 
$ # Step 2: Get virtual account details using unique_identifier
$ GET /v1/customers/{customer_id}/virtual-accounts?unique-ref=6d23072a-ac3e-4146-9b83-7ad384d65707

Authentication: Bearer token required

Virtual accounts are unique, bank routing instructions which are assigned to an individual customer (can be a personal customer or a business customer). Virtual Accounts will be available in a number of currencies. Please contact your Account Manager or Implementation Manager for more information. Virtual accounts can be requested for registered and active customers. This will initiate the process of creating a virtual account for the customer. **Using the Response:** The response includes a `unique_identifier` that you can use to retrieve the virtual account details. After creating a virtual account, use the `unique_identifier` from the response with the `unique-ref` query parameter in the [View a virtual account](/api-reference/customers/api-integration/virtual-accounts/get-virtual-account-by-vban#request.query.unique-ref) endpoint to get the complete virtual account details. **Example:** ```bash # Step 1: Create virtual account POST /v1/customers/{customer_id}/virtual-accounts Request Body: { "currency": "EUR", "vban_country": "USA" } Response: { "unique_identifier": "6d23072a-ac3e-4146-9b83-7ad384d65707" } # Step 2: Get virtual account details using unique_identifier GET /v1/customers/{customer_id}/virtual-accounts?unique-ref=6d23072a-ac3e-4146-9b83-7ad384d65707 ``` **Authentication:** [Bearer token required](/api-guide/getting-started/authentication#oauth-20-authentication)

Authentication

AuthorizationBearer

OAuth 2.0 Bearer token authentication. This API uses OAuth 2.0 Client Credentials flow. Please refer to the Authentication section for detailed information on how to obtain and use your OAuth credentials.

Path parameters

customer_idstringRequired

Unique Customer Identifier

Request

This endpoint expects an object.

currencystringRequired=3 characters

Three-letter currency code as per ISO 4217.

vban_countrystringOptional=3 characters

Three-letter country code as per ISO 3166-1 alpha-3. Mandatory for EUR & GBP virtual accounts.

Response

Ok. A virtual account creation process has been initiated.

unique_identifierstring

Unique identifier to identify this virtual account in future. Use this identifier with the unique-ref query parameter in the View a virtual account endpoint to retrieve the complete virtual account details including account number, bank details, and status.

Usage Example:

$ GET /v1/customers/{customer_id}/virtual-accounts?unique-ref={unique_identifier}

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error

This will initiate the process of creating a virtual account for the customer.

Example:

$ # Step 1: Create virtual account
$ POST /v1/customers/{customer_id}/virtual-accounts
$ Request Body:
$ {
>   "currency": "EUR",
>   "vban_country": "USA"
> }
$ Response: { "unique_identifier": "6d23072a-ac3e-4146-9b83-7ad384d65707" }
$ 
$ # Step 2: Get virtual account details using unique_identifier
$ GET /v1/customers/{customer_id}/virtual-accounts?unique-ref=6d23072a-ac3e-4146-9b83-7ad384d65707

Authentication: Bearer token required

1	curl -X POST https://sandbox.currenciesdirect.com/v1/customers/cust_123456789/virtual-accounts \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"currency": "EUR",
6	"vban_country": "USA"
7	}'

$	# Step 1: Create virtual account
$	POST /v1/customers/{customer_id}/virtual-accounts
$	Request Body:
$	{
>	"currency": "EUR",
>	"vban_country": "USA"
>	}
$	Response: { "unique_identifier": "6d23072a-ac3e-4146-9b83-7ad384d65707" }
$
$	# Step 2: Get virtual account details using unique_identifier
$	GET /v1/customers/{customer_id}/virtual-accounts?unique-ref=6d23072a-ac3e-4146-9b83-7ad384d65707