Skip to main content
GET
/
v1
/
transfers
/
{id}
Retrieve a transfer
curl --request GET \
  --url https://api.leanrails.com/v1/transfers/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "tr_xxx",
  "object": "transfer",
  "amount": 123,
  "amount_reversed": 123,
  "currency": "<string>",
  "status": "<string>",
  "transfer_method": "<string>",
  "metadata": {},
  "created": 123,
  "livemode": true,
  "stripe_transfer_id": "<string>",
  "stripe_destination": "<string>",
  "destination_id": "<string>",
  "settlement_batch_id": "<string>",
  "description": "<string>",
  "arrival_date": "<string>",
  "failure_code": "<string>",
  "failure_message": "<string>",
  "reversed_at": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.fluveo.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Use your secret API key as the username with an empty password.

Headers

X-API-Version
string

Override the API version for this request.

Path Parameters

id
string
required

The transfer ID.

Response

The Transfer.

id
string
required
Example:

"tr_xxx"

object
enum<string>
required
Available options:
transfer
amount
integer
required

Transfer amount in smallest currency unit.

amount_reversed
integer
required

Amount that has been reversed.

currency
string
required

Three-letter ISO currency code.

status
string
required

Current transfer status.

transfer_method
string
required

Method used for transfer.

metadata
object
required

Set of key-value pairs for storing additional information.

created
integer
required

Unix timestamp.

livemode
boolean
required
stripe_transfer_id
string | null
stripe_destination
string | null
destination_id
string | null
settlement_batch_id
string | null
description
string | null
arrival_date
string | null

Expected arrival date (YYYY-MM-DD).

failure_code
string | null
failure_message
string | null
reversed_at
integer | null

Unix timestamp when reversed.