See the following sections for descriptions of Initialize request parameters:

For Initialize sample code, see Initialize.

`initialize-payment`

Parent: root

The initialize-payment element is required, and it has the following attributes:

Parameter	Format	Requirement	Description
`account`	Integer	Optional	The unique ID associated with a payment transaction. If you omit this parameter, the payment transaction is associated with the default sub-account.
`client-id`	Integer	Required	The unique ID configured for a merchant on the Velocity POP.

`transaction` object

Parents: root: initialize-payment

Below is reference information for the transaction element and its child elements.

`transaction`

Parents: root: initialize-payment

The transaction element is required, and it has the following attributes:

Parameter	Format	Requirement	Description
`order-no`	AN String	Required	The order ID that a merchant generates. Note: Some payment providers have strict guidelines for `order-no`. The recommended pattern is `"[a-zA-Z0-9._-]`.
`type-id`	Integer	Optional	The type of transaction used for making payment. Velocity supports the transaction types found in the `type-id` Transaction Types table below.
`session-id`	Integer	Optional	The ID of a session used for multiple payment transactions during one payment flow. For example, this is used in a subsequent Initialize request during a split payment or in a retry of a failed payment transaction. Note: A split abandoned payment occurs when a customer starts a new transaction and abandons a current split payment. In this case, the `session-id` value is sent back in the Initialize request with the full amount.
`product-type`	Integer	Optional	The numeric code for the type of product purchased in this transaction: • `100` - Ticket • `200` - Ancillary • `210` - Insurance
`booking-ref`	String	Optional	The airline Reservation Booking Designator (RBD), or the first letter of fare class; for example, `H`.

`type-id` Transaction Types

Velocity supports the following transaction types (used to define type-id):

Value	Transaction types	Examples
`1`	Online shopping	S&B Purchase
`2`	Offline shopping	S&B Purchase
`3`	Self Service Online	MYB Ancillary Purchase, MYB Change Itinerary Payment, OLCI Ancillary Purchase
`4`	Self Service Offline	MYB Pay Later
`5`	Self Service Online	MYB/Self Service Online with additional rules on FOP-- Managed Booking txn where additional rules on FOP can be configured
`6`	Self Service Online	CPL - Payment Link Transaction. Transaction originated from payment link.

`amount`

Parents: root: initialize-payment: transaction

The amount element is required, and it has the following attributes:

Parameter	Format	Requirement	Description
`country-id`	Integer	Required	The CellPoint Digital-specific country code. This is available in Reference.
`currency-id`	Integer	Optional	The currency configured for a country. This depends on the configuration available through Velocity.

The amount element has the following text content:

Parameter	Format	Requirement	Description
amount	Integer	Required	The total amount a customer is charged for a payment transaction in the specified country’s smallest currency. For example, the smallest currency of USD is the penny. If the transaction amount is $120.30, then the text content of `amount` is `12030`.

`fees`

Parents: root: initialize-payment: transaction

Please note:

The fees element is optional; it describes additional fees if applicable for the transaction, such as an administrative fee for an offline payment or 'pay later.'
The fees element can have multiple fee children.

Each fee child element has the following attributes:

Parameter	Format	Requirement	Description
`country-id`	Integer	Conditional Requirement: Required if fees is sent.	The CellPoint Digital-specific country code. This is available in Reference.
`currency-id`	Integer	Optional	The currency code for the fee. This is available in Reference.

Each fee element has the following text content:

Parameter	Format	Requirement	Description
fee	Integer	Conditional Requirement: Required if fees is sent.	The total amount a customer is charged for a payment transaction in the specified country’s smallest currency. For example, the smallest currency of USD is the penny. If the transaction amount is $120.30, then the text content of `amount` is `12030`.

`callback-url`

Parents: root: initialize-payment: transaction

The callback-url element is optional, and it has the following text content:

Parameter	Format	Requirement	Description
callback URL	String, in a URL format	Optional	The absolute URL to the back office of a merchant where Velocity POP sends the payment status. Note: If you do not provide this parameter, Velocity uses the default URL.

`accept-url`

Parents: root: initialize-payment: transaction

The accept-url element is optional, and it has the following text content:

Parameter	Format	Requirement	Description
accept URL	String, in a URL format	Optional	The URL where Velocity directs a customer after successfully completing a payment transaction. The URL is used for redirecting to either the HPP or merchant’s page after a payment completion. Note: If you do not provide this parameter, Velocity uses the default URL.

`cancel-url`

Parents: root: initialize-payment: transaction

The cancel-url element can be mandatory or optional, based on the integration type, and it has the following text content:

Parameter	Format	Requirement	Description
cancel URL	String, in a URL format	Conditional requirement: This can be mandatory or optional, based on the integration type.	The absolute URL where Velocity directs customers if they cancel a payment transaction midway. The URL is used for redirecting to either the HPP or merchant’s page after a payment cancellation. Note: If you do not provide this parameter, Velocity uses the default URL.

`decline-url`

Parents: root: initialize-payment: transaction

The decline-url element is optional, and it has the following text content:

Parameter	Format	Requirement	Description
decline URL	String, in a URL format	Optional	The absolute URL where Velocity directs customers if the payment transaction fails. The URL is used for redirecting to either the HPP or merchant’s page after a payment failure.

`auth-url`

Parents: root: initialize-payment: transaction

The decline-url element is optional, and it has the following text content:

Parameter	Format	Requirement	Description
auth URL	String, in a URL format	Optional	The URL used for single sign-on (SSO) authentication if provided by an external system.

`service-type-id`

The service-type-id element is optional, and it has the following text content:

Parameter	Format	Requirement	Description
Exchange Service ID	Integer	Optional	A value to indicate the type of exchange services used for a transaction. The ID indicates if the FX services such as DCC, MCP, and PCC are opted. The ID is a two-digit number XY in which: X - Represents the type of FX used in a transaction. Y - Represents the service used-- it can be: Opt-in, which has value as `1` Opt-out, which has value as `2` The Exchange Service ID table shows the possible values of exchange service ID.

`hmac`

Parents: root: initialize-payment: transaction

The hmac element is required, and it contains the following text content:

Parameter	Format	Requirement	Description
MAC	String	Required	The Message Authentication Code (MAC). It is calculated by creating a SHA-512 hash comprising the input fields in the order listed in the Message Authentication Code table. MAC calculation secures the information sent by the merchant to Velocity by applying the SHA-512 encryption algorithm on key parts of the information sent to protect against tampering. The "salt" is the merchant's shared secret string used to ensure that the MAC is unique. Note: CellPoint Digital provides the salt value to merchants. Conditional Parameters are optional in `hmac` if they are not provided in request; if those parameters are present in the request, they are mandatory in `hmac`.

`additional-data`

Parents: root: initialize-payment: transaction

Please note:

The additional-data element is optional; it contains additional information about the transaction.
The additional-data element may contain multiple param children.

Each param child element has the following attribute:

Parameter	Format	Requirement	Description
`name`	String	Optional	The type of additional data being provided in the `param` text content. For example, use `merchant_payment_ref` to pass the merchant's payment reference information.

Each param child element has the following text content:

Parameter	Format	Requirement	Description
param	String, up to 20 AN	Optional	The value of the parameter defined in `name`.

`orders`

Parents: root: initialize-payment: transaction

Please note:

The orders element is optional; it is used to display booking information such as Airline Itinerary Data (AID).
The orders element contains the objects shipping-address and line-item; see their descriptions below.

`shipping-address`

Parents: root: initialize-payment: transaction: orders

The shipping-address element is optional; it defines the customer's mailing address.

The shipping-address element has the following children:

Element	Requirement	Format of text content	Description of text content
`name`	Conditional Requirement: Required if `shipping-address` is present.	String	The customer's name. Note: This parameter is used by qualifying merchants to display order data.
`street`	Conditional Requirement: Required if `shipping-address` is present.	String	The first line of the customer's street address. Note: This parameter is used by qualifying merchants to display order data.
`street2`	Conditional Requirement: Required if `shipping-address` is present.	String	The second line of the customer's street address. Note: This parameter is used by qualifying merchants to display order data.
`city`	Conditional Requirement: Required if `shipping-address` is present.	String	The city in the customer's mailing address. Note: This parameter is used by qualifying merchants to display order data.
`state`	Conditional Requirement: Required if `shipping-address` is present.	String	The state in the customer's mailing address. Note: This parameter is used by qualifying merchants to display order data.
`zip`	Conditional Requirement: Required if `shipping-address` is present.	Integer	The zip code or postal code for the customer's mailing address. Note: This parameter is used by qualifying merchants to display order data.
`country`	Conditional Requirement: Required if `shipping-address` is present.	Integer	The ISO numeric country code. Note: This parameter is used by qualifying merchants to display order data.

`line-item`

Parents: root: initialize-payment: transaction: orders

The line-item element is required in the orders element. It contains six children: product, amount, points, reward, quantity, and additional-data. Find the description of each child element below.

`product`

Parents: root: initialize-payment: transaction: orders: line-item

The product element is required in the orders element. It provides detailed information of a travel itinerary such as fare, traveler, and trip information. It has three children: name, description, and airline-data.

The product element has the following text content:

Parameter	Format	Requirement	Description
`sku`	Integer	Conditional Requirement: Required if `orders` is present.	The short code for the booking information. For example, PNR and order number. Note: This parameter is used by qualifying merchants to display order data.

`name`

Parents: root: initialize-payment: transaction: orders: line-item: product

The name element is required in the orders element, and it has the following text content:

Parameter	Format	Requirement	Description
name	String	Conditional Requirement: Required if `orders` is present.	The name of a journey or booking. For example, `ONEWAY`, `RETURN`, `MULTICITY`, `MYB`, and `OLCI`. Note: This parameter is used by qualifying merchants to display order data.

`description`

Parents: root: initialize-payment: transaction: orders: line-item: product

The description element is optional, and it has the following text content:

Parameter	Format	Requirement	Description
description	String	Optional	A description of the travel itinerary or booking. Note: This parameter is used by qualifying merchants to display order data.

`image-url`

Parents: root: initialize-payment: transaction: orders: line-item: product

The image-url element is optional, and it has the following text content:

Parameter	Format	Requirement	Description
URL	String	Optional	An image URL of the product. Note: This parameter is used by qualifying merchants to display order data.

`airline-data`

Parents: root: initialize-payment: transaction: orders: line-item: product

The airline-data element is optional; it provides detailed information of the travel itinerary such as fare information, traveler information, and trip information. It has five children: amount, fees, trips, profiles, and billing-summary.

The airline-data element has the following attributes:

Parameter	Format	Requirement	Description
`order-type`	String	Optional	The type of order. Note: This parameter is used for airline data only.
`order-no`	String	Optional	The order number used for the transaction. Note: This parameter is used for airline data only.

`amount`

Parents: root: initialize-payment: transaction: orders: line-item: product: airline-data

The amount element is required when the airline-data element is present, and it has the following attributes:

Parameter	Format	Requirement	Description
`decimals`	Integer	Optional	The number of decimal points shown for a currency. Note: This parameter is used for airline data only.
`currency-id`	Integer	Optional	The currency configured for a country. This depends on the configuration available through Velocity. Note: This parameter is used for airline data only.
`currency`	String	Optional	The three-letter code for the currency used. Note: This parameter is used for airline data only.
`symbol`	String	Optional	The symbol used to indicate the currency used. Note: This parameter is used for airline data only.
`format`	String	Optional	The format in which the amount is presented. Note: This parameter is used for airline data only.
`country-id`	Integer	Conditional Requirement: Required if `airline-data` is present.	The CellPoint Digital-specific country code for the country whose currency is used. This is available in Reference. Note: This parameter is used for airline data only.

The amount element has the following text content:

Parameter	Format	Requirement	Description
amount	Integer	Conditional Requirement: Required if `airline-data` is present.	The total amount a customer is charged for this order in the specified country’s smallest currency. For example, the smallest currency of USD is the penny. If the transaction amount is $120.30, then the text content of `amount` is `12030`. Note: This parameter is used for airline data only.

`fees`

Parents: root: initialize-payment: transaction: orders: line-item: product: airline-data

The fees element is optional, and it may have multiple fee children.

Each fee child element has the following attributes:

Parameter	Format	Requirement	Description
`format`	String	Optional	The format in which this session's total amount is presented. Note: This parameter is used for airline data only.
`symbol`	String	Optional	The symbol that indicates the currency used. Note: This parameter is used for airline data only.
`currency`	String	Optional	The three-letter code for the currency used. Note: This parameter is used for airline data only.
`country-id`	Integer	Conditional Requirement: Required if `fee` is present.	The CellPoint Digital-specific country code for the country whose currency is used. This is available in Reference. Note: This parameter is used for airline data only.
`type-id`	Integer	Optional	The type of transaction used for making payment. Velocity supports the transaction types found in the `type-id` Transaction Types table above. Note: This parameter is used for airline data only.

Each fee child element has the following text content:

Parameter	Format	Requirement	Description
amount	Integer	Conditional Requirement: Required if `fee` is present.	The amount of this fee in the specified country’s smallest currency. For example, the smallest currency of USD is the penny. If the transaction amount is $120.30, then the text content of `amount` is `12030`. Note: This parameter is used for airline data only.

`trips`

Parents: root: initialize-payment: transaction: orders: line-item: product: airline-data

Please note:

The trips element is required if airline-data is present; it provides trip information for the travel itinerary.
The trips element may have multiple trip children.
Each trip child element is an object containing seven children: service-level, origin, destination, departure-time, arrival-time, booking-class, and transportation. See their descriptions below.

Each trip child element has the following attributes:

Parameter	Format	Requirement	Description
`seq`	String	Conditional Requirement: Required if `airline-data` is present.	The sequence of this trip or layover within a journey from end to end. Note: This parameter is used for airline data only.
`tag`	String	Conditional Requirement: Required if `airline-data` is present.	The sequence of this journey in journeys. Note: This parameter is used for airline data only.

`service-level`

Parents: root: initialize-payment: transaction: orders: line-item: product: airline-data: trips: trip

The service-level element is required if airline-data is present, and it has the following text content:

Parameter	Format	Requirement	Description
service level	String	Conditional Requirement: Required if `airline-data` is present.	The cabin class opted. Note: This parameter is used for airline data only.

`origin`

Parents: root: initialize-payment: transaction: orders: line-item: product: airline-data: trips: trip

The origin element is required if airline-data is present; it provides origin location information for the travel itinerary. It has the following attributes:

Parameter	Format	Requirement	Description
`time-zone`	String, in +/-HH:MM format	Conditional Requirement: Required if `airline-data` is present.	The time zone of the place where the journey originates. The time zone is offset; for example,`+08:00`. Note: This parameter is used for airline data only.
`country-id`	Integer	Conditional Requirement: Required if `airline-data` is present.	The ISO numeric country code of the place where the journey originates. Note: This parameter is used for airline data only.
`external-id`	String	Conditional Requirement: Required if `airline-data` is present.	The IATA code of the airport where the journey originates. Note: This parameter is used for airline data only.
`type-id`	Integer	Optional

The origin element has the following text content:

Parameter	Format	Requirement	Description
origin	String	Conditional Requirement: Required if `airline-data` is present.	The place where the journey originates. Note: This parameter is used for airline data only.

`destination`

Parents: root: initialize-payment: transaction: orders: line-item: product: airline-data: trips: trip

The destination element is required if airline-data is present; it provides destination location information for the travel itinerary. It has the following attributes:

Parameter	Format	Requirement	Description
`time-zone`	String, in +/-HH:MM format	Conditional Requirement: Required if `airline-data` is present.	The time zone of the destination. The time zone is offset; for example,`+08:00`. Note: This parameter is used for airline data only.
`country-id`	Integer	Conditional Requirement: Required if `airline-data` is present.	The ISO numeric country code of the destination. Note: This parameter is used for airline data only.
`external-id`	String	Conditional Requirement: Required if `airline-data` is present.	The IATA code of the airport at the destination. Note: This parameter is used for airline data only.
`type-id`	Integer	Optional

The destination element has the following text content:

Parameter	Format	Requirement	Description
destination	String	Conditional Requirement: Required if `airline-data` is present.	The destination of the journey. Note: This parameter is used for airline data only.

`departure-time`

Parents: root: initialize-payment: transaction: orders: line-item: product: airline-data: trips: trip

The departure-time element is required if airline-data is present, and it has the following text content:

Parameter	Format	Requirement	Description
departure time	String	Conditional Requirement: Required if `airline-data` is present.	The departure time of the flight from its origin, in GMT. Note: This parameter is used for airline data only.

`arrival-time`

Parents: root: initialize-payment: transaction: orders: line-item: product: airline-data: trips: trip

The arrival-time element is required if airline-data is present, and it has the following text content:

Parameter	Format	Requirement	Description
arrival time	String	Conditional Requirement: Required if `airline-data` is present.	The arrival time of the flight at its destination, in GMT. Note: This parameter is used for airline data only.

`booking-class`

Parents: root: initialize-payment: transaction: orders: line-item: product: airline-data: trips: trip

The booking-class element is required if airline-data is present, and it has the following text content:

Parameter	Format	Requirement	Description
booking class	String	Conditional Requirement: Required if `airline-data` is present.	The booking class (RBD – first letter of fare-basis). For example, `H`. Note: This parameter is used for airline data only.

`transportation`

Parents: root: initialize-payment: transaction: orders: line-item: product: airline-data: trips: trip

Please note:

The transportation element is required if airline-data is present; it provides transportation information for the travel itinerary.
The transportation element has two children: vehicle and carriers, described below.

The transportation element has the following attribute:

Parameter	Format	Requirement	Description
`code`	String	Conditional Requirement: Required if `airline-data` is present.	The marketing airline code for transportation. For example, `5J`, `PR`, `OD`, and `AV`. Note: This parameter is used for airline data only.

`vehicle`

Parents: root: initialize-payment: transaction: orders: line-item: product: airline-data: trips: trip: transportation

The vehicle element is optional, and it has the following attributes:

Parameter	Format	Requirement	Description
`type`	Integer	Optional	The vehicle type. Note: This parameter is used for airline data only.
`id`	Integer	Optional	The vehicle ID. Note: This parameter is used for airline data only.

The vehicle element has the following text content:

Parameter	Format	Requirement	Description
vehicle	Integer	Optional	The vehicle number. Note: This parameter is used for airline data only.

`carriers`

Parents: root: initialize-payment: transaction: orders: line-item: product: airline-data: trips: trip: transportation

Please note:

The carriers element is required if airline-data is present; it provides an array of carriers used in this journey.
Each carriers element may have multiple carrier children.
Each carrier child element has one child: number.

Each carrier element has the following attributes:

Parameter	Format	Requirement	Description
`type-id`	Integer	Conditional Requirement: Required if `airline-data` is present.	Aircraft type information. Note: This parameter is used for airline data only.
`code`	String	Conditional Requirement: Required if `airline-data` is present.	The code for the operating airline. For example, `PROD`, and `AV`. Note: This parameter is used for airline data only.

Each number element has the following text content:

Parameter	Format	Requirement	Description
flight number	Integer	Conditional Requirement: Required if `airline-data` is present.	The flight number in the airline's system. Note: This parameter is used for airline data only.

`profiles`

Parents: root: initialize-payment: transaction: orders: line-item: product: airline-data

Please note:

The profiles element is required if airline-data is present; it provides traveler information for the travel itinerary.
Each profiles element may have multiple profile children.
Each profile child element provides information for one traveler, and it has six children: title, first-name, last-name, type, amount, and contact-info. See the descriptions below.

Each profile element has the following attribute:

Parameter	Format	Requirement	Description
`id`	Integer	Conditional Requirement: Required if `airline-data` is present.	The unique profile ID for this passenger. Note: This parameter is used for airline data only.

`title`

Parents: root: initialize-payment: transaction: orders: line-item: product: airline-data: profiles: profile

The title element is required if airline-data is present, and it has the following text content:

Parameter	Format	Requirement	Description
title	String	Conditional Requirement: Required if `airline-data` is present.	The title of a passenger. For example, `Mr.`, `Mrs.`, and `Ms.` Note: This parameter is used for airline data only.

`first-name`

Parents: root: initialize-payment: transaction: orders: line-item: product: airline-data: profiles: profile

The first-name element is required if airline-data is present, and it has the following text content:

Parameter	Format	Requirement	Description
first name	String	Conditional Requirement: Required if `airline-data` is present.	The first name of the passenger. Note: This parameter is used for airline data only.

`last-name`

Parents: root: initialize-payment: transaction: orders: line-item: product: airline-data: profiles: profile

The last-name element is required if airline-data is present, and it has the following text content:

Parameter	Format	Requirement	Description
last name	String	Conditional Requirement: Required if `airline-data` is present.	The last name of the passenger. Note: This parameter is used for airline data only.

`type`

Parents: root: initialize-payment: transaction: orders: line-item: product: airline-data: profiles: profile

The type element is required if airline-data is present, and it has the following text content:

Parameter	Format	Requirement	Description
passenger type	String	Conditional Requirement: Required if `airline-data` is present.	The type of passenger. For example, • `ADT` - Adult • `CHD` - Child • `INF` - Infant with FAA Seat Refer to Reference for all possible values. Note: This parameter is used for airline data only.

`amount`

Parents: root: initialize-payment: transaction: orders: line-item: product: airline-data: profiles: profile

The amount element in profile is required if airline-data is present; it provides the transaction amount for the specified passenger. See line-item: airline-data: amount for a description of parameters.

`contact-info`

Parents: root: initialize-payment: transaction: orders: line-item: product: airline-data: profiles: profile

Please note:

The contact-info element is required if airline-data is present; it provides contact information for the specified passenger.
The contact-info element has two children: email and mobile.

The email element is required and has the following text content:

Parameter	Format	Requirement	Description
email address	String	Conditional Requirement: Required if `airline-data` is present.	The passenger's email address. Note: This parameter is used for airline data only.

The mobile element is required and has the following attribute:

Parameter	Format	Requirement	Description
`country-id`	Integer	Conditional Requirement: Required if `airline-data` is present.	Three-digit numeric ISO country code of the mobile phone number's country. This is available in Reference. Note: This parameter is used for airline data only.

The mobile element has the following text content:

Parameter	Format	Requirement	Description
mobile number	Integer	Conditional Requirement: Required if `airline-data` is present.	The passenger's mobile phone number. Note: This parameter is used for airline data only.

`billing-summary`

Parents: root: initialize-payment: transaction: orders: line-item: product: airline-data

Please note:

The billing-summary element is optional; it provides the billing details of the journey.
The billing-summary element has two children: fare-detail and add-ons. See their descriptions below.

`fare-detail`

Parents: root: initialize-payment: transaction: orders: line-item: product: airline-data: billing-summary

The fare-detail element is required if billing-summary is present; it provides fare details for a journey. The fare-detail element can have multiple fare children.

Each fare child element has the following children:

Parameter	Requirement	Format of text content	Description of text content
`profile-seq`	Conditional Requirement: Required if `billing-summary` is present.	Integer	The sequence number of a passenger. Note: This parameter is used for airline data only.
`description`	Conditional Requirement: Required if `billing-summary` is present.	String	The description of the fare. Note: This parameter is used for airline data only.
`currency`	Conditional Requirement: Required if `billing-summary` is present.	String	The alpha3 ISO currency code of the fare amount. Note: This parameter is used for airline data only.
`amount`	Conditional Requirement: Required if `billing-summary` is present.	String	The amount charged for the product. This can be a decimal value. Note: This parameter is used for airline data only.
`product-code`	Conditional Requirement: Required if `billing-summary` is present.	String	The product code of the item. Note: This parameter is used for airline data only.
`product-category`	Conditional Requirement: Required if `billing-summary` is present.	String	The product category code. Note: This parameter is used for airline data only.
`product-item`	Conditional Requirement: Required if `billing-summary` is present.	String	The product name. Note: This parameter is used for airline data only.

`add-ons`

Parents: root: initialize-payment: transaction: orders: line-item: product: airline-data: billing-summary

The add-ons element is required if billing-summary is present; it provides additional information for a journey. It can have multiple add-on children.

Each add-on child element has the following children:

Element	Requirement	Format of text content	Description of text content
`profile-seq`	Conditional Requirement: Mandatory only if it is associated with a passenger.	Integer	The sequence number of a passenger linked to this add-on. Note: This parameter is used for airline data only.
`trip-tag`	Conditional Requirement: Mandatory only if an add-on is associated with a trip.	String	The tag number associated with a trip, which helps identify a trip. Note: This parameter is used for airline data only.
`trip-seq`	Conditional Requirement: Mandatory if add-on is associated with the leg of a trip.	String	The trip sequence number to identify the leg of the trip. Note: This parameter is used for airline data only.
`description`	Conditional Requirement: Required if `billing-summary` is present.	String	The description of the add-on parameters. Note: This parameter is used for airline data only.
`currency`	Conditional Requirement: Required if `billing-summary` is present.	String	The alpha3 ISO currency code of the fare amount. Note: This parameter is used for airline data only.
`amount`	Conditional Requirement: Required if `billing-summary` is present.	String	The amount paid for the add-on product. This can be a decimal value. Note: This parameter is used for airline data only.
`product-code`	Conditional Requirement: Required if `billing-summary` is present.	String	The code to identify the add-on product. Note: This parameter is used for airline data only.
`product-category`	Conditional Requirement: Required if `billing-summary` is present.	String	The code to identify the add-on product category. Note: This parameter is used for airline data only.
`product-item`	Conditional Requirement: Required if `billing-summary` is present.	String	The product name. Note: This parameter is used for airline data only.

`amount`

Parents: root: initialize-payment: transaction: orders: line-item

The amount element that is a child of line-item is required if the orders element is present, and it has the following text content:

Parameter	Format	Requirement	Description
amount	Number	Required	The total amount for an order. Note: This parameter is used by qualifying merchants to display order data.

`points`

Parents: root: initialize-payment: transaction: orders: line-item

The points element is optional, and it has the following text content:

Parameter	Format	Requirement	Description
points	Integer	Optional	The loyalty points used for this order by a customer. Note: This parameter is used by qualifying merchants to display order data.

`reward`

Parents: root: initialize-payment: transaction: orders: line-item

The reward element is optional, and it has the following text content:

Parameter	Format	Requirement	Description
reward points	Integer	Optional	The reward points used for this order by a customer. Note: This parameter is used by qualifying merchants to display order data.

`quantity`

Parents: root: initialize-payment: transaction: orders: line-item

The quantity element is optional, and it has the following text content:

Parameter	Format	Requirement	Description
quantity	Integer	Optional	The quantity of this line item. Default value is `1`. Note: This parameter is used by qualifying merchants to display order data.

`additional-data`

Parents: root: initialize-payment: transaction: orders: line-item

The additional-data element that is a child of line-item is optional; it contains additional information about the line item. The additional-data element may contain multiple param children.

Each param child element has the following attribute:

Parameter	Format	Requirement	Description
`name`	String	Optional	The type of additional data being provided in the param text content, such as `deviceFingerPrint`, `info_cust_url`, `office_id`, `flexi_search`, or `lowest_fare`. Note: This parameter is used by qualifying merchants to display order data.

Each param child element has the following text content:

Parameter	Format	Requirement	Description
param	String	Optional	The value of the parameter defined in `name`. Note: This parameter is used by qualifying merchants to display order data.

`auth-token`

Parents: root: initialize-payment

The auth-token element is optional, and it has the following text content:

Parameter	Format	Requirement	Description
auth token	String	Optional	A unique token sent to the specified auth URL to authenticate customers when they pay with a stored card and use single sign-on (SSO).

`client-info` object

Parents: root: initialize-payment

Below is reference information for the client-info element and its child elements.

`client-info`

Parents: root: initialize-payment

The client-info element is required, and it has the following attributes:

Parameter	Format	Requirement	Description
`language`	String	Optional	The language that Velocity uses as default when translating the payment pages. If this parameter is omitted, Velocity uses the default language set by the merchant. Note: Velocity language codes are based upon the ISO- 639-1 standard. See http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes for details.
`sdk-version`	Integer	Optional	The software development kit (SDK) version used to send the request. Note: Use 2.1.0 SDK version in the request.
`version`	String	Required	The version of the application programming interface (API) or application sending the request.
`platform`	String	Required	The type of platform from which the request is sent. For example, web, iOS, Android, B2B, and B2C.
`profileid`	Integer	Required	The ID of the client's profile in the merchant database.

`mobile`

Parents: root: initialize-payment: client-info

The mobile element is optional, and it has the following attributes:

Parameter	Format	Requirement	Description
`operator-id`	Integer	Optional	The ID of a customer’s mobile network operator. CellPoint Digital recommends including this parameter in a request to ensure that Velocity interacts with the operator accurately.
`country-id`	Integer	Conditional Requirement: Required if mobile number is present.	The CellPoint Digital-specific country code. This is available in Reference.

The mobile element has the following text content:

Parameter	Format	Requirement	Description
mobile number	Integer	Conditional Requirement: A mobile number can be mandatory or optional, based on the requirement of a merchant or a PSP.	The MSISDN of a customer without International Dialing Code.

`email`

Parents: root: initialize-payment: client-info

The email element can be mandatory or optional, based on the requirement of a merchant or a PSP. It has the following text content:

Parameter	Format	Requirement	Description
email	String	Conditional Requirement: Email can be mandatory or optional, based on the requirement of a merchant or a PSP.	The customer's email address. If your customer provides this parameter, the 'Email' input field on the 'Send E-Mail Receipt' page is automatically populated with this value.

`device-id`

Parents: root: initialize-payment: client-info

The device-id element is optional for a web channel, and it has the following text content:

Parameter	Format	Requirement	Description
device ID	String	Conditional Requirement: Optional for a web channel.	The device ID of the customer’s device.

initialize-payment

transaction object

transaction

type-id Transaction Types

amount

fees

callback-url

accept-url

cancel-url

decline-url

auth-url

service-type-id

hmac

additional-data

orders

shipping-address

line-item

product

name

description

image-url

airline-data

amount

fees

trips

service-level

origin

destination

departure-time

arrival-time

booking-class

transportation

vehicle

carriers

profiles

title

first-name

last-name

type

amount

contact-info

billing-summary

fare-detail

add-ons

amount

points

reward

quantity

additional-data

auth-token

client-info object

client-info

mobile

email

device-id

`initialize-payment`

`transaction` object

`transaction`

`type-id` Transaction Types

`amount`

`fees`

`callback-url`

`accept-url`

`cancel-url`

`decline-url`

`auth-url`

`service-type-id`

`hmac`

`additional-data`

`orders`

`shipping-address`

`line-item`

`product`

`name`

`description`

`image-url`

`airline-data`

`amount`

`fees`

`trips`

`service-level`

`origin`

`destination`

`departure-time`

`arrival-time`

`booking-class`

`transportation`

`vehicle`

`carriers`

`profiles`

`title`

`first-name`

`last-name`

`type`

`amount`

`contact-info`

`billing-summary`

`fare-detail`

`add-ons`

`amount`

`points`

`reward`

`quantity`

`additional-data`

`auth-token`

`client-info` object

`client-info`

`mobile`

`email`

`device-id`