Report file on a mass payout
After successful automatic payouts to the merchant's customers, the system sends out a report to the e-mail address specified in the parameters of a mass payout. The report contains results of processing payout transactions.
The report file meets the following requirements:
1. The file format: CSV.
2. Payout parameters: reported in the first row as headers separated with “|”. The report file includes all the source parameters of payouts from the uploaded file, and the reporting parameters of the processed payouts.
3. Payout parameter values: reported in rows respectively to the parameter keys (headers).
They are separated with “|”.
4. The order of the rows in the report is the same as the order of the rows in the uploaded file.
Table: Mass payout parameters
|
Parameter |
Description |
Notes |
|
request_status |
A status of payout request. Possible values: valid: the request was successfully generated and processed; invalid: an error occurred while generating a request, or a response was not received from the gateway. |
|
|
transaction_uid |
Transaction ID (UID) in the system. |
|
|
transaction_status |
A transaction status. Possible values: successful: a payout was successfully processed; failed: a payout was processed, but declined; incomplete: a transaction is not completed, and additional merchant's actions are required; expired: a transaction processing time is expired. |
|
|
message |
A processing result message. |
|
|
rrn |
Retrieval reference number, a bank transaction number. |
|
|
amount |
A cost in minimal currency units. |
For example, USD32.45 must be sent as USD 3245. |
|
currency |
A transaction currency. |
The applicable format is ISO-4217 format, e.g. USD. |
|
number |
The card number mask. |
The applicable format is the first 6 digits ХХХХ the last 4 digits of the card number. |
|
description |
A short payout description. |
|
|
tracking_id |
An identification number of the payment assigned by the merchant. |
If not provided in the uploaded file, the parameter is generated automatically. |
|
test |
A parameter of the test transaction. Possible value: true: a transaction is a test one; false: a transaction is not a test one. |
If not provided in the uploaded file, the parameter is set to false. |
Sample CSV file content
|
request_status|transaction_uid|transaction_status|message|rrn|amount|currency|number| description|tracking_id|test |