List outgoing/internal transfers (cursor pagination)

curl --request GET \
  --url https://api.example.com/v1/transfers \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/transfers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/v1/transfers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "items": [
    {
      "amount": "1500.00",
      "clientReference": "PED-2026-000123",
      "createdAt": "2026-10-22T13:05:12Z",
      "description": "Supplier payment",
      "feeAmount": "3.25",
      "metadata": {
        "channel": "mobile",
        "orderId": "PED-2026-000123"
      },
      "numCtrlStr": "STR20261022000000123",
      "nuop": "87654321202610220000123",
      "purposeCode": "00010",
      "railOperationId": "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
      "recipient": {
        "agency": "1234",
        "bankAccount": "0001234567",
        "bankAccountType": "CACC",
        "bankCode": "001",
        "bankId": "87654321",
        "document": "12345678901",
        "name": "Maria da Silva"
      },
      "reservedAt": "2026-10-22T13:05:13Z",
      "sender": {
        "accountId": "0a2f4c6e-8b1d-4e3f-9a5b-7c9d1e3f5a7b",
        "agency": "0001",
        "bankAccount": "0001111222",
        "bankAccountType": "CACC",
        "bankId": "12345678",
        "document": "98765432100",
        "name": "João Pereira"
      },
      "settledAt": "2026-10-22T13:05:41Z",
      "status": "SETTLED",
      "submittedAt": "2026-10-22T13:05:14Z",
      "totalAmount": "1503.25",
      "transferId": "6f1c2b3a-4d5e-4f60-8a9b-0c1d2e3f4a5b",
      "type": "TED",
      "updatedAt": "2026-10-22T13:05:41Z"
    }
  ],
  "limit": 20,
  "next_cursor": "eyJzYyI6ImNyZWF0ZWRfYXQiLCJzdiI6IjIwMjYtMTAtMjJUMTM6MDU6MTJaIiwiaSI6IjZmMWMuLi4iLCJwbiI6MX0",
  "prev_cursor": null
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

List outgoing/internal transfers (cursor pagination)

Lists the outgoing (TED) and internal transfers of the institution, newest first by default, with cursor pagination.

Filters: creation period (start_date/end_date, YYYY-MM-DD), status, type (TED or INTERNAL), source account (account_id), and the requester reference (client_reference) you sent when you created the transfer. Use it to find the transfer for one of your orders. Combine sort_order=asc with start_date to reprocess a period in chronological order.

Each item has the same shape as GET /v1/transfers/{transferId}, except returned (returns received), which only appears in the single-transfer query. Follow next_cursor until it is null. This list also gives prev_cursor.

To track a specific transfer, use the single-transfer query or the events. Use the list for screens, statements, and reconciliation on your side.

GET

transfers

List outgoing/internal transfers (cursor pagination)

curl --request GET \
  --url https://api.example.com/v1/transfers \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/transfers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/v1/transfers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "items": [
    {
      "amount": "1500.00",
      "clientReference": "PED-2026-000123",
      "createdAt": "2026-10-22T13:05:12Z",
      "description": "Supplier payment",
      "feeAmount": "3.25",
      "metadata": {
        "channel": "mobile",
        "orderId": "PED-2026-000123"
      },
      "numCtrlStr": "STR20261022000000123",
      "nuop": "87654321202610220000123",
      "purposeCode": "00010",
      "railOperationId": "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
      "recipient": {
        "agency": "1234",
        "bankAccount": "0001234567",
        "bankAccountType": "CACC",
        "bankCode": "001",
        "bankId": "87654321",
        "document": "12345678901",
        "name": "Maria da Silva"
      },
      "reservedAt": "2026-10-22T13:05:13Z",
      "sender": {
        "accountId": "0a2f4c6e-8b1d-4e3f-9a5b-7c9d1e3f5a7b",
        "agency": "0001",
        "bankAccount": "0001111222",
        "bankAccountType": "CACC",
        "bankId": "12345678",
        "document": "98765432100",
        "name": "João Pereira"
      },
      "settledAt": "2026-10-22T13:05:41Z",
      "status": "SETTLED",
      "submittedAt": "2026-10-22T13:05:14Z",
      "totalAmount": "1503.25",
      "transferId": "6f1c2b3a-4d5e-4f60-8a9b-0c1d2e3f4a5b",
      "type": "TED",
      "updatedAt": "2026-10-22T13:05:41Z"
    }
  ],
  "limit": 20,
  "next_cursor": "eyJzYyI6ImNyZWF0ZWRfYXQiLCJzdiI6IjIwMjYtMTAtMjJUMTM6MDU6MTJaIiwiaSI6IjZmMWMuLi4iLCJwbiI6MX0",
  "prev_cursor": null
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Authorizations

Authorization

string

header

required

JWT token that the Lerian Access Manager issues for your institution. Send it in Authorization: Bearer <token> on every call (except the public health probes). The tenant never comes from the body, the query, or the path. Each operation requires a role with the matching permission (see the API overview). Without it, 403 TED-0071. Missing, invalid, or expired token: 401 TED-0070.

Headers

X-Request-Id

string<uuid>

Correlation identifier of this request (UUID). Optional: when you omit it, or when the value is not a well-formed UUID, the platform creates a UUID and returns it in the X-Request-Id header of the response. The resolved identifier goes to the logs, spans, and audit events of this request. Keep it to open a support ticket.

Query Parameters

limit

integer<int64>

default:20

Maximum items per page

Required range: 1 <= x <= 100

cursor

string

Opaque cursor returned in next_cursor/prev_cursor

Maximum string length: 512

sort_order

enum<string>

default:desc

Order by creation date: desc (newest first, default) or asc.

Available options:

asc,

desc

start_date

string

Created on or after (YYYY-MM-DD)

end_date

string

Created on or before (YYYY-MM-DD)

status

enum<string>

Filters by current state.

Available options:

CREATED,

RESERVED,

SUBMITTED,

PENDING_STR,

SETTLED,

REJECTED,

CANCELLED,

AWAITING_RECONCILIATION,

EXHAUSTED

type

enum<string>

Filters by path: TED (another institution) or INTERNAL (your own institution).

Available options:

TED,

INTERNAL

account_id

string<uuid>

Source account (UUID)

client_reference

string

Filters by the requester reference sent when the transfer was created (clientReference).

Maximum string length: 64

Response

Page of transfers. Follow next_cursor until it is null.

Page of transfers with cursor pagination. Follow next_cursor until it is null.

items

object[]

required

Transfers on the page.

Show child attributes

limit

integer<int64>

required

Actual page size, already capped at the contract maximum — not necessarily the requested value.

next_cursor

string | null

required

Token of the next page; null when there is none.

prev_cursor

string | null

required

Token of the previous page; null when there is none.

Overview

Transfers API

Incoming Transfers API

Reconciliation API

Operations API

Policy API

Participants API

Error handling

List outgoing/internal transfers (cursor pagination)

Authorizations

Headers

Query Parameters

Response