# 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](https://increase.com/documentation/webhooks.md) will be generated for this resource. The possible event categories are: `uk_faster_payment_system_transfer.created` and `uk_faster_payment_system_transfer.updated`. ## The UK Faster Payment System Transfer object ### Example ```json { "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. - `acceptance.accepted_at` (string) The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the recipient's bank accepted the transfer. - `acceptance.settlement_amount` (integer) The transfer amount in USD cents. - `acceptance.transfer_id` (string) The identifier of the UK Faster Payment System Transfer that led to this Transaction. - `account_id` (string) The Account from which the transfer was sent. - `account_number` (string) The creditor's eight-digit UK account number. - `amount` (integer) The transfer amount in pence. - `created_at` (string) The [ISO 8601](https://en.wikipedia.org/wiki/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. - `created_by.api_key` (dictionary, nullable) If present, details about the API key that created the transfer. - `created_by.api_key.description` (string, nullable) The description set for the API key when it was created. - `created_by.category` (enum) The type of object that created this transfer. Cases: * `api_key` (An API key. Details will be under the `api_key` object.) * `oauth_application` (An OAuth application you connected to Increase. Details will be under the `oauth_application` object.) * `user` (A User in the Increase dashboard. Details will be under the `user` object.) - `created_by.oauth_application` (dictionary, nullable) If present, details about the OAuth Application that created the transfer. - `created_by.oauth_application.name` (string) The name of the OAuth Application. - `created_by.user` (dictionary, nullable) If present, details about the User that created the transfer. - `created_by.user.email` (string) The email address of the User. - `creditor_address` (dictionary) The creditor's address. - `creditor_address.country` (string) The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country of the address. - `creditor_address.line1` (string) The first line of the address. - `creditor_address.line2` (string, nullable) The second line of the address. - `creditor_address.postal_code` (string, nullable) The postal code of the address. - `creditor_address.town` (string) The town or city of the 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](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's currency. For UK Faster Payment System transfers this is always equal to `GBP`. Cases: * `GBP` (GBP) - `debtor_name` (string, nullable) The name of the transfer's sender, shown on the recipient's bank statement as the remitter. - `id` (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](https://increase.com/documentation/idempotency-keys). - `pending_transaction_id` (string, nullable) The ID for the pending transaction representing the transfer. - `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. - `rejection.additional_information` (string, nullable) Additional information about the rejection provided by the recipient's bank. - `rejection.reason_code` (enum) The reason the transfer was rejected, as provided by the UK Faster Payment System or the recipient's bank. Cases: * `incorrect_account_number` (The destination account number is invalid or does not exist.) * `invalid_creditor_account_number` (The destination account number is incorrect.) * `account_closed` (The destination account is closed.) * `account_blocked` (The destination account is blocked.) * `transaction_forbidden` (Credit transfers are not allowed to the destination account, for example because it is a savings account.) * `duplication` (The transfer was a duplicate of an earlier transfer.) * `unexpected_amount` (The amount of the transfer was not what the recipient expected.) * `invalid_creditor_address` (The recipient's address is missing or invalid.) * `creditor_bank_not_registered` (The recipient's bank is not registered with the UK Faster Payment System.) * `requested_by_customer` (The recipient refused the transfer.) * `settlement_failed` (Settlement of the transfer failed.) * `legal_decision` (The transfer was rejected for legal reasons.) * `end_customer_deceased` (The destination account holder is deceased.) * `not_specified_reason_customer_generated` (The recipient rejected the transfer without specifying a reason.) * `not_specified_reason_agent_generated` (The recipient's bank rejected the transfer without specifying a reason.) * `bank_identifier_incorrect` (The recipient's bank identifier is incorrect.) * `missing_creditor_name_or_address` (The recipient's name or address is missing, which is required for regulatory reasons.) * `regulatory_reason` (The transfer was rejected for regulatory reasons.) * `narrative` (The reason is provided as narrative information in the additional information field.) * `other` (Some other error or issue has occurred.) - `rejection.rejected_at` (string) The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was rejected. - `sort_code` (string) The creditor's bank's six-digit UK sort code. - `status` (enum) The lifecycle status of the transfer. Cases: * `pending_submission` (The transfer is queued to be submitted to the UK Faster Payment System.) * `pending_reviewing` (The transfer is pending review by Increase.) * `submitted` (The transfer has been submitted to the UK Faster Payment System and is pending a response.) * `complete` (The transfer has been accepted by the recipient's bank and is complete.) * `rejected` (The transfer was rejected by the UK Faster Payment System or the recipient's bank.) * `returned` (The transfer was returned by the recipient's bank.) * `requires_attention` (The transfer requires attention from an Increase operator.) - `submission` (dictionary, nullable) After the transfer is submitted to the UK Faster Payment System, this will contain supplemental details. - `submission.submitted_at` (string) The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was submitted to the UK Faster Payment System. - `transaction_id` (string, nullable) The Transaction funding the transfer once it is complete. - `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 GET /uk_faster_payment_system_transfers ### Example ```curl curl \ --url "${INCREASE_URL}/uk_faster_payment_system_transfers?account_id=account_in71c4amph0vgo2qllky" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" ``` ### Query Parameters - `cursor` (string, optional) Return the page of entries after this one. - `limit` (integer, optional) Limit the size of the list that is returned. The default (and maximum) is 100 objects. Default: `100` - `account_id` (string, optional) Filter UK Faster Payment System Transfers to those that originated from the specified Account. - `idempotency_key` (string, optional) 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](https://increase.com/documentation/idempotency-keys). Between 1 and 200 characters - `status.in` (array of enums, optional) 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`. Cases: * `pending_submission` (The transfer is queued to be submitted to the UK Faster Payment System.) * `pending_reviewing` (The transfer is pending review by Increase.) * `submitted` (The transfer has been submitted to the UK Faster Payment System and is pending a response.) * `complete` (The transfer has been accepted by the recipient's bank and is complete.) * `rejected` (The transfer was rejected by the UK Faster Payment System or the recipient's bank.) * `returned` (The transfer was returned by the recipient's bank.) * `requires_attention` (The transfer requires attention from an Increase operator.) - `created_at.after` (string, optional) Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. - `created_at.before` (string, optional) Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. - `created_at.on_or_after` (string, optional) Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. - `created_at.on_or_before` (string, optional) Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. ### Returns a UK Faster Payment System Transfer List object: ```json { "data": [ { "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" } ], "next_cursor": "v57w5d" } ``` ## Create a UK Faster Payment System Transfer POST /uk_faster_payment_system_transfers ### Example ```curl 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" }' ``` ### Body Parameters - `account_id` (string, required) The identifier for the Account that will send the transfer. - `account_number` (string, required) The creditor's eight-digit UK account number. Exactly 8 characters, character restrictions apply - `amount` (integer, required) The amount, in pence, to send to the creditor. - `creditor_address` (dictionary, required) The creditor's address. - `creditor_address.country` (string, required) The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country of the address. Exactly 2 characters - `creditor_address.line1` (string, required) The first line of the address. This is usually the street number and street. Between 1 and 35 characters, character restrictions apply - `creditor_address.line2` (string, optional) The second line of the address. Between 1 and 35 characters, character restrictions apply - `creditor_address.postal_code` (string, optional) The postal code of the address. Between 1 and 16 characters, character restrictions apply - `creditor_address.town` (string, required) The town or city of the address. Between 1 and 35 characters, character restrictions apply - `creditor_name` (string, required) The creditor's name. Between 1 and 35 characters, character restrictions apply - `currency` (enum, optional) The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the transfer. For UK Faster Payment System transfers this is always `GBP`. Default: `GBP` Cases: * `GBP` (GBP) - `debtor_name` (string, optional) 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, character restrictions apply - `reference` (string, required) The payment reference shown on the creditor's bank statement. Between 1 and 18 characters, character restrictions apply - `sort_code` (string, required) The creditor's bank's six-digit UK sort code. Exactly 6 characters, character restrictions apply - `unique_end_to_end_transaction_reference` (string, optional) The end-to-end reference of the transfer, passed through the UK Faster Payment System unchanged. Between 1 and 31 characters, character restrictions apply - `unstructured_remittance_information` (string, optional) Unstructured remittance information to include in the transfer. Between 1 and 140 characters, character restrictions apply ## Retrieve a UK Faster Payment System Transfer GET /uk_faster_payment_system_transfers/{uk_faster_payment_system_transfer_id} ### Example ```curl curl \ --url "${INCREASE_URL}/uk_faster_payment_system_transfers/uk_faster_payment_system_transfer_dn41ruuwgq3heeak59q2" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" ``` ### Path Parameters - `uk_faster_payment_system_transfer_id` (string, required) The identifier of the UK Faster Payment System Transfer.