List transfers

GET /api/v1/transfers

List transfers

cURL

curl --request GET \
  --url https://app.sure.am/api/v1/transfers \
  --header 'X-Api-Key: <api-key>'

200

{
  "transfers": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "pending",
      "date": "2023-12-25",
      "amount": "<string>",
      "amount_cents": 123,
      "currency": "<string>",
      "transfer_type": "transfer",
      "inflow_transaction": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "date": "2023-12-25",
        "amount": "<string>",
        "amount_cents": 123,
        "currency": "<string>",
        "name": "<string>",
        "kind": "<string>",
        "account": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "account_type": "<string>"
        }
      },
      "outflow_transaction": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "date": "2023-12-25",
        "amount": "<string>",
        "amount_cents": 123,
        "currency": "<string>",
        "name": "<string>",
        "kind": "<string>",
        "account": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "account_type": "<string>"
        }
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "notes": "<string>"
    }
  ],
  "pagination": {
    "page": 2,
    "per_page": 2,
    "total_count": 1,
    "total_pages": 1
  }
}

What this endpoint does

Lists conversions automatically created when customers fund direct payment routes.

When to use it

Use it for transfer search, reconciliation, and monitoring across customers and routes.

Before you call

Authenticate with an API key that can read this resource. Results are restricted to the tenant account bound to that key.

Money and balance effect

This is a read-only request. It does not reserve, debit, credit, or settle money.

States and completion

The status field carries the enum values shown in the schema, not display copy. Broadly: awaiting_payin, awaiting_deposit, and the deposit_* states are waiting on funds; states such as screening, fx_executed, sweeping, pooled, payout_instructed, and sending are in flight; on_hold, payout_held, and frozen are holds; completed, failed, cancelled, returned, expired, and reversed are terminal. Treat only completed as settled — never infer settlement from creation alone.

Safe retries

GET requests are read-only and may be retried with normal exponential backoff. Do not send an Idempotency-Key.

Read Activity and history for the complete workflow.

Authorizations

X-Api-Key · string · header · required

API key for authentication. Generate one from your account settings.

Query Parameters

page · integer

Page number (default: 1)

per_page · integer

Items per page (default: 25, max: 100)

status · enum<string>

Filter by transfer status

Available options: pending, confirmed

account_id · string<uuid>

Filter transfers involving this account

start_date · string<date>

Filter transfers from this date

end_date · string<date>

Filter transfers until this date

Response

200

application/json

transfers listed

transfers · object[] · required

Show child attributes

pagination · object · required

Show child attributes