Create a transfer

POST {{baseUrl}}/v1/transfers

A transfer can be made from an existing funded wallet to another wallet. This transfer is internal-only, this call cannot be used for on-chain transfers.

Body Params

idempotencyKey string (REQUIRED)
Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.

source object (REQUIRED)

• type string (REQUIRED)
• id string (REQUIRED)
  The id of the wallet.
• identities array

destination (REQUIRED)
Option 1

• type string (REQUIRED)
• address string (REQUIRED)
  The blockchain address.
• addressTag string
  The secondary identifier for a blockchain address. An example of this is the memo field on the Stellar network, which can be text, id, or hash format.
• chain string (REQUIRED)
  A blockchain that a given currency is available on.

Option 2

• type string (REQUIRED)
• id string (REQUIRED)
  The id of the wallet.

amount object (REQUIRED)

• amount string (REQUIRED)
  Magnitude of the amount, in units of the currency, with a ..
• currency string (REQUIRED)
  Currency code for the amount.

Request Body

{"idempotencyKey"=>"{{$guid}}", "source"=>{"type"=>"wallet", "id"=>"12345"}, "destination"=>{"type"=>"wallet", "address"=>"54321"}, "amount"=>{"amount"=>"3.14", "currency"=>"USD"}}

HEADERS

RESPONSES

status: Created

{"data":{"id":"06e24b32-e23a-4572-85c5-a275887fce60","source":{"type":"wallet","id":"1000594146"},"destination":{"type":"wallet","id":"1001429912"},"amount":{"amount":"3.14","currency":"USD"},"status":"pending","createDate":"2024-01-17T17:52:22.185Z"}}