Sign in
Transfers

List Transfers

Lists an account's transfers.

get/transfers

Query parameters

origin_idstring

Filter to transfers sent from this account. Provide this or destination_id.

destination_idstring

Filter to transfers received by this account. Provide this or origin_id.

order'created_at' | 'amount'

Sort column. Defaults to created_at.

direction'asc' | 'desc'

Sort direction. Defaults to desc.

created_beforestring

Only transfers created strictly before this ISO 8601 timestamp.

created_afterstring

Only transfers created strictly after this ISO 8601 timestamp.

firstinteger

Number of results to return from the start of the range.

afterstring

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

lastinteger

Number of results to return from the end of the range.

beforestring

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

Response

transfers listed

Example response

{
  "data": [
    {
      "amount": 25,
      "created_at": "2026-01-01T12:00:00.000Z",
      "created_by_user": {
        "id": "user_xxxxxxxxxxxxxx",
        "name": "Marcus Webb",
        "username": "marcuswebb"
      },
      "currency": "usd",
      "destination_ledger_account_id": "ldgr_xxxxxxxxxxxxxx",
      "fee_amount": 0.5,
      "id": "ctt_xxxxxxxxxxxxxx",
      "metadata": {
        "order_id": "SHINE-1042"
      },
      "notes": "Refund for the rescheduled interior detail",
      "object": "transfer",
      "origin_ledger_account_id": "ldgr_xxxxxxxxxxxxxx",
      "status": "succeeded"
    }
  ],
  "page_info": {
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

Changes

Changed in 6 of the 74 revisions of this API.19

  • ff3a7657356312See the full diff
    • ▲

      for the query request parameter first, default value was changed from 50 to 20

      request-parameter-default-value-changed

    • ○

      for the query request parameter first, the max was increased from 50.00 to 100.00

      request-parameter-max-increased

    • ○

      for the query request parameter last, the max was increased from 50.00 to 100.00

      request-parameter-max-increased

  • c301132dbfd73See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f1020c3ecda41See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6c970f803b461See the full diff
    • ○

      added the required property // to the response with the status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • bdd0e2c70d581See the full diff
    • ○

      added the required property // to the response with the status

      response-required-property-added

    This revision also has 16 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8d1ddeb8dc331See the full diff
    • ○

      added the required property // to the response with the status

      response-required-property-added

Of the 74 revisions, 1 has no diff computed.