Transaction

We plan on adding a new route to our API, specifically for transactions made by our partners. The goal is to enable a secure exchange of metadata regarding their customers' journey.

This route is under development, this page will soon me updated with the complete scheme.

Request

POST  https://connect.visamundi.io/v3/partner/{name}/transaction

In this request, {name} must be replaced by your identifier. This, in combination with your API key, will allow you to obtain the desired information.

Parameters of the request

Parameter		Description
`access_token`	Required	The key to authenticate you to the API. Learn more about the API key
`language`	Optional	Learn more about available languages

Body of the request

Required fields

There are 5 required fields: external_identifier, booking_email, journey.arrival_date, journey.destination.cca3 and journey.metrics.external_services.

Below you will find a description of the five required fields.

Value	Description
`external_identifier`	Represents your identifier or username given when creating your account.
`booking_email`	The email address used for the flight booking, we only accept one valid email address.
`arrival_date`	Date in ISO 8601 YYYY-MM-DD format.
`cca3`	3-letter country code also known as ISO 3166-1 alpha-3 code. Example: IND for India.
`external_services`	Boolean to give us permission to offer our additional services (insurance, compensation). By default the value is false.

Optional fields

Value	Description
`cca2`	2-letter country code also known as ISO 3166-1 alpha-2 code. Example: IN for India.
`iata`	3-letter code assigned to each airport around the world.
`icao`	4-letter code assigned to each airport around the world.
`travellers_count`	Total number of travellers.
`journey_duration`	Total duration of the trip in days. Example: 3 for a trip lasting three days.
`currency_display`	The currency displayed on the form sent to travellers. You can choose between these five currencies: EUR, GBP, CAD, USD, XOF. "EUR" is selected by default.
`language`	The display language of the form sent to travellers. You can choose between these five languages: fr, en, de, es, it, pt. "en" is selected by default.
`departure_date`	The departure date of travelers in ISO 8601 format (YYYY-MM-DD).
`home_departure_date`	The date of departure from the travelers' home, this allows us to plan in case of transit.
`travellers`	Array of objects containing some data concerning the travellers.
`id`	The traveller's index in the array.
`full_name`	Full name of the traveller.
`nationality`	Nationality of the traveler in ISO 3166-1 alpha-3 format.
`birthdate`	Traveler's date of birth in ISO 8601 format (YYYY-MM-DD).
`booking_id`	The booking ID of the transaction.
`payment_timestamp`	ISO 8601 payment timestamp (YYYY-MM-DD’T’hh:mm:ssTZD)
`sales_channel`	Sales channel used for the transaction. You can choose between web, mobile or physical. No default value.
`client_type`	Type of customer who made the transaction. You can choose between individuals or corporate. No default value.

{
  "external_identifier": "<string>", // required
  "booking_email": // required,
  "journey": {
    "arrival_date": "<string>", // required
    "destination": {
      "cca3": "<string>", // required
      "cca2": "<string>",
      "iata": "<string>",
      "icao": "<string>"
    },
    "metrics": {
      "external_services": "<boolean>", // required
      "travellers_count": "<integer>",
      "journey_duration": "<integer>",
      "currency_display": "<string>",
      "language": "<string>"
    },
    "departure_date": "<string>",
    "home_departure_date": "<string>",
    "origin": {
      "cca2": "<string>",
      "cca3": "<string>",
      "iata": "<string>",
      "icao": "<string>"
    },
    "travellers": [
      {
        "id": "<string>",
        "full_name": "<string>",
        "nationality": "<string>",
        "birthdate": "<string>"
      },
      {
        "id": "<string>",
        "full_name": "<string>",
        "nationality": "<string>",
        "birthdate": "<string>"
      }
    ]
  },
  "booking_id": "<string>",
  "payment_timestamp": "<string>",
  "metadata": {
    "sales_channel": "call_center",
    "client_type": "<string>"
  }
}

Codes and error messages

In addition to the API error codes and messages, this endpoint may return certain other codes and messages:

StatusCode	Code	Description
`200`	no_country_found	« No country found » The request went well but the countries passed with the parameters `nationality` or `destination` n’ont pas été trouvé.
`400`	required_parameters_error	« Missing or incorrect required parameters » The parameter `{name}` were not sent with the request or do not follow the expected format.
`400`	invalid_request_body	« Invalid request body. Body should not be an array but an object. » The request body is invalid. The request body cannot be a list, only an object.
`403`	forbidden	« Partner ID and API key do not match » The parameter `{name}` in the endpoint url does not match the authentication key.
`404`	user_not_found	« User not found » User wasn't found in the database.

API Endpoints