Skip to main content
GET
/
v1
/
transfers
/
{transferId}
Get a Transfer
curl --request GET \
  --url https://plugin-br-bank-transfer.sandbox.lerian.net/v1/transfers/{transferId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Tenant-Id: <x-tenant-id>'
{
  "transferId": "019c96a0-ab10-7cde-f1a2-0e1f2a3b4c5d",
  "type": "TED_OUT",
  "status": "COMPLETED",
  "senderAccountId": "019c96a0-0c0c-7221-8cf3-13313fb60081",
  "recipient": {
    "ispb": "00000000",
    "branch": "0001",
    "account": "1234567890",
    "accountType": "CACC",
    "holderName": "Maria Santos",
    "holderDocument": "98765432100"
  },
  "amount": 1000.5,
  "feeAmount": 1.5,
  "totalAmount": 1002,
  "confirmationNumber": "20260201001",
  "controlNumber": "202602010001",
  "createdAt": "2026-02-01T15:30:00-03:00",
  "updatedAt": "2026-02-01T15:35:00-03:00",
  "completedAt": "2026-02-01T15:35:00-03:00",
  "statusHistory": [
    {
      "status": "CREATED",
      "timestamp": "2026-02-01T15:30:00-03:00",
      "reason": null
    },
    {
      "status": "PENDING",
      "timestamp": "2026-02-01T15:30:05-03:00",
      "reason": null
    },
    {
      "status": "PROCESSING",
      "timestamp": "2026-02-01T15:30:10-03:00",
      "reason": null
    },
    {
      "status": "COMPLETED",
      "timestamp": "2026-02-01T15:35:00-03:00",
      "reason": null
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
X-Tenant-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.

Path Parameters

​
transferId
string<uuid>
required

The unique identifier of the transfer.

Response

Indicates that the transfer was found and its details are returned.

​
transferId
string<uuid>
required

The unique identifier of the transfer.

Example:

"019c96a0-ab10-7cde-f1a2-0e1f2a3b4c5d"

​
type
enum<string>
required

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>
required

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"

​
senderAccountId
string<uuid> | null
required

UUID of the sender account. May be null for TED_IN transfers where the sender is external.

​
recipient
object
required
​
amount
number<decimal>
required

The transfer amount without the fee.

Example:

1000.5

​
feeAmount
number<decimal>
required

The fee charged for this transfer.

Example:

1.5

​
totalAmount
number<decimal>
required

The total amount, calculated as the transfer amount plus the fee.

Example:

1002

​
createdAt
string<date-time>
required

The timestamp when the transfer was created.

Example:

"2026-02-01T15:30:00-03:00"

​
updatedAt
string<date-time>
required

The timestamp of the last status update.

Example:

"2026-02-01T15:35:00-03:00"

​
statusHistory
object[]
required

The history of status transitions for this transfer.

​
confirmationNumber
string | null

The human-readable confirmation code, if available.

Maximum string length: 20
Example:

"20260201001"

​
controlNumber
string | null

The JD SPB control number, present for TED OUT and TED IN transfers.

Maximum string length: 20
Example:

"202602010001"

​
midazTransactionId
string<uuid> | null

The corresponding Midaz ledger transaction ID.

Example:

"019c96a0-ac10-7efa-b1c2-2a3b4c5d6e7f"

​
description
string | null

The purpose or description of the transfer.

Maximum string length: 140
Example:

"Payment for services"

​
metadata
object

Custom metadata as key-value pairs.

​
completedAt
string<date-time> | null

The timestamp when the transfer was completed. Null if not yet completed.

Example:

"2026-02-01T15:35:00-03:00"