v47

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-012382333.4 MB

List Check Transfers

get/check_transfers

Query parameters

cursorstring

Return the page of entries after this one.

limitinteger

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_idstring

Filter Check Transfers to those that originated from the specified Account.

idempotency_keystring

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

status.instring[]

Filter Check Transfers to those that have the specified status. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

created_at.afterstring date-time

Return results after this ISO 8601 timestamp.

created_at.beforestring date-time

Return results before this ISO 8601 timestamp.

created_at.on_or_afterstring date-time

Return results on or after this ISO 8601 timestamp.

created_at.on_or_beforestring date-time

Return results on or before this ISO 8601 timestamp.

Response

Check Transfer List

next_cursorstring nullable required

A pointer to a place in the list. Pass this as the cursor parameter to retrieve the next page of results. If there are no more results, the value will be null.

Example response

{
  "data": [
    {
      "account_id": "account_in71c4amph0vgo2qllky",
      "account_number": "987654321",
      "amount": 1000,
      "approval": null,
      "approved_inbound_check_deposit_id": "inbound_check_deposit_zoshvqybq0cjjm31mra",
      "balance_check": null,
      "cancellation": null,
      "check_number": "123",
      "created_at": "2020-01-31T23:59:59Z",
      "created_by": {
        "category": "user",
        "user": {
          "email": "user@example.com"
        }
      },
      "currency": "USD",
      "fulfillment_method": "physical_check",
      "id": "check_transfer_30b43acfu9vw8fyc4f5",
      "idempotency_key": null,
      "mailing": {
        "mailed_at": "2020-01-31T23:59:59Z"
      },
      "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4",
      "physical_check": {
        "attachment_file_id": null,
        "check_voucher_image_file_id": null,
        "mailing_address": {
          "city": "New York",
          "line1": "33 Liberty Street",
          "line2": null,
          "name": "Ian Crease",
          "phone": "+16505046304",
          "postal_code": "10045",
          "state": "NY"
        },
        "memo": "Invoice 29582",
        "note": null,
        "payer": [
          {
            "contents": "Ian Crease"
          },
          {
            "contents": "33 Liberty Street"
          },
          {
            "contents": "New York, NY 10045"
          }
        ],
        "recipient_name": "Ian Crease",
        "return_address": {
          "city": "New York",
          "line1": "33 Liberty Street",
          "line2": null,
          "name": "Ian Crease",
          "phone": "+16505046304",
          "postal_code": "10045",
          "state": "NY"
        },
        "shipping_method": null,
        "signature": {
          "image_file_id": null,
          "text": "Ian Crease"
        },
        "tracking_updates": []
      },
      "routing_number": "101050001",
      "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
      "status": "mailed",
      "stop_payment_request": null,
      "submission": {
        "preview_file_id": null,
        "submitted_address": {
          "city": "NEW YORK",
          "line1": "33 LIBERTY STREET",
          "line2": null,
          "recipient_name": "IAN CREASE",
          "state": "NY",
          "zip": "10045"
        },
        "submitted_at": "2020-01-31T23:59:59Z",
        "tracking_number": null
      },
      "third_party": null,
      "type": "check_transfer",
      "valid_until_date": null
    }
  ],
  "next_cursor": "v57w5d"
}