Private API Reference

Transfer Sessions

Transfer Sessions allow submitting offsetting ACH credit and debit transfers.

The Transfer Session object

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "created_at": "2020-01-31T23:59:59Z",
  "id": "external_account_ukk55lr923a3ac0pp7iv",
  "idempotency_key": null,
  "preferred_effective_date": {
    "date": null,
    "settlement_schedule": "same_day"
  },
  "status": "pending",
  "type": "transfer_session"
}

Attributes

account_id

string

The Account the Transfer Session belongs to.

More about Accounts.

created_at

string

The ISO 8601 date and time at which the Transfer Session was created.

string

The Transfer Session’s identifier.

idempotency_key

string

Nullable

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

preferred_effective_date

dictionary

Configuration for how the effective date of the transfer will be set. This determines same-day vs future-dated settlement timing. If not set, defaults to a settlement_schedule of same_day. If set, exactly one of the child attributes must be set.

status

enum

The Transfer Session’s status.

type

string

A constant representing the object’s type. For this resource it will always be transfer_session.

List Transfer Sessions

curl \
  --url "${INCREASE_URL}/transfer_sessions" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Returns a list response :

{
  "data": [
    { /* Transfer Session object */ },
    { /* Transfer Session object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

status.in

array of strings

The status to retrieve Transfer Sessions for. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

account_id

string

Filter Transfer Sessions to those belonging to the specified Account.

More about Accounts.

idempotency_key

string

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.

Between 1 and 200 characters

More parameters

cursor

string

limit

integer

created_at.after

string

created_at.before

string

created_at.on_or_after

string

created_at.on_or_before

string

Create a Transfer Session

curl -X "POST" \
  --url "${INCREASE_URL}/transfer_sessions" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "account_id": "account_in71c4amph0vgo2qllky",
    "preferred_effective_date": {
      "settlement_schedule": "future_dated"
    }
  }'

Parameters

account_id

string

Required

The Account the Transfer Session should belong to.

More about Accounts.

preferred_effective_date

dictionary

Required

Configuration for how the effective date of the transfer session will be set. This determines same-day vs future-dated settlement timing. If not set, defaults to a settlement_schedule of same_day. If set, exactly one of the child attributes must be set.

Retrieve a Transfer Session

curl \
  --url "${INCREASE_URL}/transfer_sessions/transfer_session_9uawnxxjsednszpnno3d" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

transfer_session_id

string

Required

The identifier of the Transfer Session.

Cancel a Transfer Session

curl -X "POST" \
  --url "${INCREASE_URL}/transfer_sessions/transfer_session_9uawnxxjsednszpnno3d/cancel" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

transfer_session_id

string

Required

The identifier of the Transfer Session to cancel.

Confirm a Transfer Session

curl -X "POST" \
  --url "${INCREASE_URL}/transfer_sessions/transfer_session_9uawnxxjsednszpnno3d/confirm" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

transfer_session_id

string

Required

The identifier of the Transfer Session to confirm.