Assets API
Use the Assets API to manage the Assets that will be used with the Ledgers.
Last updated
Use the Assets API to manage the Assets that will be used with the Ledgers.
Last updated
Refer to Assets API in the Requests and Responses page for more information about the parameters.
POST
/v1/organizations/{{id}}/ledgers/{{id}}/assets
Use this endpoint to create an Asset that will be used with the transactions. Each Asset must be created one at a time.
Each Asset has decimal place settings and other specific parameters that will be created individually.
You must create the Asset twice with different configurations to use the same Asset (e.g. BTC) on two Ledgers with different configurations.
Headers
Name | Value |
---|---|
Response codes
GET
/v1/organizations/{{id}}/ledgers/{{id}}/assets?type={{type}}
Use this endpoint to retrieve the information of all Asset to which a user has access.
Headers
Query parameters
Response codes
GET
/v1/organizations/{{id}}/ledgers/{{id}}/assets/{{id}}
Use this endpoint to retrieve the information of a specific Asset using the identifier (id
).
Headers
Response codes
PATCH
/v1/organizations/{{id}}/ledgers/{{id}}/assets/{{id}}
Use this endpoint to edit and update the information of a specific Asset. When you update an Asset, the following fields can be edited:
name
status
metadata
When updating the metadata
object, all previous key-value pairs must be included in the update, or they will be removed.
Headers
Response codes
DELETE
/v1/organizations/{{id}}/ledgers/{{id}}/assets/{{id}}
Use this endpoint to deactivate a specific Asset.
An Asset can only be deleted if no balance is available in its ledger accounts. Therefore, all remaining amounts must be moved to the External Account before deleting an Asset.
Headers
Response codes
Name | Value |
---|---|
Name | Type | Description |
---|---|---|
Name | Value |
---|---|
Name | Value |
---|---|
Name | Value |
---|---|
Content-Type
application/json
Authorization
Bearer <token>
Authorization
Bearer <token>
type
String
The type of Asset.
code
String
The code that represent the Asset.
status
Array
An object containing information about the status.
metadata
Array
An object containing metadata information.
Authorization
Bearer <token>
Content-Type
application/json
Authorization
Bearer <token>
Content-Type
application/json
Authorization
Bearer <token>