V5 Request file (deprecated)
Header record
| Pos. | Description | Values |
|---|---|---|
| 01 | Record code | 00 |
| 02 | File type | PAY |
| 03 | File version | 05 |
| 04 | Shop ID | 12345678 |
| 05 | Mode (TEST or PRODUCTION) | TEST |
| 06 | Creation date | In YYYYMMDD format |
| 07 | Time of creation | In HHMMSS format |
| 08 | Reserved for future use. | Do not populate |
Detail record
The number of records present in the file directly affects the amount of time it will take to process the file as well as the availability of the return file.
Beyond 2000 records, it is recommended to generate several payment files.
| Pos. | Description |
|---|---|
| 01 | Description: Record code. Type: Numeric | Length: 2 | Required Value: 02 |
| 02 | Description: Sequence number of the detail record in the file. Type: Numeric | Length: 6 | Required E.g.:
|
| 03 | Description: Transaction date in the YYYYMMDD format. Type: Numeric | Length: 8 | Required E.g.: 20200603 |
| 04 | Description: Transaction time in the HHMMSS format. Type: Numeric | Length: 6 | Required E.g.: 120615 |
| 05 | Description: Unique transaction identifier for each transaction for a given shop on the same day. The uniqueness of the transaction identifier is based on the universal time (UTC). The merchant website must guarantee this uniqueness during same the day. Type: Alphanumeric | Length: 6 | Required Hosted Payment Page equivalent: vads_trans_id REST API equivalent: N/A E.g.: 000001 |
| 06 | Description: Transaction type Type: String | Length: 2 | Required Value: CD |
| 07 | Description: Transaction amount expressed in the smallest currency unit . Type: Numeric | Length: 13 | Required Hosted Payment Page equivalent: vads_amount REST API equivalent: amount E.g.: 4525 for EUR 45.25 |
| 08 | Description: Numeric code of the currency (ISO 4217 standard). Type: Numeric | Length: 3 | Required Hosted Payment Page equivalent: vads_currency REST API equivalent: currency E.g.: 978 for euro (EUR) (See chapter List of supported currencies in the appendix) |
| 09 | Description: Requested capture date in the YYYYMMDD format. Leave empty to indicate the current date. Type: Numeric | Length: 8 | Optional Hosted Payment Page equivalent: N/A REST API equivalent: N/A E.g.: 20200603 |
| 10 | Description: Validation mode. See the Transaction Management user manual for more information. Type: Numeric | Length: 1 | Optional Hosted Payment Page equivalent: vads_validation_mode REST API equivalent: cardOptions.manualValidation Possible values:
E.g.: 0 |
| 11 | Description: Token or Unique Mandate Reference to debit. Type: String | Length: 50 | Required Hosted Payment Page equivalent: vads_identifier REST API equivalent: paymentMethodToken E.g.: 59ecb199110145338c5704505760ec31 |
| 12 | Description: The Merchant ID to be used. This parameter is optional and is only used when you have several e-commerce Merchant IDs (MID) within the same network and when you wish to select a different Merchant ID (MID) depending on the payment. Leave empty for using the default contract. Type: String | Length: 128 | Optional Hosted Payment Page equivalent: vads_contracts REST API equivalent: cardOptions.mid E.g.: 1234567 |
| 13 | Description: Order reference. Type: String | Length: 32 | Optional The only accepted special character is “-”. Hosted Payment Page equivalent: vads_order_id REST API equivalent: orderId E.g.: CX-1254 |
| 14 | Description: Order details 1. The data will then be visible in the transaction details (Extra tab) and can be added by the merchant in the payment confirmation emails (merchant and buyer). Type: String | Length: 255 | Optional Hosted Payment Page equivalent: vads_order_info REST API equivalent: metadata.orderInfo E.g.: Door code 3125 |
| 15 | Description: Order details 2. The data will then be visible in the transaction details (Extra tab) and can be added by the merchant in the payment confirmation emails (merchant and buyer). Type: String | Length: 255 | Optional Hosted Payment Page equivalent: vads_order_info2 REST API equivalent: metadata.orderInfo2 E.g.: No elevator |
| 16 | Description: Order details 3. The data will then be visible in the transaction details (Extra tab) and can be added by the merchant in the payment confirmation emails (merchant and buyer). Type: String | Length: 255 | Optional Hosted Payment Page equivalent: vads_order_info3 REST API equivalent: metadata.orderInfo3 E.g.: Express |
| 17 | Description: Allows to qualify transactions as recurring (RecurringType). Field reserved for recurring payments via the FISERV acquirer (First Data) in Latin America. Can be sent empty. Type: String | Length: 255 | Optional Possible values:
Hosted Payment Page equivalent: N/A REST API equivalent: N/A E.g.: FIRST |
| 18 | Description: Number of the contract signed by the buyer (PONumber). Field reserved for recurring payments in Mexico. Can be sent empty. Type: String | Length: 64 | Optional Hosted Payment Page equivalent: N/A REST API equivalent: N/A E.g.: 12345 |
End record
| Pos. | Description | Values |
|---|---|---|
| 01 | Record code | 01 |
| 02 | Number of transmitted detail records. It is recommended not to exceed 2000 records per file. | E.g.: 3 |
File sample
File name: 20200603.12345678.PAY.REQ.T.01
00;PAY;05;12345678;TEST;20200603;102008; 02;1;20200603;102008;600001;CD;1199;978;20200604;0;59ecb199110145338c5704505760ec31;;CX-1254;;;;; 02;2;20200603;102008;600002;CD;7590;978;;0;3d62ec7ce4b249ffb53aa105419aae82;1999888;CX-1255;;;;; 02;3;20200603;102008;600002;CD;1230;840;;0;;1234567890;CX-1256;info1;info2;info3;; 01;3