Get asset transfer by ID

GET 
/asset-transfers/:id

Retrieve a specific asset transfer by its ID

Request

Path Parameters

id uuidrequired

Asset transfer ID

Responses

200

Asset transfer retrieved successfully

application/json

Schema

Schema

iduuid
statusstring

Current status of the transfer

Possible values: [PENDING, CANCELLED, SETTLED]

unitCountstring
Number of units being transferred
Example: 1.0
unitCountExpectedstring
Expected number of units to transfer
Example: 1.0
hotTransferboolean

Whether this is a hot wallet transfer

settlementDetailsstring

Possible values: <= 255 characters

transactionHashstring

Blockchain transaction hash

Possible values: <= 255 characters

cancelledAtdate-timenullable
createdAtdate-time
contingenciesClearedAtdate-timenullable
contingenciesClearedOnstringnullable

Possible values: <= 10 characters

reconciledAtdate-timenullable
assetTransferMethodIduuid

ID of the transfer method used

accountIduuid

ID of the account being charged

assetIduuid

ID of the asset being transferred

assetContributionIduuidnullable

ID of the associated contribution

assetDisbursementIduuidnullable

ID of the associated disbursement

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "PENDING",
  "unitCount": "1.0",
  "unitCountExpected": "1.0",
  "hotTransfer": true,
  "settlementDetails": "string",
  "transactionHash": "string",
  "cancelledAt": "2024-07-29T15:51:28.071Z",
  "createdAt": "2024-07-29T15:51:28.071Z",
  "contingenciesClearedAt": "2024-07-29T15:51:28.071Z",
  "contingenciesClearedOn": "string",
  "reconciledAt": "2024-07-29T15:51:28.071Z",
  "assetTransferMethodId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "assetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "assetContributionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "assetDisbursementId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

400

Bad Request - Invalid input data

application/json

Schema

Schema

messagestringrequired

Error message

descriptionstring

Detailed error description

codestring

Error code

Example (from schema)

{
  "message": "Invalid input data",
  "description": "The request data did not pass validation",
  "code": "INVALID_INPUT"
}

401

Unauthorized - Invalid or missing authentication token

application/json

Schema

Schema

messagestringrequired

Error message

descriptionstring

Detailed error description

codestring

Error code

Example (from schema)

{
  "message": "Unauthorized",
  "description": "Invalid, expired or missing bearer token",
  "code": "UNAUTHORIZED"
}

403

Forbidden - Insufficient permissions

application/json

Schema

Schema

messagestringrequired

Error message

descriptionstring

Detailed error description

codestring

Error code

Example (from schema)

{
  "message": "Forbidden",
  "description": "You don't have permission to access this resource",
  "code": "FORBIDDEN"
}

404

Not Found - Resource not found

application/json

Schema

Schema

messagestringrequired

Error message

descriptionstring

Detailed error description

codestring

Error code

Example (from schema)

{
  "message": "Resource not found",
  "description": "The requested resource could not be found",
  "code": "NOT_FOUND"
}

409

Conflict - Resource already exists or state conflict

application/json

Schema

Schema

messagestringrequired

Error message

descriptionstring

Detailed error description

codestring

Error code

Example (from schema)

{
  "message": "Resource conflict",
  "description": "The resource already exists or is in an invalid state",
  "code": "CONFLICT"
}

422

Unprocessable Entity - Validation error

application/json

Schema

Schema

messagestringrequired

Error message

descriptionstring

Detailed error description

codestring

Error code

Example (from schema)

{
  "message": "Validation error",
  "description": "The request data failed validation rules",
  "code": "VALIDATION_ERROR"
}