Advanced SFTP batch files

Batch file processing allows you to process multiple transactions in bulk: you submit a file listing all the payments you want us to process.

This feature comes in handy when you need to process refunds or retry failed capture attempts, for example. You group all the transactions in a file and then upload it for Adyen to process all the data.

Each batch file can hold only one request type per merchant account. Create separate files for each request like authorisation, refund, capture etc.

To start processing batches you should have the following permissions at the merchant account level:

  • Merchant submits batch modifications.
  • Merchant submits batch payments.

Contact Support Team to enable it for you.

Before submitting batch files a secure communication channel. To achieve that, we use the SFTP transfer protocol and PGP data encryption.

SFTP configuration

Send the following information to the Support Team to create a secure FTP (SFTP) directory for you to upload your batch files:

  • Your source IP address(s): the IP addresses of the servers you from which you are going to upload batch request files.
  • Your public SSH key: you need to generate an RSA SSH key pair (public and private keys). Key length should be 2048 bits for each key.
  • Technical point of contact: the names and email addresses of your technical points of contact.

PGP encryption

Since batch files contain sensitive information, for example, card numbers, you need to encrypt them before uploading.

If you want to always encrypt result files, contact our Support Team to enable this feature.

To enable PGP data encryption file with PGP. To do this, do the following:

  • Go to the Customer Area.
  • From the main menu, select Account.
  • Under Company Settings, click the Manage PGP Keys link.
     

  • Select the Adyen key you want to use. To download the public part, click Download.
    You can encrypt the file with this key before sending it to Adyen. Adyen signs the batch result file with this key.
  • Upload your public key and specify Batch Files as a purpose for the action.
    You can sign your file with this key to have it verified by Adyen. Adyen can encrypt the batch result file with this key.

PGP troubleshooting

In some cases, your file may be rejected. You receive a batch acknowledgment file providing details about the rejections. Common causes for batch file rejection are:

  • You send a PGP-encrypted file whose decryption operation returns errors.
    For example, a failure to verify the signature, or the key used to sign the file is not configured for your company account.
  • You send a PGP-encrypted file, but you do not have a public key to encrypt the response file.
  • You send an unencrypted file containing live card numbers.