---
updatedAt: 2026-01-16T01:05:26.000Z
agentTools:
  projectIndex: https://docs.truelayer.com/llms.txt
---

# SFTP in Console

Configure SFTP in Console.

SFTP, or Secure File Transfer Protocol, is a way that you can receive reports automatically on a schedule that you configure. To manage SFTP settings for your organisation, go to **Settings** and then **SFTP settings**. You must be an **Owner** of an organisation to change SFTP settings.

Contact us to receive an SFTP username and server URL if you don't already have them. They will be added to your org in Console.

> 🚧
>
> Currently, you cannot simulate SFTP report delivery in sandbox.

![](https://files.readme.io/2ebdb87d1ed87ec050fc0b070aefcef53c37d8c7b028dafac9ff9f403d91c076-image.png)

## SSH keys

Additionally, you need to upload an **SSH key**. To add one for the first time, click the **Add SSH public key** button. Inside the dialog that opens, input a name for your key and select your public key file.

[block:image]
{
  "images": [
    {
      "image": [
        "https://files.readme.io/50e3682af63850806b0a37104966ba1d402dc851e700e78b7d47ee3adc3f0a94-Screenshot_2025-05-19_at_10.27.55.png",
        null,
        ""
      ],
      "align": "center"
    }
  ]
}
[/block]

### Supported SSH key types

We recommend that you use the `ED25519` format.

For ED25519: `ssh-ed25519`

For RSA:

* `rsa-sha2-256`
* `rsa-sha2-512`

For ECDSA:

* `ecdsa-sha2-nistp256`
* `ecdsa-sha2-nistp384`
* `ecdsa-sha2-nistp521`

### In Linux/MacOS/Windows:

To generate a ED25519 public key and private key in the current directory with the provided filename, use this request:

```graphql
ssh-keygen -t ssh-ed25519 -f <path_to_private_key>
```

* `<path_to_private_key>` is the private key
* `<path_to_private_key>.pub` the public key

Example:

```graphql
> ssh-keygen -t ssh-ed25519 -f my_keys/key
```

## What appears in reports delivered via SFTP

### Payments report

CSV output of all payment activity for the configured `client_id`including OpenLoop and ClosedLoop payments, payouts, refunds and external deposits **sorted by created date**. Contains all activity created between `start_date` (inclusive) and `end_date` (exclusive).

Each activity will be represented by its status at time of report generation (may not be its final status).

* By default, contains all payment activities including, pending, executed/settled and failed.
* Payments are ordered based on the time they were created.

Has the following possible columns:

* `amount`
* `currency`
* `status`
* `type`
* `reference`
* `remitter`
* `beneficiary`
* `id`
* `paymentId`
* `payoutId`
* `date`\
  The date of the last payment status transition. For example, if the payment is settled it will show the `settled_at` timestamp here. If it has been created but not gone through any other state changes, it will show the `created_at` timestamp here.
* `providerId`
* `providerName`
* `failureReason`\
  If applicable.
* `remitterIban`
* `remitterAccountNumber`
* `remitterSortCode`
* `beneficiaryIban`
* `beneficiaryAccountNumber`
* `beneficiarySortCode`
* `beneficiaryType`
* `paymentSourceId`
* `userId`
* `createdAt`
* `authorizedAt`
* `executedAt`
* `failedAt`
* `settledAt`
* `schemeId`
* `schemeName`
* `mandateId`\
  If the payment was a payment on a mandate.
* `isReturn`\
  Will be `true` if
* `merchantAccountId`
* `isCreditable`
* `creditableAt`
* `refundedBy`
* `refundFor`
* Metadata\
  There will be a separate column for each metadata key available on any of the payments included within the report. The column heading will follow the form `meta:{metadata_key}`. The number of metadata columns is dynamic and can vary between different generated reports.

The report will be called\
`{client_id}_activities_{version}_{start_date}_{end_date}_{revision}_{metadata_ref}.csv`

* the `start_date` is inclusive
* the `end_date` is exclusive
* the `version` is `v1`
* default `revision` is `rev00`

### Transactions report

This report is a CSV output of all `settled` inbound and `executed` outbound merchant account transactions between `start_date` (inclusive) and `end_date` (exclusive).

This also includes `pending` outbound transactions that were created within the provided dates.

The report will be called:\
`{client_id}_{merchant_account_id}_transactions_{version}_{start_date}_{end_date}_{revision}_{metadata_ref}.csv`

* the `start_date` is inclusive
* the `end_date` is exclusive
* the version is `v1`
* the default revision is `rev00`

Has the following possible columns:

* `amount`
* `currency`
* `status`
* `type`
* `reference`
* `remitter`
* `beneficiary`
* `transactionId`
* `paymentId`
* `payoutId`
* `date`\
  The date of the last payment status transition. For example, if the transaction is `settled` it will show the `settled_at` timestamp here. If it has been created but not gone through any other state changes (i.e. is`pending`), it will show the `created_at` timestamp here.
* Metadata\
  There will be a separate column for each metadata key available on any of the payments included within the report. The column heading will follow the form `meta:{metadata_key}`. The number of metadata columns is dynamic and can vary between different generated reports.