Transfers API

Complete API reference for the Transfers endpoint.

POST/v1/transfers

Create a Transfer

Creates a new transfer to move money to a recipient.

Parameters

amountrequiredinteger

Amount in the smallest currency unit (e.g., cents)

sourceCurrencyrequiredstring

Three-letter ISO currency code (e.g., "USD")

destinationCurrencyrequiredstring

Three-letter ISO currency code for the recipient

destinationrequiredobject

Recipient details including type, country, and account info

referencestring

A reference that will appear on the recipient's statement

metadataobject

Custom key-value pairs for your own use

Request

curl
curl https://api.caibopay.com/v1/transfers \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 100000,
    "sourceCurrency": "CAD",
    "destinationCurrency": "COP",
    "destination": {
      "type": "bank_account",
      "country": "CO",
      "accountHolder": "Maria Garcia",
      "accountNumber": "12345678901234"
    },
    "reference": "Invoice #1234"
  }'

Response

200 OK
{
  "id": "tr_1234567890",
  "object": "transfer",
  "amount": 100000,
  "sourceCurrency": "CAD",
  "destinationCurrency": "COP",
  "destinationAmount": 315025000,
  "exchangeRate": 3150.25,
  "fee": 299,
  "status": "pending",
  "destination": {
    "type": "bank_account",
    "country": "CO",
    "accountHolder": "Maria Garcia",
    "accountNumber": "1234••••••1234"
  },
  "reference": "Invoice #1234",
  "estimatedDelivery": "2026-03-10T12:00:00Z",
  "createdAt": "2026-03-10T10:00:00Z"
}
GET/v1/transfers/:id

Retrieve a Transfer

curl
curl https://api.caibopay.com/v1/transfers/tr_1234567890 \
  -H "Authorization: Bearer sk_test_..."
GET/v1/transfers

List Transfers

curl
curl "https://api.caibopay.com/v1/transfers?limit=10&status=completed" \
  -H "Authorization: Bearer sk_test_..."