Format of response file
Header record:
Pos. | Description | Values |
---|---|---|
01 | Record code | 00 |
02 | File type | PAY |
03 | File version | 03 |
04 | Return code of the first stage of processing |
0: Processing completed 1: Format error 2: Value error |
05 | Information about the error | Additional information about the error, empty if successfully processed. |
06 | Shop ID | E.g.: 12345678 |
07 | Mode | TEST or PRODUCTION |
08 | Creation date in the YYYYMMDD format | E.g.: 20200603 |
09 | Creation time in the HHMMSS format. | E.g.: 145410 |
10 | Date of file generation in the YYYYMMDD format | E.g.: 20200603 |
11 | End of processing time in HHMMSS format | E.g.: 145417 |
Detail records:
Pos. | Description |
---|---|
01 | Description: Record code. Type: NUMERIC | Length: 2 Value: 02 |
02 | Description: Sequence number of the detail record in the file. Type: NUMERIC | Length: 6 E.g.:
|
03 | Description: Transaction date in the YYYYMMDD format. Type: NUMERIC | Length: 8 E.g.: 20200603 |
04 | Description: Transaction time in the HHMMSS format. Type: NUMERIC | Length: 6 E.g.: 120615 |
05 | Description: Transaction identifier. Type: NUMERIC | Length: 6 Hosted Payment Page equivalent: vads_trans_id REST API equivalent: cardDetails.legacyTransId E.g.: 700001 |
06 | Description: Transaction type Type: VARCHAR | Length: 2 Value: CD |
07 | Description: Transaction amount expressed in the smallest currency unit . Type: NUMERIC | Length: 12 Hosted Payment Page equivalent: vads_amount REST API equivalent: amount E.g.: 3000 for 30,00 EUR |
08 | Description: Numeric code of the currency (ISO 4217 standard). Type: NUMERIC | Length: 3 Hosted Payment Page equivalent: vads_currency REST API equivalent: currency E.g.: 978 for euro (EUR) (See table vads_currency in annexes) |
09 | Description: Transaction amount expressed in the smallest unit of the currency used for the capture in the bank. Type: NUMERIC | Length: 12 Hosted Payment Page equivalent: vads_effective_amount REST API equivalent: transactions.transactionDetails.effectiveAmount E.g.: 3000 for 30,00 EUR |
10 | Description: Numeric code of the currency that will be used for the capture at the ban (ISO 4217 standard). Type: NUMERIC | Length: 3 Hosted Payment Page equivalent: vads_effective_currency REST API equivalent: transactions.transactionDetails.effectiveCurrency E.g.: 978 for euro (EUR) (See table vads_currency in annexes) |
11 |
Description:
Type: NUMERIC | Length: 8 Hosted Payment Page equivalent: vads_presentation_date REST API equivalent: transactionDetails.cardDetails.expectedCaptureDate E.g.: 20200604 |
12 | Description: Validation mode. Type: NUMERIC | Length: 1 Hosted Payment Page equivalent: vads_validation_mode REST API equivalent: cardOptions.manualValidation Possible values:
E.g.: 0 |
13 | Description: Alias or Unique Mandate Reference to debit. Type: VARCHAR | Length: 50 Hosted Payment Page equivalent: vads_identifier REST API equivalent: paymentMethodToken E.g.: 59ecb199110145338c5704505760ec31 |
14 | Description: MID used to process this request. Type: VARCHAR | Length: 255 Hosted Payment Page equivalent: vads_contract_used REST API equivalent: cardOptions.mid E.g.: 1234567 |
15 | Description: Order reference. Type: VARCHAR | Length: 32 The only accepted special character is “-”. Hosted Payment Page equivalent: vads_order_id REST API equivalent: orderId E.g.: CX-1254 |
16 | Description: Order details 1. Type: VARCHAR | Length: 255 Hosted Payment Page equivalent: vads_order_info REST API equivalent: metadata.orderInfo E.g.: Door phone code 3125 |
17 | Description: Order details 2. Type: VARCHAR | Length: 255 Hosted Payment Page equivalent: vads_order_info2 REST API equivalent: metadata.orderInfo2 E.g.: No elevator |
18 | Description: Order details 3. Type: VARCHAR | Length: 255 Hosted Payment Page equivalent: vads_order_info3 REST API equivalent: metadata.orderInfo3 E.g.: Express |
19 | Description: Return code of processing. Type: NUMERIC | Length: 2 Values:
|
20 | Description: Code sent by the bank that issued the authorization request Type: NUMERIC | Length: 2 Hosted Payment Page equivalent: vads_auth_result REST API equivalent: transactionDetails.cardDetails.authorizationResponse.authorizationResult Values: See chapter vads_auth_result. E.g.: 00 |
21 | Description: Transaction authorization number. Type: VARCHAR | Length: 6 Hosted Payment Page equivalent: vads_auth_number REST API equivalent: transactionDetails.cardDetails.authorizationResponse.authorizationNumber E.g.: 3fc116 |
22 | Description: Authorization mode. Type: VARCHAR | Length: 4 Values:
|
23 |
Description: Authorization date in YYYYMMDD format, written in the UTC timezone. Type: DATE | Length: 8 Hosted Payment Page equivalent: N/A REST API equivalent: transactionDetails.cardDetails.authorizationResponse.authorizationDate E.g.: 20200114 |
24 |
Description: Authorization date in YYYYMMDD format, written in the UTC timezone Type: TIME | Length: 6 Hosted Payment Page equivalent: N/A REST API equivalent: transactionDetails.cardDetails.authorizationResponse.authorizationDate E.g.: 142512 |
25 | Description: Additional return code Type: NUMERIC | Length: 2 Description:
Hosted Payment Page equivalent: vads_extra_result REST API equivalent: N/A Values: See chapter vads_auth_resultE.g.: 00 |
26 | Description: Payment method number. Type: VARCHAR | Length: 36 Hosted Payment Page equivalent: vads_card_number REST API equivalent: transactionDetails.cardDetails.pan E.g.: 497010XXXXXX0014 |
27 | Description: Exp. date of the payment method in the YYYYMMDD format. Type: NUMERIC | Length: 8 Hosted Payment Page equivalent: vads_expiry_year + vads_expiry_month REST API equivalent: transactionDetails.cardDetails.expiryYear + transactionDetails.cardDetails.expiryMonth E.g.: 20211130 |
28 | Description: Tax credit amount allocated to the merchant for this transaction. The amount is expressed in the smallest currency unit. The field is empty if this data has not been returned by the acquirer. Type: NUMERIC | Length: 12 Hosted Payment Page equivalent: vads_tax_refund_amount REST API equivalent: transactionDetails.taxRefundAmount E.g.: 199 |
End record:
Pos. | Description | Format | Values |
---|---|---|---|
01 | Record code | n2 | 01 |
02 | Total number of transmitted detail records | n..6 | |
03 | Number of successful payments | n..6 | |
04 | Number of failed payments | n..6 |
File sample
00;PAY;03;0;;12345678;TEST;20200603;102008;20200603;171049 02;2;20200603;102008;600001;CD;93599;978;93599;978;20200603;0;59ecb199110145338c5704505760ec31;1999999;CX-1255;;;;00;0;440368;FULL;20200603;171047;00;497010XXXXXX0014;20211130; 02;2;20200603;102008;600002;CD;7590;978;7590;978;20200603;0;3d62ec7ce4b249ffb53aa105419aae82;1999888;CX-1255;info1;info2;info3;00;0;3fd85e5;FULL;20200603;171049;00;497010XXXXXX0014;20211130; 02;3;20200603;102008;600003;CD;12300;858;12300;858;20200603;0;;1234567890;CX-1256;info1;info2;info3;00;0;3jk34p2;FULL;20200603;171051;00;497010XXXXXX0014;20211130;199 01;3;3;0