This route is used to retrieve the history data entries of transfers given a set of filters such as blockchain details or transfer identifiers.
The history entries will reflect the state of the transfers on a particular block on the ledger.
This endpoint returns paginated data. Up to 50 can be extracted 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 block number where the action was recorded on the ledger.
350The transaction id where the action was recorded on the ledger.
456789OIJHGFCVGHJKLKJHGF67JHPattern: ^[a-zA-Z0-9-]*$The name of the channel where the action was recorded on the ledger.
OG123Pattern: ^[a-zA-Z0-9-]*$The 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 "transferCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.
GET /external/v1/transfer/history HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"blockNumber": 350,
"transactionId": "456789OIJHGFCVGHJKLKJHGF67JH",
"channelName": "OG123",
"event": "TransferCreated",
"timestamp": "2024-09-12T00:00:00.000Z",
"update": {
"transferId": "US9QIMAOAS1Q",
"status": "remediation_pending",
"amount": 40.5,
"likeForLike": true,
"transferReason": "gift",
"comments": "Birthday gift",
"securityId": "USCCWSF01I00",
"transferDate": "2023-02-27T22:42:06.620Z",
"recipientAccountId": "US9QIMAOAS1Q",
"sourceAccountId": "US9QIMAOAS1Q",
"fileIds": [
"US9QIFILE1",
"US9QIFILE2"
],
"rejectReason": {
"reason": [
{
"message": "Invalid SSN was provided",
"category": "EC002"
}
]
},
"organization": {
"orgId": "TEST1234",
"name": "Test Organization"
},
"sourceAccountData": {
"orgId": "TEST1234",
"accountId": "TEST67891"
}
},
"signerData": {
"email": "[email protected]",
"name": "John Doe"
},
"organization": {
"name": "Test Organization",
"orgId": "TEST1234"
}
}
]