AM/FA/Inv - Get Transfer Details

Details

/external/v1/transfer

Synopsis

Get Transfer Details

get

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".

Required scopes

This endpoint requires the following scopes:

• : readTransfer

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Query parameters

pageSizenumberOptional

The number of rows being retrieved. Must be a positive integer.

offsetnumberOptional

The offset (i.e. row start index). Must be a positive integer (or 0).

transferStatusFilterstringOptional

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

Example: created,canceled

securityIdsFilterstringOptional

The 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.

Example: USCCWSF01I00,USCCWSF01I01

securityCorrelationIdsFilterstringOptional

The 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.

Example: 1234,5678,7890

transferIdsFilterstringOptional

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.

Example: USCCWSF01I00,USCCWSF01I01

transferCorrelationIdsFilterstringOptional

The 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.

Example: 1234,5678,7890

securityCorrelationOrgIdstring · max: 12Optional

The 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.

transferCorrelationOrgIdstring · max: 12Optional

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.

Responses

200

Successfully retrieved the Transfer details

application/json

400

The following error codes can be returned: - GN0002 - GN0004 - GN0005 Please refer to the error code dictionary for the details of each error code.

application/json

401

The following error codes can be returned: - AU0001 Please refer to the error code dictionary for the details of each error code.

application/json

403

The following error codes can be returned: - AU0002 Please refer to the error code dictionary for the details of each error code.

application/json

get

/external/v1/transfer

HTTPcURLJavaScriptPython

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"
    }
  }
]