v4

OpenAPI 3.1.02026-08-012402353.8 MB

List Account Transfers

get/account_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 Account 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.

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

Account 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",
      "amount": 100,
      "approval": {
        "approved_at": "2020-01-31T23:59:59Z",
        "approved_by": null
      },
      "cancellation": null,
      "created_at": "2020-01-31T23:59:59Z",
      "created_by": {
        "category": "user",
        "user": {
          "email": "user@example.com"
        }
      },
      "currency": "USD",
      "description": "Move money into savings",
      "destination_account_id": "account_uf16sut2ct5bevmq3eh",
      "destination_transaction_id": "transaction_j3itv8dtk5o8pw3p1xj4",
      "id": "account_transfer_7k9qe1ysdgqztnt63l7n",
      "idempotency_key": null,
      "pending_transaction_id": null,
      "status": "complete",
      "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
      "type": "account_transfer"
    }
  ],
  "next_cursor": "v57w5d"
}