Private API Reference

UK Faster Payment System Transfers

UK Faster Payment System transfers move pounds sterling, within seconds, from your Increase account to any UK account addressed by a sort code and account number.

Events

Your application can listen to webhooks about this resource. The events about UK Faster Payment System Transfers will have the categories "uk_faster_payment_system_transfer.created" or "uk_faster_payment_system_transfer.updated" .

The UK Faster Payment System Transfer object

{
  "acceptance": {
    "accepted_at": "2020-01-31T14:10:05Z",
    "settlement_amount": 16765,
    "transfer_id": "uk_faster_payment_system_transfer_dn41ruuwgq3heeak59q2"
  },
  "account_id": "account_in71c4amph0vgo2qllky",
  "account_number": "71583366",
  "amount": 12500,
  "created_at": "2020-01-31T14:00:00Z",
  "created_by": {
    "category": "user",
    "user": {
      "email": "user@example.com"
    }
  },
  "creditor_address": {
    "country": "GB",
    "line1": "16 Kaiser Street",
    "line2": null,
    "postal_code": "EC2R 8AH",
    "town": "London"
  },
  "creditor_name": "Ian Crease",
  "currency": "GBP",
  "debtor_name": "National Phonograph Company",
  "id": "uk_faster_payment_system_transfer_dn41ruuwgq3heeak59q2",
  "idempotency_key": null,
  "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4",
  "reference": "INVOICE 10482",
  "rejection": null,
  "sort_code": "608371",
  "status": "complete",
  "submission": {
    "submitted_at": "2020-01-31T14:10:00Z"
  },
  "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
  "type": "uk_faster_payment_system_transfer",
  "unique_end_to_end_transaction_reference": "INC-2020-01-000482",
  "unstructured_remittance_information": "Invoice 29582"
}

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.

account_number

string

The creditor’s eight-digit UK account number.

amount

integer

The transfer amount in pence.

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 UK Faster Payment System transfers this is always equal to GBP.

debtor_name

string

Nullable

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

string

The UK Faster Payment System 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.

pending_transaction_id

string

Nullable

The ID for the pending transaction representing the transfer.

More about Pending Transactions.

reference

string

The payment reference shown on the recipient’s bank statement.

rejection

dictionary

Nullable

If the transfer is rejected by the UK Faster Payment System or the recipient’s bank, this will contain supplemental details.

sort_code

string

The creditor’s bank’s six-digit UK sort code.

status

enum

The lifecycle status of the transfer.

submission

dictionary

Nullable

After the transfer is submitted to the UK Faster Payment System, 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 uk_faster_payment_system_transfer.

unique_end_to_end_transaction_reference

string

Nullable

The end-to-end reference of the transfer, passed through the UK Faster Payment System unchanged.

unstructured_remittance_information

string

Nullable

Unstructured remittance information included in the transfer.

List UK Faster Payment System Transfers

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

Returns a list response :

{
  "data": [
    { /* UK Faster Payment System Transfer object */ },
    { /* UK Faster Payment System Transfer object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

account_id

string

Filter UK Faster Payment System 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 UK Faster Payment System Transfer

curl -X "POST" \
  --url "${INCREASE_URL}/uk_faster_payment_system_transfers" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "account_id": "account_in71c4amph0vgo2qllky",
    "account_number": "71583366",
    "amount": 12500,
    "creditor_address": {
      "country": "GB",
      "line1": "16 Kaiser Street",
      "town": "London"
    },
    "creditor_name": "Ian Crease",
    "reference": "INVOICE 10482",
    "sort_code": "608371"
  }'

Parameters

account_id

string

Required

The identifier for the Account that will send the transfer.

More about Accounts.

account_number

string

Required

The creditor’s eight-digit UK account number.

Exactly 8 characters,

amount

integer

Required

The amount, in pence, 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 UK Faster Payment System transfers this is always GBP.

Defaults to GBP

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,

reference

string

Required

The payment reference shown on the creditor’s bank statement.

Between 1 and 18 characters,

sort_code

string

Required

The creditor’s bank’s six-digit UK sort code.

Exactly 6 characters,

unique_end_to_end_transaction_reference

string

The end-to-end reference of the transfer, passed through the UK Faster Payment System unchanged.

Between 1 and 31 characters,

unstructured_remittance_information

string

Unstructured remittance information to include in the transfer.

Between 1 and 140 characters,

Retrieve a UK Faster Payment System Transfer

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

Parameters

uk_faster_payment_system_transfer_id

string

Required

The identifier of the UK Faster Payment System Transfer.