Visa Travel Notification Service API Reference
Visa Travel Notification Service
Visa Travel Notification API
Incorporate cardholder self-reported travel into your authorization decisions
Update Travel Itinerary v1 - Latest
Update Travel Itinerary allows you to update details of existing travel itineraries. A successful response includes confirmation that the update was successful, which user made the update, and when the update occurred. You will use this API when you need to make changes to an existing travel itinerary, such as when a cardholder informs you the plan has changed.
Request
Request Body schema: application/json
| departureDate required |
string^([0-9]{4}-(0[1-9]{1} |
| destinations required |
Array of objects |
| --- | --- |
| country required |
string^([0-9]{1,3})$ The country where your cardholder will travel. If your cardholder will travel to multiple countries, you can include multiple countries in a single request. Must be a 3 character country code, as specified in the ISO 3166-1. |
| state | string^([A-Z][A-Z])$ The state or province where your cardholder will travel… |
| primaryAccountNumbers required |
Array of objects |
| --- | --- |
| cardAccountNumber | string^([0-9]{16,19})$ Card Account Number holds the numeric PAN and PAN should always be between 16 - 19 digits |
| returnDate required |
string^([0-9]{4}-(0[1-9]{1} |
| travelItineraryId required |
string^([A]?[0-9]{1,19})$ Itinerary ID for the travel plan stored in the system. |
| partnerBid | string^([0-9]{8})$ Your Visa Business Identifier (BID). This field is required for OBO issuer or third part resellers. |
| userId | string User ID you assigned to identify the cardholder using the service. |
Responses
200
UpdateTravelItinerary response
Response Schema: application/json
| failureCode | string Error code specific for CRUD operations |
| failureDescription | string Error description specific for CRUD operations |
| responseCode | string Web service response code |
| responseMessage | string service response text specific for CRUD operations |
| travelItinerary | object An itinerary detail |
| --- | --- |
| departureDate required |
string^([0-9]{4}-(0[1-9]{1} |
| destinations required |
Array of objects |
| Array | |
| --- | --- |
| country required |
string^([0-9]{1,3})$ The country where your cardholder will travel. If your cardholder will travel to multiple countries, you can include multiple countries in a single request. Must be a 3 character country code, as specified in the ISO 3166-1. |
| state | string^([A-Z][A-Z])$ The state or province where your cardholder will travel… |
| lastUpdatedBy required |
string^([A-Z][0-9][a-z]{1,50})$ User who updated the itinerary in current state. |
| partnerBid required |
string^([0-9]{8})$ Your Visa Business Identifier (BID). |
| primaryAccountNumbers required |
Array of objects |
| Array | |
| --- | --- |
| cardAccountNumber | string^([0-9]{16,19})$ Card Account Number holds the numeric PAN and PAN should always be between 16 - 19 digits |
| source required |
string The source of the travel itinerary in the Visa system. When a travel itinerary is submitted to Visa through the Visa Travel Notification Service, the Source field in the response will be Cardholder Self Reported. |
| travelItineraryId required |
string^([A]?[0-9]{1,19})$ Itinerary ID for the travel plan stored in the system. |
| lastUpdateTime | string Time in format YYYY-MM-DDTHH:MM:SS. |
| returnDate | string^([0-9]{4}-(0[1-9]{1} |
| userId | string User ID you assigned to identify the cardholder using the service. |
202
Validation Failures
Response Schema: application/json
| responseCode required |
string Service response code Enum:"0""5""10""15""20" Example: "0" |
| responseMessage required |
string Service response text specific for CRUD operations Example: "Successfully processed" |
400
Bad Request
Response Schema: application/json
string
403
Forbidden Operation to requested resource
Response Schema: application/json
string
404
Server has not found anything matching the request URI
Response Schema: application/json
string
500
Temporary Downtime - retry operation after waiting
Response Schema: application/json
string
503
Temporary Downtime for maintenance - retry operation after waiting
Response Schema: application/json
string
Error Codes
| Status | Code | Description |
|---|---|---|
| 503 | Temporary Downtime for maintenance - retry operation after waiting | |
| 202 | 14 | Account is not valid. |
| 202 | 20 | Validation Failed. [899_CA is not a valid destination.] |
| 202 | 20 | Validation Failed. [Return Date must be after or same as Departure Date] |
| 202 | 5 | Partner BID is not enabled for this service. |
| 202 | 11 | The VDP Application Name is not associated to the Partner BID in the request. Please contact VDP Support. |
| 404 | Server has not found anything matching the request URI | |
| 403 | Forbidden Operation to requested resource | |
| 500 | Temporary Downtime - retry operation after waiting | |
| 400 | Bad Request |
put/travelnotificationservice/v1/travelnotification/itinerary
Request samples
- Payload
application/json
{"updateTravelItinerary": {"returnDate": "2016-04-28","partnerBid": "10074101","travelItineraryId": "2312","destinations": [{"country": "840","state": "CA"}],"primaryAccountNumbers": [{"cardAccountNumber": "4645191800301236"},{"cardAccountNumber": "4645191800301237"}],"departureDate": "2016-04-21","userId": "rajpande"}}
Response samples
- 200
- 202
- 400
- 403
- 404
- 500
- 503
{"updateTravelItineraryResponse": {"responseCode": "0","responseMessage": "Success Transaction","travelItinerary": {"source": "Cardholder Self-Reported","userId": "rajpandey","partnerBid": "10074101","returnDate": "2016-04-28","destinations": [{"state": "CA","country": "840"}],"departureDate": "2016-04-21","lastUpdatedBy": "rajpandey","lastUpdateTime": "2016-04-04","travelItineraryId": "2313","primaryAccountNumbers": [{"cardAccountNumber": "4645191800301236"},{"cardAccountNumber": "4645191800301237"}]}}}