Skip to main content
GET
/
v1
/
transfers
List Transfers
curl --request GET \
  --url https://plugin-br-bank-transfer-jd.sandbox.lerian.net/v1/transfers \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Organization-Id: <x-organization-id>'
{
  "data": [
    {
      "transferId": "019c96a0-ab10-7cde-f1a2-0e1f2a3b4c5d",
      "type": "TED_OUT",
      "status": "COMPLETED",
      "amount": 1000.5,
      "feeAmount": 1.5,
      "recipientHolderName": "Maria Santos",
      "createdAt": "2026-02-01T15:30:00-03:00"
    },
    {
      "transferId": "019c96a0-ab20-7def-a1b2-1f2a3b4c5d6e",
      "type": "TED_IN",
      "status": "COMPLETED",
      "amount": 500,
      "feeAmount": 0,
      "recipientHolderName": "João Silva",
      "createdAt": "2026-02-01T16:00:00-03:00"
    }
  ],
  "pagination": {
    "pageNumber": 1,
    "pageSize": 50,
    "totalCount": 2,
    "totalPages": 1
  }
}

Authorizations

​
Authorization
string
header
required

JWT Bearer token authentication. The token must include a tenantId claim that matches the X-Organization-Id header.

Headers

​
X-Organization-Id
string<uuid>
required

Organization ID used as the tenant identifier. All data is scoped to this organization. Must match the JWT tenantId claim when authentication is enabled.

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 and P2P transfers, the flow is CREATED, PENDING, PROCESSING, and then COMPLETED, REJECTED, or FAILED. Transfers can be CANCELLED while in CREATED or PENDING status. For TED IN transfers, the flow is RECEIVED and then COMPLETED or REJECTED.

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

"COMPLETED"

​
fromDate
string<date-time>

The start of the date range filter in ISO 8601 format.

​
toDate
string<date-time>

The end of the date range filter in ISO 8601 format.

​
minAmount
number<decimal>

The minimum transfer amount to include in the results.

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

The maximum transfer amount to include in the results.

Required range: x <= 999999.99
​
pageNumber
integer
default:1

The page number to retrieve, starting from 1.

Required range: x >= 1
​
pageSize
integer
default:50

The number of items per page.

Required range: 1 <= x <= 100
​
sort
enum<string>
default:createdAt

The field to sort results by.

Available options:
createdAt,
amount,
status
​
order
enum<string>
default:DESC

The sort order for results.

Available options:
ASC,
DESC

Response

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

​
data
object[]
required
​
pagination
object
required