Skip to main content
GET
/
v1
/
transfers
List Transfers
curl --request GET \
  --url https://plugin-br-bank-transfer.sandbox.lerian.net/v1/transfers \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Organization-Id: <x-organization-id>'
{
  "items": [
    {
      "transferId": "019c96a0-ab10-7cde-f1a2-0e1f2a3b4c5d",
      "type": "TED_OUT",
      "status": "COMPLETED",
      "amount": 1000.5,
      "feeAmount": 1.5,
      "totalAmount": 1002,
      "createdAt": "2026-02-01T15:30:00-03:00",
      "updatedAt": "2026-02-01T15:35:00-03:00"
    },
    {
      "transferId": "019c96a0-ab20-7def-a1b2-1f2a3b4c5d6e",
      "type": "TED_IN",
      "status": "COMPLETED",
      "amount": 500,
      "feeAmount": 0,
      "totalAmount": 500,
      "createdAt": "2026-02-01T16:00:00-03:00",
      "updatedAt": "2026-02-01T16:05:00-03:00"
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "returned": 2,
    "totalCount": 2,
    "hasNextPage": false
  }
}

Authorizations

​
Authorization
string
header
required

JWT Bearer token authentication. The tenantId is derived from the bearer token or authenticated request context and is not supplied through X-Organization-Id.

Headers

​
X-Organization-Id
string<uuid>
required

Midaz organization scope for the request, used for downstream CRM, Fees, and Midaz calls. Required on org-scoped transfer routes in every deployment mode; a missing or non-UUID value returns 400. This is not the tenant identifier — tenantId is derived from the bearer JWT or authenticated context, never from this header. Background workers (TED IN poller, reconciliation) have no request header and, in single-tenant mode, fall back to the deployment's ORGANIZATION_ID env.

Query Parameters

​
type
enum<string>

Filter results by transfer type. The type of transfer. TED_OUT is an outgoing transfer to an external bank via JD SPB. TED_IN is an incoming transfer from an external bank. P2P is a peer-to-peer transfer within the same institution (same ISPB).

Available options:
TED_OUT,
TED_IN,
P2P
Example:

"TED_OUT"

​
status
enum<string>

Filter results by transfer status. The current status of the transfer. For TED OUT: CREATED → PENDING → PROCESSING → COMPLETED, REJECTED, or FAILED. For P2P: CREATED → PROCESSING → COMPLETED or FAILED (PENDING is an SPB-specific state and does not apply to P2P). Transfers can be CANCELLED while in CREATED or PENDING status. For TED IN: RECEIVED → PROCESSING → COMPLETED or FAILED. A COMPLETED TED IN can also transition to FAILED in the event of a chargeback.

Available options:
CREATED,
PENDING,
PROCESSING,
COMPLETED,
REJECTED,
FAILED,
CANCELLED,
RECEIVED
Example:

"COMPLETED"

​
createdFrom
string<date-time>

The start of the date range filter in RFC3339 format.

​
createdTo
string<date-time>

The end of the date range filter in RFC3339 format.

​
minAmount
number<decimal>

The minimum transfer amount to include in the results. Must be 0 or greater.

Required range: x >= 0
​
maxAmount
number<decimal>

The maximum transfer amount to include in the results. This filter has no upper bound.

Required range: x >= 0
​
limit
integer
default:50

Maximum number of transfers to return.

Required range: 1 <= x <= 200
​
offset
integer
default:0

Number of transfers to skip.

Required range: x >= 0
​
sortDirection
enum<string>
default:desc

Sort direction for results ordered by createdAt.

Available options:
asc,
desc

Response

Indicates that the request was successful and the matching transfers are returned.

​
items
object[]
required
​
pagination
object
required