For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
    • Home
    • API Basics
  • Products
    • Global Fiat Payouts
    • On-Ramps and Off-Ramps
  • Integration Guides
    • Global payouts integration guide
    • Country-specific details
  • API Reference
      • GETList Transfers
      • POSTCreate a Transfer
      • GETRetrieve a Transfer
LogoLogo
API ReferenceTransfers

Retrieve a Transfer

GET
https://api.latitude.xyz/v1/transfers/:id
GET
/v1/transfers/:id
$curl https://api.latitude.xyz/v1/transfers/id \
>     -H "Content-Type: application/json"
200Retrieved
1{
2  "id": "trf_9f8b7c6d5e4a3b2c1d0e",
3  "client_reference_id": "INV-20240115-001",
4  "source_amount": "1500.00",
5  "source_currency": "USD",
6  "destination_amount": "30000.00",
7  "destination_currency": "MXN",
8  "exchange_rate": "20.00",
9  "recipient_id": "rcp_1234567890abcdef",
10  "financial_account_id": "fac_abcdef1234567890",
11  "payout_method": "ach",
12  "status": "pending",
13  "total_fee": "15.00",
14  "fee_currency": "USD",
15  "total_tax": "1.50",
16  "tax_currency": "USD",
17  "net_source_amount": "1483.50",
18  "completed_in": "0",
19  "created_at": "2024-01-15T09:30:00Z",
20  "updated_at": "2024-01-15T09:30:00Z",
21  "failure_reason": "",
22  "settlement_reference_id": "set_20240115_0001",
23  "deposit_instructions": {
24    "type": "ach",
25    "currency": "usd",
26    "payment_methods": [
27      "ach"
28    ],
29    "details": {
30      "account_number": "123456789",
31      "routing_number": "021000021",
32      "account_holder_name": "John Doe",
33      "account_type": "checking"
34    },
35    "deadline": "2024-01-20T09:30:00Z"
36  }
37}
Retrieves a transfer by its unique public identifier
Was this page helpful?
Previous

Create a Quote

Next
Built with

Path parameters

idstringRequired

Response

Retrieve a Transfer
idstring
Unique identifier for the transfer
client_reference_idstring
Reference ID for the transfer
source_amountstring
Amount of the source currency
source_currencyenum
Currency of the source amount
Allowed values:
destination_amountstring
Amount of the destination currency
destination_currencyenum
Currency of the destination amount
exchange_ratestring
Exchange rate for the transfer
recipient_idstring
Unique identifier for the recipient
financial_account_idstring
Unique identifier for the financial account
payout_methodenum
Method of payout
statusenum
Current status of the transfer
total_feestring
Total fee for the transfer
fee_currencystring
Currency of the total fee
total_taxstring
Total tax for the transfer
tax_currencystring
Currency of the total tax
net_source_amountstring
Net amount of the source currency after fees
completed_instring
Time taken to complete the transfer in seconds
created_atstringformat: "date-time"
ISO8601 timestamp when the transfer was created
updated_atstringformat: "date-time"
ISO8601 timestamp when the transfer was last updated
failure_reasonstring
Reason for the transfer failure
settlement_reference_idstring
Reference ID for the settlement
deposit_instructionsobject
Present when the transfer is awaiting funding.