Private API Reference

SEPA Instant Transfers

SEPA Instant Transfers move euros, within seconds, from your Increase account to any account in the Single Euro Payments Area addressed by an International Bank Account Number (IBAN).

Events

Your application can listen to webhooks about this resource. The events about SEPA Instant Transfers will have the categories "sepa_instant_transfer.created" or "sepa_instant_transfer.updated".

The SEPA Instant Transfer object

{
  "acceptance": {
    "accepted_at": "2020-01-31T14:10:05Z",
    "settlement_amount": 4935,
    "transfer_id": "sepa_instant_transfer_v3gtgvhja733o9jfp1la"
  },
  "account_id": "account_in71c4amph0vgo2qllky",
  "amount": 4200,
  "created_at": "2020-01-31T14:00:00Z",
  "created_by": {
    "category": "user",
    "user": {
      "email": "user@example.com"
    }
  },
  "creditor_address": {
    "country": "DE",
    "line1": "Kaiserstrasse 16",
    "line2": null,
    "postal_code": "60311",
    "town": "Frankfurt am Main"
  },
  "creditor_name": "Ian Crease",
  "currency": "EUR",
  "debtor_address": {
    "country": "US",
    "line1": "123 Main Street",
    "line2": null,
    "postal_code": "10001",
    "town": "New York"
  },
  "debtor_name": "National Phonograph Company",
  "id": "sepa_instant_transfer_v3gtgvhja733o9jfp1la",
  "idempotency_key": null,
  "international_bank_account_number": "DE89370400440532013000",
  "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4",
  "rejection": null,
  "status": "complete",
  "submission": {
    "submitted_at": "2020-01-31T14:10:00Z"
  },
  "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
  "type": "sepa_instant_transfer",
  "unique_end_to_end_transaction_reference": "INC-2020-01-000483",
  "unstructured_remittance_information": "Invoice 10482, August retainer"
}

Attributes

acceptance

dictionary

Nullable

If the transfer is accepted by the recipient’s bank, this will contain supplemental details.

account_id

string

The Account from which the transfer was sent.

More about Accounts.

amount

integer

The transfer amount in euro cents.

created_at

string

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

created_by

dictionary

Nullable

What object created the transfer, either via the API or the dashboard.

creditor_address

dictionary

The creditor’s address.

creditor_name

string

The name of the transfer’s recipient. This is set by the sender when creating the transfer.

currency

enum

The ISO 4217 code for the transfer’s currency. For SEPA Instant Transfers this is always equal to EUR.

debtor_address

dictionary

Nullable

The debtor’s address.

debtor_name

string

Nullable

The name of the transfer’s sender, shown on the recipient’s bank statement as the remitter.

string

The SEPA Instant Transfer’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.

international_bank_account_number

string

The creditor’s International Bank Account Number (IBAN).

pending_transaction_id

string

Nullable

The ID for the pending transaction representing the transfer.

More about Pending Transactions.

rejection

dictionary

Nullable

If the transfer is rejected by the SEPA Instant Credit Transfer scheme or the recipient’s bank, this will contain supplemental details.

status

enum

The lifecycle status of the transfer.

submission

dictionary

Nullable

After the transfer is submitted to the SEPA Instant Credit Transfer scheme, this will contain supplemental details.

transaction_id

string

Nullable

The Transaction funding the transfer once it is complete.

More about Transactions.

type

string

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

unique_end_to_end_transaction_reference

string

Nullable

The end-to-end reference of the transfer. This is stored by our partner bank as its reference for the payment but is not yet delivered to the creditor.

unstructured_remittance_information

string

Nullable

Unstructured remittance information included in the transfer.

List SEPA Instant Transfers

curl \
  --url "${INCREASE_URL}/sepa_instant_transfers?account_id=account_in71c4amph0vgo2qllky" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Returns a list response:

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

Parameters

account_id

string

Filter SEPA Instant Transfers to those that originated from 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

status.in

array of strings

Return results whose value is in the provided list. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

More parameters

Create a SEPA Instant Transfer

curl -X "POST" \
  --url "${INCREASE_URL}/sepa_instant_transfers" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "account_id": "account_in71c4amph0vgo2qllky",
    "amount": 4200,
    "creditor_address": {
      "country": "DE",
      "line1": "Kaiserstrasse 16",
      "postal_code": "60311",
      "town": "Frankfurt am Main"
    },
    "creditor_name": "Ian Crease",
    "international_bank_account_number": "DE89370400440532013000"
  }'

Parameters

account_id

string

Required

The identifier for the Account that will send the transfer.

More about Accounts.

amount

integer

Required

The amount, in euro cents, to send to the creditor.

creditor_address

dictionary

Required

The creditor’s address.

creditor_name

string

Required

The creditor’s name.

Between 1 and 35 characters,

currency

enum

The ISO 4217 currency code of the transfer. For SEPA Instant Transfers this is always EUR.

Defaults to EUR

debtor_address

dictionary

The debtor’s address. If not provided, defaults to the address of the account’s entity.

debtor_name

string

The debtor’s name, shown on the creditor’s bank statement as the remitter. If not provided, defaults to the name of the account’s entity.

Between 1 and 35 characters,

international_bank_account_number

string

Required

The creditor’s International Bank Account Number (IBAN).

Between 1 and 34 characters,

unique_end_to_end_transaction_reference

string

The end-to-end reference of the transfer. This is stored by our partner bank as its reference for the payment but is not yet delivered to the creditor.

Between 1 and 35 characters,

unstructured_remittance_information

string

Unstructured remittance information to include in the transfer.

Between 1 and 140 characters,

Retrieve a SEPA Instant Transfer

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

Parameters

sepa_instant_transfer_id

string

Required

The identifier of the SEPA Instant Transfer.