Step 2: Creating a Customer Wallet and Virtual Account
This endpoint allows you to create a wallet for a specific customer, generating a unique virtual account tied to the specific wallet. This virtual account serves as a tool for managing funds, and streamlining payment flows between your business, your customer, and their end-customers.
Early Access
Please note that this endpoint is currently in early access, and it may undergo changes as we continue to improve and refine the functionality.
Idempotency supported endpoint
This means you can retry a request without worrying about it being processed multiple times.
To use this feature, add the
X-Idempotency-Keyheader with a unique value (a UUID). This ensures the request is only processed once, even if it's sent multiple times.
Assigning a wallet profile
First, list the possible Wallet Profiles to retrieve the Profile reference for your Customer wallet. Assign the Profile based on the currency and payment method of your wallet.
| Environment | Endpoint |
|---|---|
| Production | GET https://api.bvnk.com/ledger/v1/wallets/profiles |
| Sandbox | GET https://api.sandbox.bvnk.com/ledger/v1/wallets/profiles |
| Query Parameters | Values |
|---|---|
currencyCodes | USDEURGBP |
paymentMethods | ACHFEDWIRESWIFTFASTER_PAYMENTSEPA_CTSEPA_INST |
{
"profiles": [
{
"reference": "bd72bff2-6842-4212-9aa3-9298597d7d6e",
"currencyCodes": [
"GBP"
],
"paymentMethods": [
"FASTER_PAYMENT"
]
},
{
"reference": "c143fce7-a0e4-4475-86cd-ed37bc30efa5",
"currencyCodes": [
"EUR"
],
"paymentMethods": [
"SWIFT"
]
},
{
"reference": "18f9a1bf-0d77-45f5-b5ff-1e90411d88ce",
"currencyCodes": [
"USD"
],
"paymentMethods": [
"SWIFT"
]
},
{
"reference": "2a3fe604-2b14-4009-90b3-1e48f1a38b11",
"currencyCodes": [
"USD"
],
"paymentMethods": [
"ACH",
"FEDWIRE"
]
},
{
"reference": "fe55d078-eaad-4c8b-a917-15170548df67",
"currencyCodes": [
"EUR"
],
"paymentMethods": [
"SEPA_CT",
"SEPA_INST"
]
}
]
}
Request:
| Environment | Endpoint |
|---|---|
| Production | POST https://api.bvnk.com/ledger/v1/wallets |
| Sandbox | POST https://api.sandbox.bvnk.com/ledger/v1/wallets |
{
"currencyCode": "GBP",
"name": "GBP Wallet",
"customerReference": "2e089f2f-0fd7-4364-9aa7-346650bb14e1",
"instruction": {
"walletProfile": "bd72bff2-6842-4212-9aa3-9298597d7d6e",
"type": "FIAT",
"virtualAccountRequired": true
}
}
The details supplied to the wallet creation request.
| Parameter | Type | Required | Description |
|---|---|---|---|
| currencyCode | String | Yes | The currency code for the wallet. |
| name | String | Yes | The name of the wallet. |
| customerReference | String | Yes | The unique reference to the customer who owns the wallet. |
| instruction | Object | Yes | Contains the information on the wallet type. |
| instruction. type | String | Yes | Type of the wallet. Currently supports FIAT only. |
| instruction. walletProfile | String | No | The profile you would like to assign to the virtual account. |
| instruction. virtualAccountRequired | Boolean | Yes | Indicates whether a virtual account is required. Currently supports true only. |
Response
| Response Code | Description |
|---|---|
| 201 | Wallet created successfully. |
| 400 | Bad request. |
| 403 | Forbidden. |
{
"id": "a:25040756510351:wmtjJG8:1",
"accountReference": "ceb9400d-eee2-4cc0-89dc-1b3548f7291d",
"customerReference": "2e089f2f-0fd7-4364-9aa7-346650bb14e1",
"name": "GBP Wallet 3 via API",
"status": "INACTIVE",
"balance": {
"value": 0,
"currencyCode": "GBP"
},
"ledgers": []
}
Response header: Location: https://api.sandbox.bvnk.com/ledger/v1/wallets/{id}
The id of the created wallet will also be returned in a link via the response header. By default the wallet will have an INACTIVE status and should not be made available to the customer until it has been activated (ACTIVE status). The endpoint provided in the response header should be called periodically, to determine if the wallet has been activated as well as if a virtual account has been created and made available. See here.
Updated 18 days ago