Accounts API
Use the Account API to create and manage your Accounts.
Create an Account
POST
/v1/organizations/{{id}}/ledgers/{{id}}/portfolios/{{id}}/accounts
Use this endpoint to create an Account or a Child-Account.
To create a Child-Account, you must set the identifier of the Parent Account in the "parentAccountId"
field.
Headers
Name | Value |
---|---|
Content-Type |
|
Authorization |
|
Response codes
Retrieve all Accounts
GET
/v1/organizations/{{id}}/ledgers/{{id}}/portfolio/{{id}}/accounts
Use this endpoint to retrieve the information about all Accounts in the Portfolio.
Headers
Name | Value |
---|---|
Authorization |
|
Query parameters
Name | Type | Description |
---|---|---|
| String | The account type. |
| String | The code of the asset. |
Response codes
Retrieve Account by id
GET
/v1/organizations/{{id}}/ledgers/{{id}}/portfolio/{{id}}/accounts/{{id}}
Use this endpoint to retrieve the information of a specific Account (or child-account).
Headers
Name | Value |
---|---|
Authorization |
|
Response codes
Update an Account
PATCH
/v1/organizations/{{id}}/ledgers/{{id}}/portfolios/{{id}}/accounts/{{id}}
Use this endpoint to edit and update the information of a specific Account. When you update an Account, the following fields can be edited:
name
status
alias
entityId
allowSending
allowReceiving
productId
metadata
When updating the metadata
object, all previous key-value pairs must be included in the update, or they will be removed. Check the Metadata section for more information.
The following account types can be updated: deposit, savings, loans, overdrafts, market place, and credit card.
In the Open Source contracting model, all accounts can be edited
Headers
Name | Value |
---|---|
Content-Type |
|
Authorization |
|
Response codes
Delete an Account
DELETE
/v1/organizations/{{id}}/ledgers/{{id}}/portfolio/{{id}}/accounts/{{id}}
Use this endpoint to deactivate a specific Account.
The following account types can be deactivated: deposit, savings, loans, overdrafts, market place, and credit card.
Headers
Name | Value |
---|---|
Content-Type |
|
Authorization |
|
Response codes
Last updated