File transfer guide - Batch
What is Batch?
Batch is an app that provides a file based interface to our products. Customers can make a file available to Azupay via their own self-hosted sftp server. A file contains multiple records that will be used to create PaymentRequests, PaymentInitiations or Payments.
Easy to integrate
Leverage your existing sftp infrastructure and file generation applications to integrate with our Batch App.
Secure
Well known, reliable, and secure technology using SFTP (Secure File Transfer Protocol). Using private/public key based authentication, you can be sure that the transfer process is secure.
PayID based payments are inherently secure. Files do not require the inclusion of any customer identification data. No file level or encryption at rest required.
Super fast
We have built a streaming, highly parallelised system for consuming files and invoking the same API’s that we offer you.
Enabling Batch
- Login to Client Portal and navigate to Apps
- Click the Manage button to open the Azupay Batch configuration
- Click or switch the Enable Batch to On and fill in the SFTP server details.
- Copy and paste the Public SSH Key to your SFTP server's authorized_keys file.
Batch app polling behaviour
Batch app will poll your sftp server every minute, process a single file and then stop. So, if you place 10 files on your sftp server, it will take at least 10 minutes to process them all.
File Name Specification
Example
- Example file names:
- payment-initiation-20211027115901-1-request.csv
- payment-request-2021102711590100001-request.csv
Specification
| Attribute | Value |
|---|---|
| Filename - Inbound File | <file-type>-<unique-file-identifier>-request.csv |
| Filename - Processed | <file-type>-<unique-file-identifier>-response.csv |
| File Encoding | UTF-8 |
| New Line Character | UNIX new line (i.e. \n ) |
| File Size | Maximum 256 MB |
| Field Delimiter | Comma character (i.e. , ) |
| Field Value Enclosing Character | Double quote (“) or ASCII decimal 34 |
File Types
We have the following file types
| Transaction Type | file-type | suffix | delimiter | sample request file |
|---|---|---|---|---|
| Payment Request | payment-request | -request.csv | Comma (,) | payment-request-202202120001-request.csv |
| Payment Initiation | payment-initiation | -request.csv | Comma (,) | payment-initiation-202202120001-request.csv |
| Payment Initiation | payment-initiation | -response.csv | Comma (,) | payment-initiation-202202120001-response.csv |
| Payment Initiation Refund | payment-initiation-refund | -request.csv | Comma (,) | payment-initiation-refund-202202120001-request.csv |
| Payment Initiation Refund | payment-initiation-refund | -response.csv | Comma (,) | payment-initiation-refund-202202120001-response.csv |
| Payment | payment | Carriage-return/line-feed (CRLF) | 202202120001.aba | |
| Payment | payment | -response.aba | Carriage-return/line-feed (CRLF) | 202202120001 -response.aba |
Updated 6 months ago