Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"category"
],
"properties": {
"tfl": {
"anyOf": [
{
"type": "object",
"required": [
"card_last4",
"period_start",
"period_end",
"journeys"
],
"properties": {
"journeys": {
"type": "array",
"items": {
"type": "object",
"required": [
"date",
"start_time",
"end_time",
"mode",
"from_location",
"to_location",
"bus_route",
"fare_pence",
"is_max_fare",
"is_incomplete"
],
"properties": {
"date": {
"type": "string",
"description": "Journey date as YYYY-MM-DD."
},
"mode": {
"enum": [
"tube",
"bus",
"overground",
"elizabeth",
"dlr",
"tram",
"cable_car",
"thameslink",
"unknown"
],
"type": "string",
"description": "Transport mode for this row, or \"unknown\" when the statement does not say."
},
"end_time": {
"type": [
"string",
"null"
],
"description": "Tap-out time as HH:MM, or null."
},
"bus_route": {
"type": [
"string",
"null"
],
"description": "Bus route number for bus rows, otherwise null."
},
"fare_pence": {
"type": "integer",
"maximum": 100000,
"minimum": 0,
"description": "Charge for this row in pence. £2.20 = 220."
},
"start_time": {
"type": [
"string",
"null"
],
"description": "Tap-in time as HH:MM, or null."
},
"is_max_fare": {
"type": "boolean",
"description": "True if the statement labels this as a max-fare charge for a failed revenue inspection."
},
"to_location": {
"type": [
"string",
"null"
],
"description": "Tap-out station / stop name, or null for incomplete journeys."
},
"from_location": {
"type": [
"string",
"null"
],
"description": "Tap-in station / stop name, or null if not shown."
},
"is_incomplete": {
"type": "boolean",
"description": "True if this journey has no tap-out recorded (e.g. label \"Incomplete\" or \"No exit\")."
},
"is_hopper_free": {
"type": [
"boolean",
"null"
],
"description": "Optional. True when the statement shows this fare as a free Hopper fare (a second bus or tram within 60 minutes)."
},
"is_daily_cap_hit": {
"type": [
"boolean",
"null"
],
"description": "Optional. True when the statement marks this row as the one where the daily cap was reached."
},
"is_auto_corrected": {
"type": [
"boolean",
"null"
],
"description": "Optional. True when the statement says TfL has already corrected this journey (for example \"Auto-completed\" or \"Adjusted\")."
},
"is_weekly_cap_hit": {
"type": [
"boolean",
"null"
],
"description": "Optional. True when the statement marks this row as the one where the weekly cap was reached."
},
"intended_destination": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
],
"description": "Optional, for an incomplete journey with no touch out: the station the person was travelling to. With it, the refund is estimated as the fare charged minus the usual fare to that station. Without it, the figure is an upper limit equal to the whole charge."
}
},
"additionalProperties": false
},
"maxItems": 500,
"minItems": 1,
"description": "Every journey on the statement. Up to 500 per call."
},
"card_last4": {
"type": [
"string",
"null"
],
"description": "Last 4 digits of the contactless card, if shown."
},
"period_end": {
"type": [
"string",
"null"
],
"description": "Statement period end date YYYY-MM-DD."
},
"period_start": {
"type": [
"string",
"null"
],
"description": "Statement period start date YYYY-MM-DD."
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"description": "For category \"tfl\": the journeys, in the shape a TfL check returns in save_claim.arguments.tfl."
},
"train": {
"anyOf": [
{
"type": "object",
"required": [
"ticket_price_pence",
"ticket_type",
"booking_reference",
"legs"
],
"properties": {
"legs": {
"type": "array",
"items": {
"type": "object",
"required": [
"operator_toc_code",
"departure_station",
"arrival_station",
"scheduled_departure",
"scheduled_arrival"
],
"properties": {
"delay_minutes": {
"anyOf": [
{
"type": "integer",
"maximum": 1440,
"minimum": 0
},
{
"type": "null"
}
],
"description": "Optional. Delay at arrival for this journey, in minutes, if known. When left out, Untap looks it up in National Rail records."
},
"was_cancelled": {
"type": [
"boolean",
"null"
],
"description": "Optional. True when this journey was cancelled. When set, no National Rail lookup is made."
},
"actual_arrival": {
"type": [
"string",
"null"
],
"description": "Optional. Actual arrival for this journey as an ISO 8601 datetime, if known. When left out, Untap looks it up."
},
"arrival_station": {
"type": "string",
"minLength": 1,
"description": "Full arrival station name, e.g. \"Edinburgh Waverley\"."
},
"departure_station": {
"type": "string",
"minLength": 1,
"description": "Full departure station name, e.g. \"London Kings Cross\"."
},
"operator_toc_code": {
"enum": [
"VT",
"CC",
"CH",
"EM",
"GX",
"GN",
"GW",
"LE",
"NT",
"SW",
"SE",
"SN",
"TL",
"TP",
"AW",
"LM",
"LN",
"XC",
"GR",
"SR",
"LD",
"HT",
"CS"
],
"type": "string",
"description": "National Rail two-letter operator code for this journey: VT=Avanti West Coast, CC=c2c, CH=Chiltern Railways, EM=East Midlands Railway, GX=Gatwick Express, GN=Great Northern, GW=Great Western Railway, LE=Greater Anglia, NT=Northern Trains, SW=South Western Railway, SE=Southeastern, SN=Southern, TL=Thameslink, TP=TransPennine Express, AW=Transport for Wales, LM=West Midlands Railway, LN=London Northwestern Railway, XC=CrossCountry, GR=LNER, SR=ScotRail, LD=Lumo, HT=Hull Trains, CS=Caledonian Sleeper"
},
"scheduled_arrival": {
"type": "string",
"description": "Scheduled arrival as ISO 8601 datetime."
},
"scheduled_departure": {
"type": "string",
"description": "Scheduled departure as ISO 8601 datetime."
}
},
"additionalProperties": false
},
"maxItems": 8,
"minItems": 1,
"description": "Each journey on this booking, in travel order: one for a single, two for a return (outward first), more for a multi-stop booking. Untap works out Delay Repay for each journey and adds them up."
},
"season_type": {
"anyOf": [
{
"enum": [
"weekly",
"monthly",
"quarterly",
"six_monthly",
"annual",
"flexi"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Season tickets only: how long the season runs. The operator divides the season price into single journeys (for example annual 464, monthly 40, weekly 10, flexi 16) and pays a share of one journey. When left out, the result gives the percentage and the method but no amount."
},
"ticket_type": {
"enum": [
"single",
"return",
"open_return",
"advance",
"anytime",
"off_peak",
"super_off_peak",
"season",
"other"
],
"type": "string",
"description": "Ticket type as printed. For \"return\" and \"open_return\" the single fare is half the price paid; for \"season\" the amount is a share of one journey value (see season_type); every other type uses the full price as the single fare."
},
"booking_reference": {
"type": [
"string",
"null"
],
"description": "Booking reference if available, otherwise null."
},
"ticket_price_pence": {
"type": "integer",
"maximum": 1000000,
"minimum": 1,
"description": "Total fare paid in pence for the whole booking. £62.00 = 6200."
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"description": "For category \"train\": the train booking, in the shape a train check returns in save_claim.arguments.train, with ticket_price_pence set."
},
"flight": {
"anyOf": [
{
"type": "object",
"required": [
"airline_iata",
"flight_number",
"departure_iata",
"arrival_iata",
"scheduled_departure",
"scheduled_arrival",
"ticket_price_pence",
"booking_reference",
"passenger_name"
],
"properties": {
"status": {
"anyOf": [
{
"enum": [
"on_time",
"delayed",
"cancelled",
"denied_boarding"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Optional. What happened to the flight, if known. When left out, Untap looks the flight up in AeroDataBox flight-status records."
},
"airline_iata": {
"type": "string",
"maxLength": 2,
"minLength": 2,
"description": "Two-letter IATA airline code, e.g. \"BA\" for British Airways, \"U2\" for easyJet."
},
"arrival_iata": {
"type": "string",
"maxLength": 3,
"minLength": 3,
"description": "Three-letter IATA arrival airport code, e.g. \"BCN\"."
},
"delay_minutes": {
"anyOf": [
{
"type": "integer",
"maximum": 2880,
"minimum": 0
},
{
"type": "null"
}
],
"description": "Optional. Arrival delay in minutes, if known."
},
"flight_number": {
"type": "string",
"description": "Flight number including the airline prefix, e.g. \"BA2551\"."
},
"actual_arrival": {
"type": [
"string",
"null"
],
"description": "Optional. Actual arrival as an ISO 8601 datetime, if known."
},
"departure_iata": {
"type": "string",
"maxLength": 3,
"minLength": 3,
"description": "Three-letter IATA departure airport code, e.g. \"LHR\"."
},
"passenger_name": {
"type": [
"string",
"null"
],
"description": "Passenger name as printed on the ticket, or null if not visible."
},
"booking_reference": {
"type": [
"string",
"null"
],
"description": "PNR / airline booking reference if available, otherwise null."
},
"scheduled_arrival": {
"type": "string",
"description": "Scheduled arrival as ISO 8601 datetime."
},
"ticket_price_pence": {
"type": "integer",
"maximum": 50000000,
"minimum": 1,
"description": "Total fare paid in pence."
},
"scheduled_departure": {
"type": "string",
"description": "Scheduled departure as ISO 8601 datetime."
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"description": "For category \"flight\": the flight, in the shape a flight check returns in save_claim.arguments.flight, with ticket_price_pence set."
},
"category": {
"enum": [
"train",
"flight",
"tfl"
],
"type": "string",
"description": "Which kind of check the claim came from."
}
},
"additionalProperties": false
}