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

List Transfers

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

Create a Transfer

Next
Built with

Response

List Transfers
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.