Create New Wallet (Atlas)
Overview
The POST /banking/ibans/v2/{companyId}/wallets endpoint provisions a new currency wallet for a company or managed sub-company.
You can specify the 3-letter ISO currency code, the wallet category (standard or fx_balance), and an optional custom reference label for internal accounting categorization.
Resource Access
- HTTP Method:
POST - Endpoint:
/banking/ibans/v2/{companyId}/wallets - Authentication: Bearer token required
- Permissions:
Client:EWallets:write,Admin:Wallets:write,Client:Add Wallets:write,Client:Add Funds:write
Path Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
companyId | string | Yes | Target company identifier. | 3046 |
Request Headers
| Header | Value | Required | Description |
|---|---|---|---|
Authorization | Bearer {access_token} | Yes | JWT Bearer access token |
Content-Type | application/json | Yes | Request payload format |
Accept | application/json | Yes | Response payload format |
Request Body
Request Fields
| Field | Type | Required | Description |
|---|---|---|---|
currency | string | Yes | 3-letter ISO 4217 currency code (e.g. USD, EUR, GBP, CAD, AED). |
type | string | Yes | Wallet type: standard (operating balance) or fx_balance (FX trade reserve). |
customReferenceLabel | string | No | Descriptive label for internal tracking (max 75 characters, e.g. ESCROW_Q4). |
Request Example
{
"currency": "EUR",
"type": "standard",
"customReferenceLabel": "EU_PAYROLL_WALLET"
}
Response
Success Response (201 Created)
{
"id": 14920,
"totalBalance": 0,
"availableBalance": 0,
"currency": "EUR",
"type": "standard",
"companyId": 3046,
"customReferenceLabel": "EU_PAYROLL_WALLET",
"isDefault": false,
"isDisabled": false,
"isBillingWallet": false,
"fundingType": "smartWallet",
"isSplitPaymentEnabled": false,
"splitPaymentLimit": 0,
"splitPaymentMessage": null
}
Code Examples
cURL
curl -X POST "https://api.ahrvo.network/banking/ibans/v2/3046/wallets" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"currency": "EUR",
"type": "standard",
"customReferenceLabel": "EU_PAYROLL_WALLET"
}'
JavaScript (Fetch)
const companyId = '3046';
const response = await fetch(`https://api.ahrvo.network/${companyId}/wallets`, {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
'Content-Type': 'application/json'
},
body: JSON.stringify({
currency: 'EUR',
type: 'standard',
customReferenceLabel: 'EU_PAYROLL_WALLET'
})
});
const newWallet = await response.json();
console.log('Created Wallet ID:', newWallet.id, 'Currency:', newWallet.currency);
Python (requests)
import requests
company_id = "3046"
url = f"https://api.ahrvo.network/banking/ibans/v2/{company_id}/wallets"
headers = {
"Authorization": "Bearer YOUR_ACCESS_TOKEN",
"Content-Type": "application/json"
}
payload = {
"currency": "EUR",
"type": "standard",
"customReferenceLabel": "EU_PAYROLL_WALLET"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
Interactive API Console
Test the endpoint directly in your browser: