No momento, esta página não está disponível em português

Batch result file

You can get the batch result file two days after receiving the batch acknowledgement (ACK) file with a successful validation.

The following fields are included in all batch result files:

The File Header [FH] record contains the data that was passed in the batch request file header.

Field #	Format	Description
1	Fixed value: `FH`	Record type identifier.
2	Fixed value: `1.0`	Version number. This field enables version control for the release of future enhancements for batch processing.
3	Allowed values: `TEST` `LIVE`	It specifies the environment: either test or live/production.
4	Allowed values: `MerchantAccount` `Company`	Account type, as submitted in the request file.
5	Alphanumeric	The merchant or the company account name, as submitted in the request file.
6	Alphanumeric	The submission platform value provided in the request file.
7	Numeric	The file sequence number value provided in the request file.
8	Alphanumeric	The API credential name specified to upload the file to the SFTP. For example: strong>ws@Company.[YourCompanyAccount]</strong
9	Allowed values: Authorisation Payout RefundWithData Modification PayoutModification AccountUpdater	The file type value provided in the request file.
10	Alphanumeric	The file header `EchoData` value provided in the corresponding request file. If you do not pass any value in the corresponding field in the request file, this field is blank.

The File Trailer [FT] record specifies the number of blocks in the file.

Field #	Format	Description
1	Fixed value: `FT`	Record type identifier
2	Numeric	Number of blocks in the file.

The Block Header [BH] record specifies the information that was passed in the batch request block header.

Field #	Format	Description
1	Fixed value: `BH`	Record type identifier
2	Numeric	Block number. Its value increments sequentially by one unit per block.
3	Alphanumeric	The block header `EchoData` value provided in the corresponding request file. If you do not pass any value in the corresponding field in the request file, this field is blank.

The Block Trailer [BT] record specifies the number of lines in the block.

Field #	Format	Description
1	Fixed value: `BT`	Record type identifier
2	Numeric	Number of line records in the block.

FH,1.0,TEST,MerchantAccount,TestCompany,Default,1,ws@Company.TestCompany,Authorisation,FileHeaderEchoData
BH,1,BlockHeaderEchoData
...
BT,5
FT,1