Request File
The Request File for the Batch process details all the required deployment data and support across the different types of deployment, such as Generic, Air, Hotel and Rail.
The file can contain card requests for all card pools associated to a specific consumer.
File details
File Details | Required Information |
---|---|
File Name | yyyy-MM-dd-hhmmss_RQ_ConsumerFileID_v1.csv The ConsumerFileID is a unique value that should be provided by the Consumer. This section of the file name will be used to create the filename of the response file. |
Format | CSV. |
Header Record | No. |
Fixed Columns | Yes—All columns in the content definition must be included. Non-mandatory data can be left blank. |
Content
Column Name | Description | Index | Format | Quoted | Max Length | Required | Example |
---|---|---|---|---|---|---|---|
ConsumerReference | A unique reference provided by the consumer for the card deployment. | 1 | Alphanumeric | Y | 50 | Y | ABC13245DEF |
DeploymentID | If a DeploymentID is already known by the Consumer, set the value here to ensure the record is updated, rather than a new card deployed. | 2 | Numeric | N | 20 | N | 123456789 |
ClientID | The unique account number provided by Conferma. | 3 | Numeric | N | 10 | Y | 1234 |
Type | Details the type of Card Deployment being made: 3 = Generic 4 = Air 5 = Accommodation 6 = Rail | 4 | Numeric | N | 1 | Y | 4 |
CVVRequired | Is a CVV required in the response? 1= Yes 0 = No | 5 | Numeric | N | 1 | Y | 1 |
Name | Descriptive name for deployment. | 6 | Alphanumeric | Y | 50 | Y | MAN-LHR Flight |
Amount | The amount required on the payment card. | 7 | Decimal | Y | 10 | Y | 95.00 |
Currency | ISO 3-letter currency code the amount is in relation to. | 8 | Alpha | Y | 3 | Y | GBP |
ChargeStartDate | The date the card needs to be available from. | 9 | Date (yyyy-MM-dd) | N | 10 | Y | 2021-09-01 |
ChargeEndDate | The date the card needs to be available to. | 10 | Date (yyyy-MM-dd) | N | 10 | Y | 2021-09-01 |
CustomerID | A consumer defined customer ID. | 11 | Alphanumeric | Y | 50 | N | APPINK01 |
CustomerName | A consumer defined customer name. | 12 | Alphanumeric | Y | 50 | N | Test Company |
SupplierID | The customer's unique identifier for the supplier. | 13 | Alphanumeric | Y | 50 | N | APPLE1234 |
SupplierName | The name of the supplier taking payment. | 14 | Alphanumeric | Y | 100 | N | British AIrways |
SupplierAddress1 | Supplier address line 1. | 15 | Alphanumeric | Y | 100 | N | Small road |
SupplierAddress2 | Supplier address line 2. | 16 | Alphanumeric | Y | 100 | N | Big town |
SupplierCity | Supplier city name. | 17 | Alphanumeric | Y | 100 | N | Super city |
SupplierPostalOrZipCode | Supplier postal or zip code. | 18 | Alphanumeric | Y | 30 | N | M1 2BL |
SupplierCountryCode | ISO 2-letter country code. | 19 | Alpha | Y | 2 | N | GB |
SupplierTelephone | Supplier telephone number. | 20 | Alphanumeric | Y | 30 | N | 0161 123 4567 |
SupplierFax | Supplier fax number. | 21 | Alphanumeric | Y | 30 | N | 0161 123 4567 |
SupplierEmail | Supplier email address. | 22 | Alphanumeric | Y | 100 | N | [email protected] |
SupplierReference | Supplier's payment reference or invoice number. | 23 | Alphanumeric | Y | 50 | N | ABC1234D |
Identifiers | The customer identifiers of the deployment. Key~Value~ReportKey¬ format. Key = Name of value such as "Cost Centre".Value = Value of Key, such as "12345".ReportKey = Unique key for third parties usage. | 24 | Alphanumeric | Y | 50~200~50 | N | Cost Centre~123456~ DBI_COST¬Project Code~78 9654123~DBI_PRO |
Travellers | Declare the name of the travellers. Title~Forename~Surname¬ format. | 25 | Alphanumeric | Y | 10~30~30 | Y* | Mr~Stuart~Davenport¬ Ms~Abbi~Daniels |
AirOutboundSupplierCode | Two character airline code of airline running the flight. | 26 | Alphanumeric | Y | 2 | Y* | BA |
AirOutboundJourneyID | Flight number. | 27 | Numeric | Y | 10 | Y* | 5074 |
AirOutboundStartLocation | 3 character airport code. | 28 | Alphanumeric | Y | 3 | Y* | MAN |
AirOutboundStartDateTime | Departure date and time. | 29 | DateTime (yyyy-MM-dd hh:mm) | N | 16 | Y* | 2021-09-04 09:00 |
AirOutboundEndLocation | 3 character airport code. | 30 | Alphanumeric | Y | 3 | Y* | LHR |
AirOutboundEndDateTime | Arrival date and time. | 31 | DateTime (yyyy-MM-dd hh:mm) | N | 16 | Y* | 2021-09-04 10:15 |
AirReturnSupplierCode | Two character airline code of airline running the flight. | 32 | Alphanumeric | Y | 2 | Y* | BA |
AirReturnJourneyID | Flight number. | 33 | Numeric | Y | 10 | Y* | 5073 |
AirReturnStartLocation | 3 character airport code. | 34 | Alphanumeric | Y | 3 | Y* | LHR |
AirReturnStartDateTime | Departure date and time. | 35 | DateTime (yyyy-MM-dd hh:mm) | N | 16 | Y* | 2021-09-04 17:55 |
AirReturnEndLocation | 3 character airport code. | 36 | Alphanumeric | Y | 3 | Y* | MAN |
AirReturnEndDateTime | Arrival date and time. | 37 | DateTime (yyyy-MM-dd hh:mm) | N | 16 | Y* | 2021-09-04 19:05 |
HotelStayArrivalDate | Arrival date of hotel stay. | 38 | Date (yyyy-MM-dd) | N | 10 | Y* | 2021-09-05 |
HotelStayDepartureDate | Departure date of hotel stay. | 39 | Date (yyyy-MM-dd) | N | 10 | Y* | 2021-09-06 |
HotelRoomType | Room type. | 40 | Alphanumeric | Y | 30 | N | Single |
HotelRateInformation | Description of rate booked. | 41 | Alphanumeric | Y | 200 | N | Super saver rate including breakfast |
HotelRateBookingPlatform | Name of the system the booking was made. | 42 | Alphanumeric | Y | 50 | N | Sabre GDS |
HotelCancellationPolicy | Bookings cancellation policy. | 43 | Alphanumeric | Y | 200 | N | Cancel by 12pm day of arrival. |
HotelCancellationReference | Cancellation reference. | 44 | Alphanumeric | Y | 30 | N | CNX12345 |
HotelContactName | Name of contact. | 45 | Alphanumeric | Y | 100 | N | Steve Jones |
HotelCareOfName | Name of the company staying at hotel. UK TOMS requirement. | 46 | Alphanumeric | Y | 200 | N | Demo Corp. |
HotelPaymentInstruction | Payment instructions related to the hotel stay. | 47 | Alphanumeric | Y | 200 | N | Full account |
HotelComments | Hotel special requirements. | 48 | Alphanumeric | Y | 4000 | N | Ground floor room required. |
RailOutboundStartLocation | Departure station name. | 49 | Alphanumeric | Y | 50 | Y* | Manchester Piccadilly |
RailOutboundStartDateTime | Departure date and time. | 50 | DateTime (yyyy-MM-dd hh:mm) | N | 16 | Y* | 2021-09-04 17:55 |
RailOutboundEndLocation | Arrival station name. | 51 | Alphanumeric | Y | 50 | Y* | London Euston |
RailOutboundEndDateTime | Arrival date and time. | 52 | DateTime (yyyy-MM-dd hh:mm) | N | 16 | Y* | 2021-09-04 20:10 |
RailOutboundOperatorName | Operator name. | 53 | Alphanumeric | Y | 50 | N | Avanti West Coast |
RailOutboundTicketCost | Ticket cost. Relates to Currency field. | 54 | Decimal | N | 10 | Y* | 50.00 |
RailOutboundTicketClass | Class of ticket: E = Economy P = Premium Economy B = Business F = First | 55 | Alpha | N | 1 | Y* | B |
RailOutboundTicketDescription | Description of ticket. | 56 | Alphanumeric | Y | 100 | N | Advance single Coach B Seat 2A |
RailReturnStartLocation | Departure station name. | 57 | Alphanumeric | Y | 50 | Y* | London Euston |
RailReturnStartDateTime | Departure date and time. | 58 | DateTime (yyyy-MM-dd hh:mm) | N | 16 | Y* | 2021-09-05 10:00 |
RailReturnEndLocation | Arrival station name. | 59 | Alphanumeric | Y | 50 | Y* | Manchester Piccadilly |
RailReturnEndDateTime | Arrival date and time. | 60 | DateTime (yyyy-MM-dd hh:mm) | N | 16 | Y* | 2021-09-05 12:20 |
RailReturnOperatorName | Operator name. | 61 | Alphanumeric | Y | 50 | N | Avanti West Coast |
RailReturnTicketCost | Ticket cost. Relates to Currency field. | 62 | Decimal | N | 10 | Y* | 50.00 |
RailReturnTicketClass | Class of ticket: E = Economy P = Premium Economy B = Business F = First | 63 | Alpha | N | 1 | Y* | B |
RailReturnTicketDescription | Description of ticket. | 64 | Alphanumeric | Y | 100 | N | Advance single Coach B Seat 2A |
SendPaymentEmail | User should provide 1 to issue email, 0 to not. | 65 | Numeric | N | 1 | Y | 1 |
SendPaymentFax | User should provide 1 to issue fax, 0 to not. | 66 | Numeric | N | 1 | Y | 1 |
Y* conditional fields only required when combined with the appropriate travel spend type e.g. air data must be provided when the deployment type = air(4).
Updated 10 months ago