Skip to main content
POST
/
accounts
/
transfers
Create a Transfer
curl --request POST \
  --url https://access.utgl.io/v1/accounts/transfers \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 5000,
  "asset": "USD",
  "sourceAccountId": "090ab04c-2ad2-41c5-beea-9bcc44148789",
  "destinationAccountId": "1c361a1e-4990-44e4-8d50-38f81bf11477",
  "description": "SETTLEMENT FOR PAYMENT \\\\#123",
  "xid": "2bbabfff-9de8-40ff-8bf0-43b97f1f06a9",
  "xmetadata": {
    "group": [
      "123"
    ]
  }
}
'
{
  "id": "05be07d5-62a2-4a4f-951e-381976672719,",
  "asset": "USD,",
  "refId": "WTCXC0VJV0,",
  "amounts": "5000,",
  "sourceAccountId": "090ab04c-2ad2-41c5-beea-9bcc44148789,",
  "destinationAccountId": "1c361a1e-4990-44e4-8d50-38f81bf11477,",
  "description": "SETTLEMENT FOR PAYMENT \\\\\\\\#123,",
  "createdAt": "2024-01-01T16:00:00.000Z,",
  "xid": "2bbabfff-9de8-40ff-8bf0-43b97f1f06a9,",
  "xmetadata": {
    "group": [
      "123"
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
amount
number
required

Amount to be transferred

Example:

1000

​
asset
string
required

Currency or asset symbol of asset to be transferred

Example:

"USD"

​
sourceAccountId
string
required

Source account ID

Example:

"090ab04c-2ad2-41c5-beea-9bcc44148789"

​
destinationAccountId
string
required

Destination account ID

Example:

"1c361a1e-4990-44e4-8d50-38f81bf11477"

​
description
string

An arbitrary transaction description for this transfer. Often useful for displaying to users.

Example:

"SETTLEMENT FOR PAYMENT \\#123"

​
xid
string

External identifier, unique across all resources created under this account.

​
xmetadata
object

External metadata

Example:
{
  "key1": "value1",
  "key2": ["value2.1", "value2.2"]
}

Response

200 - application/json

Transfer Completed

Account transfer

​
id
string
required

Unique identifier for the transfer

Example:

"6c997ca7-8b46-43d2-aee4-dde7669cce6e"

​
amount
number
required

The amount of the transfer

Example:

1000

​
asset
string
required

Asset symbol or currency being transferred

Example:

"USD"

​
description
string
required

Description for the transfer for display purposes, e.g. on statements. The value is provided at the time of transfer creation or generated by the system.

​
sourceAccountId
string
required

The ID of the account the funds are being transferred from

​
destinationAccountId
string
required

The ID of the account the funds are being transferred to

​
createdAt
string<date-time>
required
​
refId
string

Human readable reference identifier for the transfer

​
xid
string

External identifier, unique across all resources created under this account.

​
xmetadata
object

External metadata

Example:
{
  "key1": "value1",
  "key2": ["value2.1", "value2.2"]
}