1. Open Balance (V3)
POST {{host}}/v3/profiles/{{profile-id}}/balances
Opens a balance for the specified profile and currency. If the balance already exists, return the existing one.
Request Body
| Field | Description | Format | Required |
|---|---|---|---|
| currency | balance currency (ISO 4217 Alphabetic Code) | text | true |
| type | use STANDARD | text | true |
| name | balance name | text | false |
Response Body
| Field | Description | Format |
|---|---|---|
| id | balance id | integer |
| currency | balance currency (ISO 4217 Alphabetic Code) | text |
| type | balance type (standard, savings) | text |
| name | balance name | text |
| icon | emoji string | text |
| amount.value | Available balance value that can be used to fund transfers | decimal |
| amount.currency | balance currency (ISO 4217 Alphabetic Code) | text |
| reservedAmount.value | IGNORE | |
| reservedAmount.currency | IGNORE | |
| creationTime | date when balance was created | timestamp |
| modificationTime | date when balance was last modified | timestamp |
| visible | if balance is visible for the user or not | boolean |
Request Body
{"currency"=>"EUR", "type"=>"STANDARD"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string | Your access token | |
Content-Type | string | ||
X-idempotence-uuid | string | Unique identifier assigned by you. Used for idempotency check purposes. Should your call fail for technical reasons then you can use the same value again for making a retry call. |
RESPONSES
status: Created
{"id":1,"currency":"EUR","type":"STANDARD","name":null,"icon":null,"amount":{"value":0,"currency":"EUR"},"reservedAmount":{"value":0,"currency":"EUR"},"creationTime":"2019-05-05T10:22:49.487533Z","modificationTime":"2021-06-14T11:10:41.055317Z","visible":true}