Get transfer details by uid

๐Ÿšง

Important:

Request headers are required. See API basics introduction for more information.

Get transfer details by uid

Endpoint

GET /transfer/{uid}

Returns the transfer details for a given uid associated with the given App (set by the X-API-KEY).

Parameters

Path parameters

Path parameterDescription
uidThe unique identifier of the Transfer for this app (ex. 213134081289).

Response

You will receive the transfer details including the following fields:

Response fieldsTypeDescriptionCondition
uidStringThe UID of the transfer.Mandatory
statusStringThe status of the transfer (pending | done | cancelled).Mandatory
asset_uidStringThe UID of the asset transferred.Mandatory
from_user_uidStringThe UID of the user who is transferring the asset.Mandatory
to_addressStringThe recipient's wallet address.Mandatory
created_atString
(Timestamp)
The timestamp of the transfer creation.Mandatory

Response example

{
  "success": true,
  "data": {
    "uid": "213134081289",
    "status": "Pending",
    "asset_uid": "112144981245",
    "from_app_user_uid": "223144788242",
    "to_address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "created_at": "2023-08-10T14:07:14.494142Z",
  }
}

Example

The following example gets the transfer details for transfer 333333333333.

# API_KEY is your api key
# TOKEN is the access token generated with your api key secret

curl -i \
  -X GET \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: API_KEY" \
  -H "Authorization: Bearer TOKEN" \
  "https://api.getoriginal.com/v1/transfer/333333333333"