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 enable SFTP, go to Settings and then SFTP settings.
Contact us to receive an SFTP username and server URL if you don't already have them. They will be uploaded to your org in Console.
Roles and permissions
You must be an Owner of an organisation to change SFTP settings.
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 the name of your key and your key details.
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:
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:
> ssh-keygen -t ssh-ed25519 -f my_keys/key
What appears on reports
CSV output of all payment activities including OpenLoop and ClosedLoop payments sorted by created date. Contains all created activities 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
- Payment ID
- Payout ID
- Deposit ID
- Date
The date of the last payment status transition. For example, if the payment is settled it will show thesettled_at
timestamp here. If it has been created but not gone through any other state changes, it will show thecreated_at
timestamp here. - Provider ID
- Provider name
- Failure reason
If applicable. - Remitter IBAN
- Remitter account number
- Remitter sort code
- Beneficiary IBAN
- Beneficiary account number
- Beneficiary sort code
- Beneficiary type
- Payment source ID
- User ID
- Created at
- Authorized at
- Executed at
- Failed at
- Settled at
- Scheme ID
- Scheme name
- Mandate ID
If the payment was a payment on a mandate. - Is_return
Will betrue
if - Merchant account ID
- Is_creditable
- Creditable at
- Refunded by
- Refund for
The report will be called
{clientId}_activities_{version}_{start_date}_{end_date}_{revision}_{metadata_ref}.csv
- the
start_date
is inclusive - the
end_date
is exclusive - the
version
isv1
- default
revision
isrev00
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:
{clientId}_{merchant_account_id}_transactions_{version}_{start_date}_{end_date}_{revision}_{metadata_ref}.csv
- the version is
v1
- the default revision is
rev00
Updated about 6 hours ago