Step 2: Creating a Customer Wallet and Virtual Account

This endpoint allows an Embedded Partner to create a wallet for a specific Embedded Partner 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 an Embedded Partner, their Embedded Partner Customer, and their end-customers.

🚧

BETA endpoint

Please note that this endpoint is currently in beta, 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-Key header with a unique value (a UUID). This ensures the request is only processed once, even if it's sent multiple times.

Request:

curl --location 'https://api.sandbox.bvnk.com/ledger/v1/wallets' \
--header 'X-Idempotency-Key: cb26a411-0bf9-4920-a696-25eae38e1e33' \
--header 'Content-Type: application/json' \
--header 'Authorization: Hawk id="vbfc61D890wg6LAAVbkR11qP9O6cXeMNmKWgcUNZaOHPiQeebp9cl6h14sQb42A4", ts="1728655672", nonce="ueLnt4", mac="rehhjPX0HgxvNgGNdwGS8EcIZRH8Y1pj4fClisKmWHE="' \
--data '{
    "currencyCode": "USD",
    "name": "My USD Wallet",
    "customerReference": "a7e21c62-27b8-4b3b-b51e-om46bqag4837",
    "instruction": {
        "type": "FIAT",
        "virtualAccountRequired": true
    }
}'

The details supplied to the wallet creation request.

Response

{
    "id": "a:24101151422432:gCl7SeI:1",
    "accountReference": "ceb9400d-eee2-4cc0-89dc-1b3548f7291d",
    "customerReference": "a7e21c62-27b8-4b3b-b51e-om46bqag4837",
    "name": "My USD Wallet",
    "status": "INACTIVE",
    "balance": {
        "value": 0,
        "currencyCode": "USD"
    },
    "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.