List transfers

Lists transfers for the authenticated tenant with cursor-based pagination. Optional filters: state, direction, sourceProduct.

GET /v1/transfers

List transfers

cURL

curl --request GET \
  --url https://sta.sandbox.lerian.net/v1/transfers \
  --header 'Authorization: Bearer <token>'

200

{
  "hasMore": true,
  "items": [
    {
      "bytesDownloaded": 123,
      "bytesUploaded": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "credentialId": "<string>",
      "currentState": "<string>",
      "currentStateCode": 123,
      "direction": "<string>",
      "documentType": "<string>",
      "downloadAttempts": 123,
      "expired": true,
      "fileName": "<string>",
      "fileSizeBytes": 123,
      "hashMismatchAttempts": 123,
      "id": "<string>",
      "secondsRemaining": 123,
      "transmissionAttempts": 123,
      "updatedAt": "2023-11-07T05:31:56Z",
      "uploadAttempts": 123,
      "errorCode": "<string>",
      "expiresAt": "2023-11-07T05:31:56Z",
      "fileRef": "<string>",
      "lastTransitError": "<string>",
      "protocolGeneratedAt": "2023-11-07T05:31:56Z",
      "protocolNumber": "<string>",
      "sourceProduct": "<string>",
      "urgentRequestedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pageSize": 123,
  "nextCursor": "<string>"
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Query Parameters

state · string

Filter by state name

Example:

"AwaitingUpload"

direction · string

Filter by direction: outbound | inbound

Example:

"outbound"

sourceProduct · string

Filter by source product

Example:

"pix"

cursor · string

Opaque continuation cursor from a prior page

pageSize · integer<int64>

Requested page size; clamped to 1..100 by the query service (default 20)

Example:

20

Response

200

application/json

OK

hasMore · boolean · required

items · object[] | null · required

Show child attributes

pageSize · integer<int64> · required

nextCursor · string