railcards-eapi
home
Page Content
- Terminology
- Validate a Railcard
- Valid Railcard Types
Terminology
The following are key terms used throughout this documentation:
| Term | Description |
|---|---|
| Station Issued Railcards | These Railcards have been issued at a Station these have a short character Railcard Number (~5 characters) |
| Retailer Issued Railcards | These Railcards have been issued via a Retailer and have a longer Railcard Number (~15-16 characters) |
Validate a Railcard
Resource: /railcards/{railcardNumber}/expiry
This resource will allow the consumers to check whether the Railcard is stored within the Railcard system by matching the requested details and checking the Railcard status. If the Railcard search conditions are met, the system will return the confirmed expiry date of the Railcard. It is the responsibility of the consumers to check whether that Railcard can be used for the selected journey based on relevant business rules.
Both Station Issued and Retailer Issued Railcards can be validated.
In order to check a Railcards validity the system will check:
Railcard Type is supported
Railcard details match those stored
* Status of the stored Railcard is classed as "valid"
If the received Railcards details meet the above criteria the system will return the Railcard expiry date, otherwise a "not found" or an error will be returned.
Railcard Type
Not all Railcards can be validated by the system, for example, Regional Railcards are not stored within the system and therefore can’t be validated. The system will check whether the Railcard Type can be processed and return an error if the Railcard is not supported.
For a list of valid Railcard Type see section "Reference Data" below
Railcard Details
Railcard holders last name must be present in the request.
If the Railcard details do not meet the required criteria the system will return a "not found" response.
Railcard Status
The system will check the status to ensure this is valid. If the status is invalid a "not found" response will be returned.
Reference Data
Valid Railcard Types
The following table contains the valid Railcard Types accepted by the service:
| Railcard Type | Description |
|---|---|
| 2TR | Two Together Railcard |
| DIS | Disabled Persons Railcard |
| FAM | Family & Friends Railcard |
| NEW | Network Railcard |
| SRN | Senior Railcard |
| TST | 26-30 Railcard |
| TSU | 16-17 Saver |
| VET | Veterans Railcard |
| YNG | 16-25 Railcard |
Last update: 02-Feb-2023 11.30: ASSIST API Documentation Maintenance: railcards-eapi | Version: v1 | Page: Home | Revision: A.
To request updates to this text please contact Neil Barkham.