This route is used to retrieve the details of transfers, given a set of search filters.
This endpoint is paginated, up to 50 records can be retrieved per call.
This endpoint can be called by applications with access to scope "readTransfer".
The number of rows being retrieved. Must be a positive integer.
The offset (i.e. row start index). Must be a positive integer (or 0).
The comma delimited list of statuses to filter the transfer records. Up to 11 entries can be provided. Available values: preSync, created, remediation_pending, remediated, approved_by_issuer, approved_by_sender, assets_remediation_pending, assets_remediated, completed, canceled, deleted
created,canceledThe comma delimited list of security ids to filter the transfer records. Up to 10 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01The comma delimited list of security correlation ids to filter the transfer records. Up to 10 records can be provided. Each record should not exceed 100 characters.
1234,5678,7890The comma delimited list of transfer ids to filter the transfer records. Up to 50 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01The comma delimited list of transfer correlation ids to filter the transfer records. Up to 50 records can be provided. Each record should not exceed 100 characters.
1234,5678,7890The organization identifier linked to the correlation ids provided in the "securityCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.
The organization identifier linked to the correlation ids provided in the "transferCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.
GET /external/v1/transfer HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"transferId": "US9QIMAOAS1Q",
"correlationData": [
{
"correlationId": "123245573717",
"origin": "Identifies transfer on backoffice",
"organization": {
"name": "Test Organization",
"orgId": "TEST1234"
},
"extraData": {
"some": "Custom Property"
}
}
],
"status": "remediated",
"amount": 1000,
"sharesNumber": 1000,
"likeForLike": true,
"transferReason": "gift",
"comments": "Some comment",
"transferDate": "2024-09-12T00:00:00.000Z",
"securityId": "USCCWSF01I00",
"recipientAccountId": "US9QIMAOAS1Q",
"sourceAccountId": "US9QIMAOAS1Q",
"sourceAccountData": {
"orgId": "TEST1234",
"accountId": "TEST67891"
},
"fileIds": [
"US9QIFILE1",
"US9QIFILE2"
],
"rejectReason": {
"reason": [
{
"message": "reject reason",
"category": "EC006",
"documentWithIssues": [
{
"document": {
"fileId": "FILE3JUS03I04"
},
"pages": [
{
"pageNumber": 1,
"description": "The first page has an invalid signature"
}
]
}
]
}
],
"extraData": {
"externalId": "123456789",
"some": "Custom Property"
}
},
"assets": [
{
"inputAssetId": "US9QIMAOAS1Q",
"outputAssetId": "US9QIMAOAS2Q"
}
],
"underlyingRecipientAccountId": "US9QIMAOAC3F",
"underlyingSourceAccountId": "US9QIMAOAC3F",
"organization": {
"orgId": "TEST1234",
"name": "Test Organization"
}
}
]