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):
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
For Chinese languages, only these two values are accepted:
za - Chinese (simplified)
zu - Chinese (traditional)
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.
Updated 10 days ago
\n\n# **`initialize-payment`**\n\n**Parent:** `root`\n\nThe `initialize-payment` element is **required**, and it has the following attributes:\n\n| Parameter | Format | Requirement | Description |\n| :---------- | :------ | :----------- | :--------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `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. |\n| `client-id` | Integer | **Required** | The unique ID configured for a merchant on the Velocity POP. |\n\n \n\n# **`transaction` object**\n\n**Parents:** `root: initialize-payment`\n\nBelow is reference information for the `transaction` element and its child elements.\n\n## `transaction`\n\n**Parents:** `root: initialize-payment`\n\nThe `transaction` element is **required**, and it has the following attributes:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"`order-no`\",\n \"0-1\": \"AN String\",\n \"0-2\": \"**Required**\",\n \"0-3\": \"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._-]`.\",\n \"1-0\": \"`type-id`\",\n \"1-1\": \"Integer\",\n \"1-2\": \"_Optional_\",\n \"1-3\": \"The type of transaction used for making payment. Velocity supports the transaction types found in the `type-id` Transaction Types table below.\",\n \"2-0\": \"`session-id`\",\n \"2-1\": \"Integer\",\n \"2-2\": \"_Optional_\",\n \"2-3\": \"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.\",\n \"3-0\": \"`product-type`\",\n \"3-1\": \"Integer\",\n \"3-2\": \"_Optional_\",\n \"3-3\": \"The numeric code for the type of product purchased in this transaction: • `100` - Ticket • `200` - Ancillary • `210` - Insurance\",\n \"4-0\": \"`booking-ref`\",\n \"4-1\": \"String\",\n \"4-2\": \"_Optional_\",\n \"4-3\": \"The airline Reservation Booking Designator (RBD), or the first letter of fare class; for example, `H`.\"\n },\n \"cols\": 4,\n \"rows\": 5,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\n## `type-id` Transaction Types\n\nVelocity supports the following transaction types (used to define `type-id`):\n\n| **Value** | **Transaction types** | **Examples** |\n| :-------- | :-------------------- | :------------------------------------------------------------------------------------------------------------------------- |\n| `1` | Online shopping | S&B Purchase |\n| `2` | Offline shopping | S&B Purchase |\n| `3` | Self Service Online | MYB Ancillary Purchase, MYB Change Itinerary Payment, OLCI Ancillary Purchase |\n| `4` | Self Service Offline | MYB Pay Later |\n| `5` | Self Service Online | MYB/Self Service Online with additional rules on FOP-- Managed Booking txn where additional rules on FOP can be configured |\n| `6` | Self Service Online | CPL - Payment Link Transaction. Transaction originated from payment link. |\n\n## `amount`\n\n**Parents:** `root: initialize-payment: transaction`\n\nThe `amount` element is **required**, and it has the following attributes:\n\n| Parameter | Format | Requirement | Description |\n| :------------ | :------ | :----------- | :--------------------------------------------------------------------------------------------------- |\n| `country-id` | Integer | **Required** | The CellPoint Digital-specific country code. This is available in Reference. |\n| `currency-id` | Integer | _Optional_ | The currency configured for a country. This depends on the configuration available through Velocity. |\n\nThe `amount` element has the following text content:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"amount\",\n \"0-1\": \"Integer\",\n \"0-2\": \"**Required**\",\n \"0-3\": \"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`.\"\n },\n \"cols\": 4,\n \"rows\": 1,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\n## `fees`\n\n**Parents:** `root: initialize-payment: transaction`\n\nPlease note:\n\n- 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.' \n- The `fees` element can have multiple `fee` children. \n\nEach `fee` child element has the following attributes:\n\n| Parameter | Format | Requirement | Description |\n| :------------ | :------ | :----------------------------------------------------- | :--------------------------------------------------------------------------- |\n| `country-id` | Integer | **Conditional Requirement:** Required if fees is sent. | The CellPoint Digital-specific country code. This is available in Reference. |\n| `currency-id` | Integer | _Optional_ | The currency code for the fee. This is available in Reference. |\n\nEach `fee` element has the following text content:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"fee\",\n \"0-1\": \"Integer\",\n \"0-2\": \"**Conditional Requirement:** Required if fees is sent.\",\n \"0-3\": \"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`.\"\n },\n \"cols\": 4,\n \"rows\": 1,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\n## `callback-url`\n\n**Parents:** `root: initialize-payment: transaction`\n\nThe `callback-url` element is **optional**, and it has the following text content:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"callback URL\",\n \"0-1\": \"String, in a URL format\",\n \"0-2\": \"_Optional_\",\n \"0-3\": \"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.\"\n },\n \"cols\": 4,\n \"rows\": 1,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\n## `accept-url`\n\n**Parents:** `root: initialize-payment: transaction`\n\nThe `accept-url` element is **optional**, and it has the following text content:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"accept URL\",\n \"0-1\": \"String, in a URL format\",\n \"0-2\": \"_Optional_\",\n \"0-3\": \"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.\"\n },\n \"cols\": 4,\n \"rows\": 1,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\n## `cancel-url`\n\n**Parents:** `root: initialize-payment: transaction`\n\nThe `cancel-url` element can be mandatory or optional, based on the integration type, and it has the following text content:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"cancel URL\",\n \"0-1\": \"String, in a URL format\",\n \"0-2\": \"**Conditional requirement:** This can be mandatory or optional, based on the integration type.\",\n \"0-3\": \"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.\"\n },\n \"cols\": 4,\n \"rows\": 1,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\n## `decline-url`\n\n**Parents:** `root: initialize-payment: transaction`\n\nThe `decline-url` element is **optional**, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :---------- | :---------------------- | :---------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| 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. |\n\n## `auth-url`\n\n**Parents:** `root: initialize-payment: transaction`\n\nThe `decline-url` element is **optional**, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :---------------------- | :---------- | :-------------------------------------------------------------------------------------- |\n| auth URL | String, in a URL format | _Optional_ | The URL used for single sign-on (SSO) authentication if provided by an external system. |\n\n## `service-type-id`\n\nThe `service-type-id` element is **optional**, and it has the following text content:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"Exchange Service ID\",\n \"0-1\": \"Integer\",\n \"0-2\": \"_Optional_\",\n \"0-3\": \"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](doc:appendix) table shows the possible values of exchange service ID.\"\n },\n \"cols\": 4,\n \"rows\": 1,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\n## `hmac`\n\n**Parents:** `root: initialize-payment: transaction`\n\nThe `hmac` element is **required**, and it contains the following text content:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"MAC\",\n \"0-1\": \"String\",\n \"0-2\": \"**Required**\",\n \"0-3\": \"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](doc:appendix) 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`.\"\n },\n \"cols\": 4,\n \"rows\": 1,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\n## `additional-data`\n\n**Parents:** `root: initialize-payment: transaction`\n\nPlease note:\n\n- The `additional-data` element is **optional**; it contains additional information about the transaction. \n- The `additional-data` element may contain multiple `param` children. \n\nEach `param` child element has the following attribute:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :----- | :---------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `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. |\n\nEach `param` child element has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :------------------ | :---------- | :-------------------------------------------- |\n| param | String, up to 20 AN | _Optional_ | The value of the parameter defined in `name`. |\n\n \n\n## `orders`\n\n**Parents:** `root: initialize-payment: transaction`\n\nPlease note:\n\n- The `orders` element is **optional**; it is used to display booking information such as Airline Itinerary Data (AID). \n- The `orders` element contains the objects `shipping-address` and `line-item`; see their descriptions below.\n\n## `shipping-address`\n\n**Parents:** `root: initialize-payment: transaction: orders`\n\nThe `shipping-address` element is **optional**; it defines the customer's mailing address. \n\nThe `shipping-address` element has the following children:\n\n| Element | Requirement | Format of text content | Description of text content |\n| :-------- | :---------------------------------------------------------------------- | :--------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `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. |\n| `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. |\n| `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. |\n| `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. |\n| `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. |\n| `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. |\n| `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. |\n\n \n\n## `line-item`\n\n**Parents:** `root: initialize-payment: transaction: orders`\n\nThe `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.\n\n### `product`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item`\n\nThe `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`. \n\nThe `product` element has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :------ | :------------------------------------------------------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `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. |\n\n### `name`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product`\n\nThe `name` element is required in the `orders` element, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :----- | :------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| 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. |\n\n### `description`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product`\n\nThe `description` element is **optional**, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :---------- | :----- | :---------- | :------------------------------------------------------------------------------------------------------------------------------------ |\n| description | String | _Optional_ | A description of the travel itinerary or booking. **Note:** This parameter is used by qualifying merchants to display order data. |\n\n### `image-url`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product`\n\nThe `image-url` element is **optional**, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :----- | :---------- | :--------------------------------------------------------------------------------------------------------------- |\n| URL | String | _Optional_ | An image URL of the product. **Note:** This parameter is used by qualifying merchants to display order data. |\n\n### `airline-data`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product`\n\nThe `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`.\n\nThe `airline-data` element has the following attributes:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"`order-type`\",\n \"0-1\": \"String\",\n \"0-2\": \"Optional\",\n \"0-3\": \"The type of order. **Note:** This parameter is used for airline data only.\",\n \"1-0\": \"`order-no`\",\n \"1-1\": \"String\",\n \"1-2\": \"Optional\",\n \"1-3\": \"The order number used for the transaction. **Note:** This parameter is used for airline data only.\"\n },\n \"cols\": 4,\n \"rows\": 2,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\n### `amount`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data`\n\nThe `amount` element is required when the `airline-data` element is present, and it has the following attributes:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"`decimals`\",\n \"0-1\": \"Integer\",\n \"0-2\": \"_Optional_\",\n \"0-3\": \"The number of decimal points shown for a currency. **Note:** This parameter is used for airline data only.\",\n \"1-0\": \"`currency-id`\",\n \"1-1\": \"Integer\",\n \"1-2\": \"_Optional_\",\n \"1-3\": \"The currency configured for a country. This depends on the configuration available through Velocity. **Note:** This parameter is used for airline data only.\",\n \"2-0\": \"`currency`\",\n \"2-1\": \"String\",\n \"2-2\": \"_Optional_\",\n \"2-3\": \"The three-letter code for the currency used. **Note:** This parameter is used for airline data only.\",\n \"3-0\": \"`symbol`\",\n \"3-1\": \"String\",\n \"3-2\": \"_Optional_\",\n \"3-3\": \"The symbol used to indicate the currency used. **Note:** This parameter is used for airline data only.\",\n \"4-0\": \"`format`\",\n \"4-1\": \"String\",\n \"4-2\": \"_Optional_\",\n \"4-3\": \"The format in which the amount is presented. **Note:** This parameter is used for airline data only.\",\n \"5-0\": \"`country-id`\",\n \"5-1\": \"Integer\",\n \"5-2\": \"**Conditional Requirement:** Required if `airline-data` is present.\",\n \"5-3\": \"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.\"\n },\n \"cols\": 4,\n \"rows\": 6,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\nThe `amount` element has the following text content:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"amount\",\n \"0-1\": \"Integer\",\n \"0-2\": \"**Conditional Requirement:** Required if `airline-data` is present.\",\n \"0-3\": \"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.\"\n },\n \"cols\": 4,\n \"rows\": 1,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\n### `fees`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data`\n\nThe `fees` element is **optional**, and it may have multiple `fee` children.\n\nEach `fee` child element has the following attributes:\n\n| Parameter | Format | Requirement | Description |\n| :----------- | :------ | :--------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `format` | String | _Optional_ | The format in which this session's total amount is presented. **Note:** This parameter is used for airline data only. |\n| `symbol` | String | _Optional_ | The symbol that indicates the currency used. **Note:** This parameter is used for airline data only. |\n| `currency` | String | _Optional_ | The three-letter code for the currency used. **Note:** This parameter is used for airline data only. |\n| `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. |\n| `type-id` | Integer | _Optional_ | The type of transaction used for making payment. Velocity supports the transaction types found in the [`type-id` Transaction Types](doc:initialize-request-params#type-id-transaction-types) table above. **Note:** This parameter is used for airline data only. |\n\nEach `fee` child element has the following text content:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"amount\",\n \"0-1\": \"Integer\",\n \"0-2\": \"**Conditional Requirement:** Required if `fee` is present.\",\n \"0-3\": \"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.\"\n },\n \"cols\": 4,\n \"rows\": 1,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\n### `trips`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data`\n\nPlease note:\n\n- The `trips` element is required if `airline-data` is present; it provides trip information for the travel itinerary.\n- The `trips` element may have multiple `trip` children.\n- 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.\n\nEach `trip` child element has the following attributes:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :----- | :------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------- |\n| `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. |\n| `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. |\n\n### `service-level`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: trips: trip`\n\nThe `service-level` element is required if `airline-data` is present, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :------------ | :----- | :------------------------------------------------------------------ | :--------------------------------------------------------------------------------- |\n| service level | String | **Conditional Requirement:** Required if `airline-data` is present. | The cabin class opted. **Note:** This parameter is used for airline data only. |\n\n### `origin`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: trips: trip`\n\nThe `origin` element is required if `airline-data` is present; it provides origin location information for the travel itinerary. It has the following attributes:\n\n| Parameter | Format | Requirement | Description |\n| :------------ | :------------------------- | :------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `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. |\n| `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. |\n| `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. |\n| `type-id` | Integer | _Optional_ | |\n\nThe `origin` element has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :----- | :------------------------------------------------------------------ | :-------------------------------------------------------------------------------------------------- |\n| 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. |\n\n### `destination`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: trips: trip`\n\nThe `destination` element is required if `airline-data` is present; it provides destination location information for the travel itinerary. It has the following attributes:\n\n| Parameter | Format | Requirement | Description |\n| :------------ | :------------------------- | :------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------- |\n| `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. |\n| `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. |\n| `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. |\n| `type-id` | Integer | _Optional_ | |\n\nThe `destination` element has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :---------- | :----- | :------------------------------------------------------------------ | :------------------------------------------------------------------------------------------ |\n| destination | String | **Conditional Requirement:** Required if `airline-data` is present. | The destination of the journey. **Note:** This parameter is used for airline data only. |\n\n### `departure-time`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: trips: trip`\n\nThe `departure-time` element is required if `airline-data` is present, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :------------- | :----- | :------------------------------------------------------------------ | :-------------------------------------------------------------------------------------------------------------------- |\n| 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. |\n\n### `arrival-time`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: trips: trip`\n\nThe `arrival-time` element is required if `airline-data` is present, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :----------- | :----- | :------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------- |\n| 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. |\n\n### `booking-class`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: trips: trip`\n\nThe `booking-class` element is required if `airline-data` is present, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :------------ | :----- | :------------------------------------------------------------------ | :---------------------------------------------------------------------------------------------------------------------------------- |\n| 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. |\n\n### `transportation`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: trips: trip`\n\nPlease note:\n\n- The `transportation` element is required if `airline-data` is present; it provides transportation information for the travel itinerary. \n\n- The `transportation` element has two children: `vehicle` and `carriers`, described below.\n\nThe `transportation` element has the following attribute:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :----- | :------------------------------------------------------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `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. |\n\n### `vehicle`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: trips: trip: transportation`\n\nThe `vehicle` element is **optional**, and it has the following attributes:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"`type`\",\n \"0-1\": \"Integer\",\n \"0-2\": \"Optional\",\n \"0-3\": \"The vehicle type. **Note:** This parameter is used for airline data only.\",\n \"1-0\": \"`id`\",\n \"1-1\": \"Integer\",\n \"1-2\": \"Optional\",\n \"1-3\": \"The vehicle ID. **Note:** This parameter is used for airline data only.\"\n },\n \"cols\": 4,\n \"rows\": 2,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\nThe `vehicle` element has the following text content:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"vehicle\",\n \"0-1\": \"Integer\",\n \"0-2\": \"Optional\",\n \"0-3\": \"The vehicle number. **Note:** This parameter is used for airline data only.\"\n },\n \"cols\": 4,\n \"rows\": 1,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\n### `carriers`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: trips: trip: transportation`\n\nPlease note:\n\n- The `carriers` element is required if `airline-data` is present; it provides an array of carriers used in this journey.\n\n- Each `carriers` element may have multiple `carrier` children.\n\n- Each `carrier` child element has one child: `number`.\n\nEach `carrier` element has the following attributes:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"`type-id`\",\n \"0-1\": \"Integer\",\n \"0-2\": \"**Conditional Requirement:** Required if `airline-data` is present.\",\n \"0-3\": \"Aircraft type information. **Note:** This parameter is used for airline data only.\",\n \"1-0\": \"`code`\",\n \"1-1\": \"String\",\n \"1-2\": \"**Conditional Requirement:** Required if `airline-data` is present.\",\n \"1-3\": \"The code for the operating airline. For example, `PROD`, and `AV`. **Note:** This parameter is used for airline data only.\"\n },\n \"cols\": 4,\n \"rows\": 2,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\nEach `number` element has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :------------ | :------ | :------------------------------------------------------------------ | :----------------------------------------------------------------------------------------------------- |\n| 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. |\n\n### `profiles`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data`\n\nPlease note:\n\n- The `profiles` element is required if `airline-data` is present; it provides traveler information for the travel itinerary.\n\n- Each `profiles` element may have multiple `profile` children.\n\n- 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.\n\nEach `profile` element has the following attribute:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :------ | :------------------------------------------------------------------ | :---------------------------------------------------------------------------------------------------- |\n| `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. |\n\n### `title`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: profiles: profile`\n\nThe `title` element is required if `airline-data` is present, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :----- | :------------------------------------------------------------------ | :-------------------------------------------------------------------------------------------------------------------------- |\n| 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. |\n\n### `first-name`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: profiles: profile`\n\nThe `first-name` element is required if `airline-data` is present, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :--------- | :----- | :------------------------------------------------------------------ | :------------------------------------------------------------------------------------------- |\n| 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. |\n\n### `last-name`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: profiles: profile`\n\nThe `last-name` element is required if `airline-data` is present, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :----- | :------------------------------------------------------------------ | :------------------------------------------------------------------------------------------ |\n| 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. |\n\n### `type`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: profiles: profile`\n\nThe `type` element is required if `airline-data` is present, and it has the following text content:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"passenger type\",\n \"0-1\": \"String\",\n \"0-2\": \"**Conditional Requirement:** Required if `airline-data` is present.\",\n \"0-3\": \"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.\"\n },\n \"cols\": 4,\n \"rows\": 1,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\n### `amount`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: profiles: profile`\n\nThe `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`](doc:initialize-request-params#amount-1) for a description of parameters.\n\n### `contact-info`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: profiles: profile`\n\nPlease note:\n\n- The `contact-info` element is required if `airline-data` is present; it provides contact information for the specified passenger.\n\n- The `contact-info` element has two children: `email` and `mobile`.\n\nThe `email` element is required and has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :------------ | :----- | :------------------------------------------------------------------ | :----------------------------------------------------------------------------------------- |\n| 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. |\n\nThe `mobile` element is required and has the following attribute:\n\n| Parameter | Format | Requirement | Description |\n| :----------- | :------ | :------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `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. |\n\nThe `mobile` element has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :------------ | :------ | :------------------------------------------------------------------ | :----------------------------------------------------------------------------------------------- |\n| 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. |\n\n### `billing-summary`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data`\n\nPlease note:\n\n- The `billing-summary` element is **optional**; it provides the billing details of the journey.\n- The `billing-summary` element has two children: `fare-detail` and `add-ons`. See their descriptions below.\n\n### `fare-detail`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: billing-summary`\n\nThe `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. \n\nEach `fare` child element has the following children:\n\n| Parameter | Requirement | Format of text content | Description of text content |\n| :----------------- | :--------------------------------------------------------------------- | :--------------------- | :--------------------------------------------------------------------------------------------------------------------------- |\n| `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. |\n| `description` | **Conditional Requirement:** Required if `billing-summary` is present. | String | The description of the fare. **Note:** This parameter is used for airline data only. |\n| `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. |\n| `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. |\n| `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. |\n| `product-category` | **Conditional Requirement:** Required if `billing-summary` is present. | String | The product category code. **Note:** This parameter is used for airline data only. |\n| `product-item` | **Conditional Requirement:** Required if `billing-summary` is present. | String | The product name. **Note:** This parameter is used for airline data only. |\n\n### `add-ons`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: billing-summary`\n\nThe `add-ons` element is required if `billing-summary` is present; it provides additional information for a journey. It can have multiple `add-on` children. \n\nEach `add-on` child element has the following children:\n\n| Element | Requirement | Format of text content | Description of text content |\n| :----------------- | :------------------------------------------------------------------------------------- | :--------------------- | :------------------------------------------------------------------------------------------------------------------------------- |\n| `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. |\n| `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. |\n| `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. |\n| `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. |\n| `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. |\n| `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. |\n| `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. |\n| `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. |\n| `product-item` | **Conditional Requirement:** Required if `billing-summary` is present. | String | The product name. **Note:** This parameter is used for airline data only. |\n\n### `amount`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item`\n\nThe `amount` element that is a child of `line-item` is required if the `orders` element is present, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :----- | :----------- | :----------------------------------------------------------------------------------------------------------------- |\n| amount | Number | **Required** | The total amount for an order. **Note:** This parameter is used by qualifying merchants to display order data. |\n\n### `points`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item`\n\nThe `points` element is **optional**, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :------ | :---------- | :---------------------------------------------------------------------------------------------------------------------------------------- |\n| 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. |\n\n### `reward`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item`\n\nThe `reward` element is **optional**, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :------------ | :------ | :---------- | :--------------------------------------------------------------------------------------------------------------------------------------- |\n| 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. |\n\n### `quantity`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item`\n\nThe `quantity` element is **optional**, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :------ | :---------- | :---------------------------------------------------------------------------------------------------------------------------------------- |\n| 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. |\n\n### `additional-data`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item`\n\nThe `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. \n\nEach `param` child element has the following attribute:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :----- | :---------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `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. |\n\nEach `param` child element has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :----- | :---------- | :-------------------------------------------------------------------------------------------------------------------------------- |\n| param | String | _Optional_ | The value of the parameter defined in `name`. **Note:** This parameter is used by qualifying merchants to display order data. |\n\n \n\n# **`auth-token`**\n\n**Parents:** `root: initialize-payment`\n\nThe `auth-token` element is **optional**, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :--------- | :----- | :---------- | :------------------------------------------------------------------------------------------------------------------------------------- |\n| 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). |\n\n \n\n# **`client-info` object**\n\n**Parents:** `root: initialize-payment`\n\nBelow is reference information for the `client-info` element and its child elements.\n\n## `client-info`\n\n**Parents:** `root: initialize-payment`\n\nThe `client-info` element is **required**, and it has the following attributes:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"`language`\",\n \"0-1\": \"String\",\n \"0-2\": \"_Optional_\",\n \"0-3\": \"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 for details.
For Chinese languages, only these two values are accepted:
`za` - Chinese (simplified)
`zu` - Chinese (traditional)
\",\n \"1-0\": \"`sdk-version`\",\n \"1-1\": \"Integer\",\n \"1-2\": \"_Optional_\",\n \"1-3\": \"The software development kit (SDK) version used to send the request.
**Note:** Use 2.1.0 SDK version in the request.\",\n \"2-0\": \"`version`\",\n \"2-1\": \"String\",\n \"2-2\": \"**Required**\",\n \"2-3\": \"The version of the application programming interface (API) or application sending the request.\",\n \"3-0\": \"`platform`\",\n \"3-1\": \"String\",\n \"3-2\": \"**Required**\",\n \"3-3\": \"The type of platform from which the request is sent. For example, web, iOS, Android, B2B, and B2C.\",\n \"4-0\": \"`profileid`\",\n \"4-1\": \"Integer\",\n \"4-2\": \"**Required**\",\n \"4-3\": \"The ID of the client's profile in the merchant database.\"\n },\n \"cols\": 4,\n \"rows\": 5,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\n## `mobile`\n\n**Parents:** `root: initialize-payment: client-info`\n\nThe `mobile` element is **optional**, and it has the following attributes:\n\n| Parameter | Format | Requirement | Description |\n| :------------ | :------ | :----------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `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. |\n| `country-id` | Integer | **Conditional Requirement:** Required if mobile number is present. | The CellPoint Digital-specific country code. This is available in Reference. |\n\nThe `mobile` element has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :------------ | :------ | :-------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------- |\n| 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. |\n\n## `email`\n\n**Parents:** `root: initialize-payment: client-info`\n\nThe `email` element can be **mandatory or optional**, based on the requirement of a merchant or a PSP. It has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :----- | :---------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| 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. |\n\n## `device-id`\n\n**Parents:** `root: initialize-payment: client-info`\n\nThe `device-id` element is **optional** for a web channel, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :----- | :------------------------------------------------------- | :-------------------------------------- |\n| device ID | String | **Conditional Requirement:** Optional for a web channel. | The device ID of the customer’s device. |","dehydrated":{"toc":"","body":"
See the following sections for descriptions of Initialize request parameters:
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.
\n
type-id Transaction Types
\n
Velocity supports the following transaction types (used to define type-id):
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.
\n
amount
\n
Parents:root: initialize-payment: transaction
\n
The amount element is required, and it has the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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.
\n
The amount element has the following text content:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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.
\n
fees
\n
Parents:root: initialize-payment: transaction
\n
Please note:
\n
\n
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.'
\n
The fees element can have multiple fee children.
\n
\n
Each fee child element has the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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.
\n
Each fee element has the following text content:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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.
\n
callback-url
\n
Parents:root: initialize-payment: transaction
\n
The callback-url element is optional, and it has the following text content:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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.
\n
accept-url
\n
Parents:root: initialize-payment: transaction
\n
The accept-url element is optional, and it has the following text content:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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.
\n
cancel-url
\n
Parents:root: initialize-payment: transaction
\n
The cancel-url element can be mandatory or optional, based on the integration type, and it has the following text content:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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.
\n
decline-url
\n
Parents:root: initialize-payment: transaction
\n
The decline-url element is optional, and it has the following text content:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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.
\n
auth-url
\n
Parents:root: initialize-payment: transaction
\n
The decline-url element is optional, and it has the following text content:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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.
\n
service-type-id
\n
The service-type-id element is optional, and it has the following text content:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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.
\n
hmac
\n
Parents:root: initialize-payment: transaction
\n
The hmac element is required, and it contains the following text content:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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.
\n
additional-data
\n
Parents:root: initialize-payment: transaction
\n
Please note:
\n
\n
The additional-data element is optional; it contains additional information about the transaction.
\n
The additional-data element may contain multiple param children.
\n
\n
Each param child element has the following attribute:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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.
\n
Each param child element has the following text content:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Parameter
Format
Requirement
Description
param
String, up to 20 AN
Optional
The value of the parameter defined in name.
\n \n
orders
\n
Parents:root: initialize-payment: transaction
\n
Please note:
\n
\n
The orders element is optional; it is used to display booking information such as Airline Itinerary Data (AID).
\n
The orders element contains the objects shipping-address and line-item; see their descriptions below.
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.
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.
\n
The product element has the following text content:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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.
The name element is required in the orders element, and it has the following text content:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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.
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.
\n
The airline-data element has the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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.
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.
\n
The amount element has the following text content:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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.
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.
\n
Each fee child element has the following text content:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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.
The trips element is required if airline-data is present; it provides trip information for the travel itinerary.
\n
The trips element may have multiple trip children.
\n
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.
\n
\n
Each trip child element has the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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.
The origin element is required if airline-data is present; it provides origin location information for the travel itinerary. It has the following attributes:
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
\n
The origin element has the following text content:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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.
The destination element is required if airline-data is present; it provides destination location information for the travel itinerary. It has the following attributes:
The profiles element is required if airline-data is present; it provides traveler information for the travel itinerary.
\n
\n
\n
Each profiles element may have multiple profile children.
\n
\n
\n
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.
\n
\n
\n
Each profile element has the following attribute:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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.
The type element is required if airline-data is present, and it has the following text content:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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.
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.
The contact-info element is required if airline-data is present; it provides contact information for the specified passenger.
\n
\n
\n
The contact-info element has two children: email and mobile.
\n
\n
\n
The email element is required and has the following text content:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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.
\n
The mobile element is required and has the following attribute:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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.
\n
The mobile element has the following text content:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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.
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.
\n
Each fare child element has the following children:
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.
\n
Each param child element has the following attribute:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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.
\n
Each param child element has the following text content:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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.
\n \n
auth-token
\n
Parents:root: initialize-payment
\n
The auth-token element is optional, and it has the following text content:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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).
\n \n
client-info object
\n
Parents:root: initialize-payment
\n
Below is reference information for the client-info element and its child elements.
\n
client-info
\n
Parents:root: initialize-payment
\n
The client-info element is required, and it has the following attributes:
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.
For Chinese languages, only these two values are accepted:
za - Chinese (simplified)
zu - Chinese (traditional)
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.
\n
mobile
\n
Parents:root: initialize-payment: client-info
\n
The mobile element is optional, and it has the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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.
\n
The mobile element has the following text content:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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.
\n
email
\n
Parents:root: initialize-payment: client-info
\n
The email element can be mandatory or optional, based on the requirement of a merchant or a PSP. It has the following text content:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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.
\n
device-id
\n
Parents:root: initialize-payment: client-info
\n
The device-id element is optional for a web channel, and it has the following text content:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Parameter
Format
Requirement
Description
device ID
String
Conditional Requirement: Optional for a web channel.
The device ID of the customer’s device.
"},"mdx":false,"opts":{"alwaysThrow":false,"compatibilityMode":false,"copyButtons":true,"correctnewlines":false,"markdownOptions":{"fences":true,"commonmark":true,"gfm":true,"ruleSpaces":false,"listItemIndent":"1","spacedTable":true,"paddedTable":true},"normalize":true,"lazyImages":true,"reusableContent":{"tags":{}},"safeMode":false,"settings":{"position":true},"theme":"light","customBlocks":{},"resourceID":"683f3826ef2131005dc4aa8f","resourceType":"page","baseUrl":"/","terms":[{"_id":"65df740c7c4f340018cb407a","term":"HPP","definition":"Hosted Payment Pages"},{"_id":"65df74177c4f340018cb429f","term":"PSP","definition":"Payment Service Provider"},{"_id":"65df74258dd4bf0ee8d44494","term":"ACQ","definition":"Acquirer"}],"variables":{"user":{},"defaults":[{"source":"security","type":"oauth2","_id":"685aab9a0e9689004bb02198","name":"cpdIssuedJWT","apiSetting":"685aab990e9689004bb02194"},{"source":"security","type":"http","_id":"685aab9a0e9689004bb02197","name":"merchantIssuedJWT","scheme":"bearer","apiSetting":"685aab990e9689004bb02194"}]}},"terms":[{"_id":"65df740c7c4f340018cb407a","term":"HPP","definition":"Hosted Payment Pages"},{"_id":"65df74177c4f340018cb429f","term":"PSP","definition":"Payment Service Provider"},{"_id":"65df74258dd4bf0ee8d44494","term":"ACQ","definition":"Acquirer"}],"variables":{"user":{},"defaults":[{"source":"security","type":"oauth2","_id":"685aab9a0e9689004bb02198","name":"cpdIssuedJWT","apiSetting":"685aab990e9689004bb02194"},{"source":"security","type":"http","_id":"685aab9a0e9689004bb02197","name":"merchantIssuedJWT","scheme":"bearer","apiSetting":"685aab990e9689004bb02194"}]}},"doc":{"metadata":{"image":[],"title":"","description":"","keywords":"","robots":"index"},"mdx":{"altBody":"","status":"rdmd"},"api":{"method":"get","url":"","auth":"required","params":[]},"next":{"description":"","pages":[]},"algolia":{"publishPending":false,"recordCount":56,"updatedAt":"2025-07-09T18:59:21.062Z","translationFailure":false},"_id":"683f3826ef2131005dc4aa8f","title":"Request Parameters","icon":"","updates":[],"type":"basic","slug":"initialize-request-params","excerpt":"API Reference: Initialize","body":"See the following sections for descriptions of Initialize request parameters:\n\n- [`initialize-payment`](doc:initialize-request-params#initialize-payment)\n- [`transaction` object](doc:initialize-request-params#transaction-object) \n- [`auth-token`](doc:initialize-request-params#auth-token)\n- [`client-info` object](doc:initialize-request-params#client-info-object)\n\nFor Initialize sample code, see [Initialize](doc:initialize).\n\n \n\n# **`initialize-payment`**\n\n**Parent:** `root`\n\nThe `initialize-payment` element is **required**, and it has the following attributes:\n\n| Parameter | Format | Requirement | Description |\n| :---------- | :------ | :----------- | :--------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `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. |\n| `client-id` | Integer | **Required** | The unique ID configured for a merchant on the Velocity POP. |\n\n \n\n# **`transaction` object**\n\n**Parents:** `root: initialize-payment`\n\nBelow is reference information for the `transaction` element and its child elements.\n\n## `transaction`\n\n**Parents:** `root: initialize-payment`\n\nThe `transaction` element is **required**, and it has the following attributes:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"`order-no`\",\n \"0-1\": \"AN String\",\n \"0-2\": \"**Required**\",\n \"0-3\": \"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._-]`.\",\n \"1-0\": \"`type-id`\",\n \"1-1\": \"Integer\",\n \"1-2\": \"_Optional_\",\n \"1-3\": \"The type of transaction used for making payment. Velocity supports the transaction types found in the `type-id` Transaction Types table below.\",\n \"2-0\": \"`session-id`\",\n \"2-1\": \"Integer\",\n \"2-2\": \"_Optional_\",\n \"2-3\": \"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.\",\n \"3-0\": \"`product-type`\",\n \"3-1\": \"Integer\",\n \"3-2\": \"_Optional_\",\n \"3-3\": \"The numeric code for the type of product purchased in this transaction: • `100` - Ticket • `200` - Ancillary • `210` - Insurance\",\n \"4-0\": \"`booking-ref`\",\n \"4-1\": \"String\",\n \"4-2\": \"_Optional_\",\n \"4-3\": \"The airline Reservation Booking Designator (RBD), or the first letter of fare class; for example, `H`.\"\n },\n \"cols\": 4,\n \"rows\": 5,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\n## `type-id` Transaction Types\n\nVelocity supports the following transaction types (used to define `type-id`):\n\n| **Value** | **Transaction types** | **Examples** |\n| :-------- | :-------------------- | :------------------------------------------------------------------------------------------------------------------------- |\n| `1` | Online shopping | S&B Purchase |\n| `2` | Offline shopping | S&B Purchase |\n| `3` | Self Service Online | MYB Ancillary Purchase, MYB Change Itinerary Payment, OLCI Ancillary Purchase |\n| `4` | Self Service Offline | MYB Pay Later |\n| `5` | Self Service Online | MYB/Self Service Online with additional rules on FOP-- Managed Booking txn where additional rules on FOP can be configured |\n| `6` | Self Service Online | CPL - Payment Link Transaction. Transaction originated from payment link. |\n\n## `amount`\n\n**Parents:** `root: initialize-payment: transaction`\n\nThe `amount` element is **required**, and it has the following attributes:\n\n| Parameter | Format | Requirement | Description |\n| :------------ | :------ | :----------- | :--------------------------------------------------------------------------------------------------- |\n| `country-id` | Integer | **Required** | The CellPoint Digital-specific country code. This is available in Reference. |\n| `currency-id` | Integer | _Optional_ | The currency configured for a country. This depends on the configuration available through Velocity. |\n\nThe `amount` element has the following text content:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"amount\",\n \"0-1\": \"Integer\",\n \"0-2\": \"**Required**\",\n \"0-3\": \"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`.\"\n },\n \"cols\": 4,\n \"rows\": 1,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\n## `fees`\n\n**Parents:** `root: initialize-payment: transaction`\n\nPlease note:\n\n- 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.' \n- The `fees` element can have multiple `fee` children. \n\nEach `fee` child element has the following attributes:\n\n| Parameter | Format | Requirement | Description |\n| :------------ | :------ | :----------------------------------------------------- | :--------------------------------------------------------------------------- |\n| `country-id` | Integer | **Conditional Requirement:** Required if fees is sent. | The CellPoint Digital-specific country code. This is available in Reference. |\n| `currency-id` | Integer | _Optional_ | The currency code for the fee. This is available in Reference. |\n\nEach `fee` element has the following text content:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"fee\",\n \"0-1\": \"Integer\",\n \"0-2\": \"**Conditional Requirement:** Required if fees is sent.\",\n \"0-3\": \"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`.\"\n },\n \"cols\": 4,\n \"rows\": 1,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\n## `callback-url`\n\n**Parents:** `root: initialize-payment: transaction`\n\nThe `callback-url` element is **optional**, and it has the following text content:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"callback URL\",\n \"0-1\": \"String, in a URL format\",\n \"0-2\": \"_Optional_\",\n \"0-3\": \"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.\"\n },\n \"cols\": 4,\n \"rows\": 1,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\n## `accept-url`\n\n**Parents:** `root: initialize-payment: transaction`\n\nThe `accept-url` element is **optional**, and it has the following text content:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"accept URL\",\n \"0-1\": \"String, in a URL format\",\n \"0-2\": \"_Optional_\",\n \"0-3\": \"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.\"\n },\n \"cols\": 4,\n \"rows\": 1,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\n## `cancel-url`\n\n**Parents:** `root: initialize-payment: transaction`\n\nThe `cancel-url` element can be mandatory or optional, based on the integration type, and it has the following text content:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"cancel URL\",\n \"0-1\": \"String, in a URL format\",\n \"0-2\": \"**Conditional requirement:** This can be mandatory or optional, based on the integration type.\",\n \"0-3\": \"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.\"\n },\n \"cols\": 4,\n \"rows\": 1,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\n## `decline-url`\n\n**Parents:** `root: initialize-payment: transaction`\n\nThe `decline-url` element is **optional**, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :---------- | :---------------------- | :---------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| 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. |\n\n## `auth-url`\n\n**Parents:** `root: initialize-payment: transaction`\n\nThe `decline-url` element is **optional**, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :---------------------- | :---------- | :-------------------------------------------------------------------------------------- |\n| auth URL | String, in a URL format | _Optional_ | The URL used for single sign-on (SSO) authentication if provided by an external system. |\n\n## `service-type-id`\n\nThe `service-type-id` element is **optional**, and it has the following text content:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"Exchange Service ID\",\n \"0-1\": \"Integer\",\n \"0-2\": \"_Optional_\",\n \"0-3\": \"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](doc:appendix) table shows the possible values of exchange service ID.\"\n },\n \"cols\": 4,\n \"rows\": 1,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\n## `hmac`\n\n**Parents:** `root: initialize-payment: transaction`\n\nThe `hmac` element is **required**, and it contains the following text content:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"MAC\",\n \"0-1\": \"String\",\n \"0-2\": \"**Required**\",\n \"0-3\": \"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](doc:appendix) 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`.\"\n },\n \"cols\": 4,\n \"rows\": 1,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\n## `additional-data`\n\n**Parents:** `root: initialize-payment: transaction`\n\nPlease note:\n\n- The `additional-data` element is **optional**; it contains additional information about the transaction. \n- The `additional-data` element may contain multiple `param` children. \n\nEach `param` child element has the following attribute:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :----- | :---------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `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. |\n\nEach `param` child element has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :------------------ | :---------- | :-------------------------------------------- |\n| param | String, up to 20 AN | _Optional_ | The value of the parameter defined in `name`. |\n\n \n\n## `orders`\n\n**Parents:** `root: initialize-payment: transaction`\n\nPlease note:\n\n- The `orders` element is **optional**; it is used to display booking information such as Airline Itinerary Data (AID). \n- The `orders` element contains the objects `shipping-address` and `line-item`; see their descriptions below.\n\n## `shipping-address`\n\n**Parents:** `root: initialize-payment: transaction: orders`\n\nThe `shipping-address` element is **optional**; it defines the customer's mailing address. \n\nThe `shipping-address` element has the following children:\n\n| Element | Requirement | Format of text content | Description of text content |\n| :-------- | :---------------------------------------------------------------------- | :--------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `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. |\n| `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. |\n| `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. |\n| `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. |\n| `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. |\n| `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. |\n| `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. |\n\n \n\n## `line-item`\n\n**Parents:** `root: initialize-payment: transaction: orders`\n\nThe `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.\n\n### `product`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item`\n\nThe `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`. \n\nThe `product` element has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :------ | :------------------------------------------------------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `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. |\n\n### `name`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product`\n\nThe `name` element is required in the `orders` element, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :----- | :------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| 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. |\n\n### `description`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product`\n\nThe `description` element is **optional**, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :---------- | :----- | :---------- | :------------------------------------------------------------------------------------------------------------------------------------ |\n| description | String | _Optional_ | A description of the travel itinerary or booking. **Note:** This parameter is used by qualifying merchants to display order data. |\n\n### `image-url`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product`\n\nThe `image-url` element is **optional**, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :----- | :---------- | :--------------------------------------------------------------------------------------------------------------- |\n| URL | String | _Optional_ | An image URL of the product. **Note:** This parameter is used by qualifying merchants to display order data. |\n\n### `airline-data`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product`\n\nThe `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`.\n\nThe `airline-data` element has the following attributes:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"`order-type`\",\n \"0-1\": \"String\",\n \"0-2\": \"Optional\",\n \"0-3\": \"The type of order. **Note:** This parameter is used for airline data only.\",\n \"1-0\": \"`order-no`\",\n \"1-1\": \"String\",\n \"1-2\": \"Optional\",\n \"1-3\": \"The order number used for the transaction. **Note:** This parameter is used for airline data only.\"\n },\n \"cols\": 4,\n \"rows\": 2,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\n### `amount`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data`\n\nThe `amount` element is required when the `airline-data` element is present, and it has the following attributes:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"`decimals`\",\n \"0-1\": \"Integer\",\n \"0-2\": \"_Optional_\",\n \"0-3\": \"The number of decimal points shown for a currency. **Note:** This parameter is used for airline data only.\",\n \"1-0\": \"`currency-id`\",\n \"1-1\": \"Integer\",\n \"1-2\": \"_Optional_\",\n \"1-3\": \"The currency configured for a country. This depends on the configuration available through Velocity. **Note:** This parameter is used for airline data only.\",\n \"2-0\": \"`currency`\",\n \"2-1\": \"String\",\n \"2-2\": \"_Optional_\",\n \"2-3\": \"The three-letter code for the currency used. **Note:** This parameter is used for airline data only.\",\n \"3-0\": \"`symbol`\",\n \"3-1\": \"String\",\n \"3-2\": \"_Optional_\",\n \"3-3\": \"The symbol used to indicate the currency used. **Note:** This parameter is used for airline data only.\",\n \"4-0\": \"`format`\",\n \"4-1\": \"String\",\n \"4-2\": \"_Optional_\",\n \"4-3\": \"The format in which the amount is presented. **Note:** This parameter is used for airline data only.\",\n \"5-0\": \"`country-id`\",\n \"5-1\": \"Integer\",\n \"5-2\": \"**Conditional Requirement:** Required if `airline-data` is present.\",\n \"5-3\": \"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.\"\n },\n \"cols\": 4,\n \"rows\": 6,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\nThe `amount` element has the following text content:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"amount\",\n \"0-1\": \"Integer\",\n \"0-2\": \"**Conditional Requirement:** Required if `airline-data` is present.\",\n \"0-3\": \"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.\"\n },\n \"cols\": 4,\n \"rows\": 1,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\n### `fees`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data`\n\nThe `fees` element is **optional**, and it may have multiple `fee` children.\n\nEach `fee` child element has the following attributes:\n\n| Parameter | Format | Requirement | Description |\n| :----------- | :------ | :--------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `format` | String | _Optional_ | The format in which this session's total amount is presented. **Note:** This parameter is used for airline data only. |\n| `symbol` | String | _Optional_ | The symbol that indicates the currency used. **Note:** This parameter is used for airline data only. |\n| `currency` | String | _Optional_ | The three-letter code for the currency used. **Note:** This parameter is used for airline data only. |\n| `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. |\n| `type-id` | Integer | _Optional_ | The type of transaction used for making payment. Velocity supports the transaction types found in the [`type-id` Transaction Types](doc:initialize-request-params#type-id-transaction-types) table above. **Note:** This parameter is used for airline data only. |\n\nEach `fee` child element has the following text content:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"amount\",\n \"0-1\": \"Integer\",\n \"0-2\": \"**Conditional Requirement:** Required if `fee` is present.\",\n \"0-3\": \"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.\"\n },\n \"cols\": 4,\n \"rows\": 1,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\n### `trips`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data`\n\nPlease note:\n\n- The `trips` element is required if `airline-data` is present; it provides trip information for the travel itinerary.\n- The `trips` element may have multiple `trip` children.\n- 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.\n\nEach `trip` child element has the following attributes:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :----- | :------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------- |\n| `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. |\n| `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. |\n\n### `service-level`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: trips: trip`\n\nThe `service-level` element is required if `airline-data` is present, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :------------ | :----- | :------------------------------------------------------------------ | :--------------------------------------------------------------------------------- |\n| service level | String | **Conditional Requirement:** Required if `airline-data` is present. | The cabin class opted. **Note:** This parameter is used for airline data only. |\n\n### `origin`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: trips: trip`\n\nThe `origin` element is required if `airline-data` is present; it provides origin location information for the travel itinerary. It has the following attributes:\n\n| Parameter | Format | Requirement | Description |\n| :------------ | :------------------------- | :------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `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. |\n| `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. |\n| `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. |\n| `type-id` | Integer | _Optional_ | |\n\nThe `origin` element has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :----- | :------------------------------------------------------------------ | :-------------------------------------------------------------------------------------------------- |\n| 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. |\n\n### `destination`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: trips: trip`\n\nThe `destination` element is required if `airline-data` is present; it provides destination location information for the travel itinerary. It has the following attributes:\n\n| Parameter | Format | Requirement | Description |\n| :------------ | :------------------------- | :------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------- |\n| `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. |\n| `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. |\n| `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. |\n| `type-id` | Integer | _Optional_ | |\n\nThe `destination` element has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :---------- | :----- | :------------------------------------------------------------------ | :------------------------------------------------------------------------------------------ |\n| destination | String | **Conditional Requirement:** Required if `airline-data` is present. | The destination of the journey. **Note:** This parameter is used for airline data only. |\n\n### `departure-time`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: trips: trip`\n\nThe `departure-time` element is required if `airline-data` is present, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :------------- | :----- | :------------------------------------------------------------------ | :-------------------------------------------------------------------------------------------------------------------- |\n| 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. |\n\n### `arrival-time`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: trips: trip`\n\nThe `arrival-time` element is required if `airline-data` is present, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :----------- | :----- | :------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------- |\n| 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. |\n\n### `booking-class`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: trips: trip`\n\nThe `booking-class` element is required if `airline-data` is present, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :------------ | :----- | :------------------------------------------------------------------ | :---------------------------------------------------------------------------------------------------------------------------------- |\n| 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. |\n\n### `transportation`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: trips: trip`\n\nPlease note:\n\n- The `transportation` element is required if `airline-data` is present; it provides transportation information for the travel itinerary. \n\n- The `transportation` element has two children: `vehicle` and `carriers`, described below.\n\nThe `transportation` element has the following attribute:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :----- | :------------------------------------------------------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `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. |\n\n### `vehicle`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: trips: trip: transportation`\n\nThe `vehicle` element is **optional**, and it has the following attributes:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"`type`\",\n \"0-1\": \"Integer\",\n \"0-2\": \"Optional\",\n \"0-3\": \"The vehicle type. **Note:** This parameter is used for airline data only.\",\n \"1-0\": \"`id`\",\n \"1-1\": \"Integer\",\n \"1-2\": \"Optional\",\n \"1-3\": \"The vehicle ID. **Note:** This parameter is used for airline data only.\"\n },\n \"cols\": 4,\n \"rows\": 2,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\nThe `vehicle` element has the following text content:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"vehicle\",\n \"0-1\": \"Integer\",\n \"0-2\": \"Optional\",\n \"0-3\": \"The vehicle number. **Note:** This parameter is used for airline data only.\"\n },\n \"cols\": 4,\n \"rows\": 1,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\n### `carriers`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: trips: trip: transportation`\n\nPlease note:\n\n- The `carriers` element is required if `airline-data` is present; it provides an array of carriers used in this journey.\n\n- Each `carriers` element may have multiple `carrier` children.\n\n- Each `carrier` child element has one child: `number`.\n\nEach `carrier` element has the following attributes:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"`type-id`\",\n \"0-1\": \"Integer\",\n \"0-2\": \"**Conditional Requirement:** Required if `airline-data` is present.\",\n \"0-3\": \"Aircraft type information. **Note:** This parameter is used for airline data only.\",\n \"1-0\": \"`code`\",\n \"1-1\": \"String\",\n \"1-2\": \"**Conditional Requirement:** Required if `airline-data` is present.\",\n \"1-3\": \"The code for the operating airline. For example, `PROD`, and `AV`. **Note:** This parameter is used for airline data only.\"\n },\n \"cols\": 4,\n \"rows\": 2,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\nEach `number` element has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :------------ | :------ | :------------------------------------------------------------------ | :----------------------------------------------------------------------------------------------------- |\n| 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. |\n\n### `profiles`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data`\n\nPlease note:\n\n- The `profiles` element is required if `airline-data` is present; it provides traveler information for the travel itinerary.\n\n- Each `profiles` element may have multiple `profile` children.\n\n- 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.\n\nEach `profile` element has the following attribute:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :------ | :------------------------------------------------------------------ | :---------------------------------------------------------------------------------------------------- |\n| `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. |\n\n### `title`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: profiles: profile`\n\nThe `title` element is required if `airline-data` is present, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :----- | :------------------------------------------------------------------ | :-------------------------------------------------------------------------------------------------------------------------- |\n| 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. |\n\n### `first-name`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: profiles: profile`\n\nThe `first-name` element is required if `airline-data` is present, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :--------- | :----- | :------------------------------------------------------------------ | :------------------------------------------------------------------------------------------- |\n| 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. |\n\n### `last-name`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: profiles: profile`\n\nThe `last-name` element is required if `airline-data` is present, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :----- | :------------------------------------------------------------------ | :------------------------------------------------------------------------------------------ |\n| 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. |\n\n### `type`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: profiles: profile`\n\nThe `type` element is required if `airline-data` is present, and it has the following text content:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"passenger type\",\n \"0-1\": \"String\",\n \"0-2\": \"**Conditional Requirement:** Required if `airline-data` is present.\",\n \"0-3\": \"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.\"\n },\n \"cols\": 4,\n \"rows\": 1,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\n### `amount`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: profiles: profile`\n\nThe `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`](doc:initialize-request-params#amount-1) for a description of parameters.\n\n### `contact-info`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: profiles: profile`\n\nPlease note:\n\n- The `contact-info` element is required if `airline-data` is present; it provides contact information for the specified passenger.\n\n- The `contact-info` element has two children: `email` and `mobile`.\n\nThe `email` element is required and has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :------------ | :----- | :------------------------------------------------------------------ | :----------------------------------------------------------------------------------------- |\n| 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. |\n\nThe `mobile` element is required and has the following attribute:\n\n| Parameter | Format | Requirement | Description |\n| :----------- | :------ | :------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `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. |\n\nThe `mobile` element has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :------------ | :------ | :------------------------------------------------------------------ | :----------------------------------------------------------------------------------------------- |\n| 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. |\n\n### `billing-summary`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data`\n\nPlease note:\n\n- The `billing-summary` element is **optional**; it provides the billing details of the journey.\n- The `billing-summary` element has two children: `fare-detail` and `add-ons`. See their descriptions below.\n\n### `fare-detail`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: billing-summary`\n\nThe `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. \n\nEach `fare` child element has the following children:\n\n| Parameter | Requirement | Format of text content | Description of text content |\n| :----------------- | :--------------------------------------------------------------------- | :--------------------- | :--------------------------------------------------------------------------------------------------------------------------- |\n| `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. |\n| `description` | **Conditional Requirement:** Required if `billing-summary` is present. | String | The description of the fare. **Note:** This parameter is used for airline data only. |\n| `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. |\n| `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. |\n| `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. |\n| `product-category` | **Conditional Requirement:** Required if `billing-summary` is present. | String | The product category code. **Note:** This parameter is used for airline data only. |\n| `product-item` | **Conditional Requirement:** Required if `billing-summary` is present. | String | The product name. **Note:** This parameter is used for airline data only. |\n\n### `add-ons`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item: product: airline-data: billing-summary`\n\nThe `add-ons` element is required if `billing-summary` is present; it provides additional information for a journey. It can have multiple `add-on` children. \n\nEach `add-on` child element has the following children:\n\n| Element | Requirement | Format of text content | Description of text content |\n| :----------------- | :------------------------------------------------------------------------------------- | :--------------------- | :------------------------------------------------------------------------------------------------------------------------------- |\n| `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. |\n| `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. |\n| `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. |\n| `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. |\n| `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. |\n| `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. |\n| `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. |\n| `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. |\n| `product-item` | **Conditional Requirement:** Required if `billing-summary` is present. | String | The product name. **Note:** This parameter is used for airline data only. |\n\n### `amount`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item`\n\nThe `amount` element that is a child of `line-item` is required if the `orders` element is present, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :----- | :----------- | :----------------------------------------------------------------------------------------------------------------- |\n| amount | Number | **Required** | The total amount for an order. **Note:** This parameter is used by qualifying merchants to display order data. |\n\n### `points`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item`\n\nThe `points` element is **optional**, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :------ | :---------- | :---------------------------------------------------------------------------------------------------------------------------------------- |\n| 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. |\n\n### `reward`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item`\n\nThe `reward` element is **optional**, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :------------ | :------ | :---------- | :--------------------------------------------------------------------------------------------------------------------------------------- |\n| 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. |\n\n### `quantity`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item`\n\nThe `quantity` element is **optional**, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :------ | :---------- | :---------------------------------------------------------------------------------------------------------------------------------------- |\n| 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. |\n\n### `additional-data`\n\n**Parents:** `root: initialize-payment: transaction: orders: line-item`\n\nThe `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. \n\nEach `param` child element has the following attribute:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :----- | :---------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `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. |\n\nEach `param` child element has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :----- | :---------- | :-------------------------------------------------------------------------------------------------------------------------------- |\n| param | String | _Optional_ | The value of the parameter defined in `name`. **Note:** This parameter is used by qualifying merchants to display order data. |\n\n \n\n# **`auth-token`**\n\n**Parents:** `root: initialize-payment`\n\nThe `auth-token` element is **optional**, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :--------- | :----- | :---------- | :------------------------------------------------------------------------------------------------------------------------------------- |\n| 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). |\n\n \n\n# **`client-info` object**\n\n**Parents:** `root: initialize-payment`\n\nBelow is reference information for the `client-info` element and its child elements.\n\n## `client-info`\n\n**Parents:** `root: initialize-payment`\n\nThe `client-info` element is **required**, and it has the following attributes:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Format\",\n \"h-2\": \"Requirement\",\n \"h-3\": \"Description\",\n \"0-0\": \"`language`\",\n \"0-1\": \"String\",\n \"0-2\": \"_Optional_\",\n \"0-3\": \"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 for details.
For Chinese languages, only these two values are accepted:
`za` - Chinese (simplified)
`zu` - Chinese (traditional)
\",\n \"1-0\": \"`sdk-version`\",\n \"1-1\": \"Integer\",\n \"1-2\": \"_Optional_\",\n \"1-3\": \"The software development kit (SDK) version used to send the request.
**Note:** Use 2.1.0 SDK version in the request.\",\n \"2-0\": \"`version`\",\n \"2-1\": \"String\",\n \"2-2\": \"**Required**\",\n \"2-3\": \"The version of the application programming interface (API) or application sending the request.\",\n \"3-0\": \"`platform`\",\n \"3-1\": \"String\",\n \"3-2\": \"**Required**\",\n \"3-3\": \"The type of platform from which the request is sent. For example, web, iOS, Android, B2B, and B2C.\",\n \"4-0\": \"`profileid`\",\n \"4-1\": \"Integer\",\n \"4-2\": \"**Required**\",\n \"4-3\": \"The ID of the client's profile in the merchant database.\"\n },\n \"cols\": 4,\n \"rows\": 5,\n \"align\": [\n \"left\",\n \"left\",\n \"left\",\n \"left\"\n ]\n}\n[/block]\n\n\n## `mobile`\n\n**Parents:** `root: initialize-payment: client-info`\n\nThe `mobile` element is **optional**, and it has the following attributes:\n\n| Parameter | Format | Requirement | Description |\n| :------------ | :------ | :----------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `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. |\n| `country-id` | Integer | **Conditional Requirement:** Required if mobile number is present. | The CellPoint Digital-specific country code. This is available in Reference. |\n\nThe `mobile` element has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :------------ | :------ | :-------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------- |\n| 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. |\n\n## `email`\n\n**Parents:** `root: initialize-payment: client-info`\n\nThe `email` element can be **mandatory or optional**, based on the requirement of a merchant or a PSP. It has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :----- | :---------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| 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. |\n\n## `device-id`\n\n**Parents:** `root: initialize-payment: client-info`\n\nThe `device-id` element is **optional** for a web channel, and it has the following text content:\n\n| Parameter | Format | Requirement | Description |\n| :-------- | :----- | :------------------------------------------------------- | :-------------------------------------- |\n| device ID | String | **Conditional Requirement:** Optional for a web channel. | The device ID of the customer’s device. |","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"reusableContent":[],"previousSlug":"","slugUpdatedAt":"2025-02-27T21:04:17.753Z","revision":46,"user":"62991f19b6f06d0085f6b293","project":"637d11f8234e9b0099697a18","parentDoc":"683f3826ef2131005dc4aa7b","category":{"_id":"683f3826ef2131005dc4aa38","title":"Reference","slug":"reference","order":6,"reference":false,"project":"637d11f8234e9b0099697a18","version":"683f3826ef2131005dc4aaa4","createdAt":"2024-06-12T20:02:20.959Z","__v":0,"type":"guide","id":"683f3826ef2131005dc4aa38"},"createdAt":"2025-02-28T18:59:35.811Z","updatedAt":"2025-07-10T19:08:55.023Z","version":{"_id":"683f3826ef2131005dc4aaa4","version":"2.2.1","version_clean":"2.2.1","codename":"published 6/2025","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["65df665dc0373e0012b2671f","65df665dc0373e0012b2671f","637d11f9234e9b0099697a21","63f9089917a2c3000bb745ec","63f908a35c346f005ec48f8f","63f908a936e4890026cac28c","63f908b7104d73003b29a9dd","63f908c5488146003e11bc4a","63f908d190690f0018740987","63f908e45c346f005ec49118","63f908f2b46e8e0018c64334","63f9090188b25e0075bfb6fd","640233f1779f9600650a94fd","64089ed25ba213087efa7e2e","65df5c9d2f41d000111baa93","65df665ec0373e0012b26788","663a80d460cde700677088fb","65ea0e104ca63e004a1d8f12","683f3826ef2131005dc4aa36","683f3826ef2131005dc4aa37","67192ae574588c0045a0b9cd","66674781e10aad001eda7959","6669fd16bcf40100183d7130","6669fd1a47cf690019d619c6","67192ae574588c0045a0b9ce","683f3826ef2131005dc4aa38","683f3826ef2131005dc4aa39","683f3826ef2131005dc4aa3a","683f3826ef2131005dc4aa3b","67192ae574588c0045a0b9d3"],"pdfStatus":"complete","source":"readme","project":"637d11f8234e9b0099697a18","releaseDate":"2022-11-22T18:16:25.273Z","createdAt":"2025-06-03T18:00:06.642Z","__v":1,"updatedAt":"2025-06-09T15:29:41.078Z","forked_from":"67192ae574588c0045a0ba54","apiRegistries":[]},"lastUpdatedHash":"31a2e965846d12f9483926763ec8abc00797346e","__v":0,"isApi":false,"tutorials":[],"id":"683f3826ef2131005dc4aa8f"},"hideTOC":false,"meta":{"_id":"683f3826ef2131005dc4aa8f","description":"API Reference: Initialize","hidden":false,"image":[],"keywords":"","metaTitle":"Request Parameters","parent":"683f3826ef2131005dc4aa7b","robots":"index","slug":"initialize-request-params","title":"Request Parameters","type":"docs"},"slugUrl":"/docs/initialize-request-params","config":{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2025-03-27","fullstory":{"enabled":true,"orgId":"FSV9A"},"liveblocks":{"copilotId":"co_11Q0l0JJlkcBhhAYUFh8s"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.422.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true},"shMigration":{"promoVideo":"","forceWaitlist":false,"migrationPreview":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}},"context":{"labs":{},"user":{},"terms":[{"_id":"65df740c7c4f340018cb407a","term":"HPP","definition":"Hosted Payment Pages"},{"_id":"65df74177c4f340018cb429f","term":"PSP","definition":"Payment Service Provider"},{"_id":"65df74258dd4bf0ee8d44494","term":"ACQ","definition":"Acquirer"}],"variables":{"user":{},"defaults":[{"source":"security","type":"oauth2","_id":"685aab9a0e9689004bb02198","name":"cpdIssuedJWT","apiSetting":"685aab990e9689004bb02194"},{"source":"security","type":"http","_id":"685aab9a0e9689004bb02197","name":"merchantIssuedJWT","scheme":"bearer","apiSetting":"685aab990e9689004bb02194"}]},"project":{"_id":"637d11f8234e9b0099697a18","appearance":{"rdmd":{"callouts":{"useIconFont":false},"theme":{"background":"","border":"","markdownEdge":"","markdownFont":"","markdownFontSize":"","markdownLineHeight":"","markdownRadius":"","markdownText":"","markdownTitle":"","markdownTitleFont":"","mdCodeBackground":"","mdCodeFont":"","mdCodeRadius":"","mdCodeTabs":"","mdCodeText":"","tableEdges":"","tableHead":"","tableHeadText":"","tableRow":"","tableStripe":"","tableText":"","text":"","title":""}},"main_body":{"type":"links"},"colors":{"highlight":"","main":"#000000","main_alt":"","header_text":"","body_highlight":"#8f45e6","custom_login_link_color":""},"typography":{"headline":"Open+Sans:400:sans-serif","body":"Open+Sans:400:sans-serif","typekit":false,"tk_key":"","tk_headline":"","tk_body":""},"header":{"style":"solid","img":[],"img_size":"auto","img_pos":"tl","linkStyle":"buttons"},"body":{"style":"none"},"global_landing_page":{"html":"","redirect":""},"referenceSimpleMode":true,"referenceLayout":"row","link_logo_to_url":true,"theme":"line","colorScheme":"light","overlay":"triangles","landing":true,"sticky":false,"hide_logo":true,"childrenAsPills":false,"subheaderStyle":"links","splitReferenceDocs":false,"showMetricsInReference":true,"logo":["https://files.readme.io/d20d0d2-small-CPD_C-Logo_RGB_low.png","CPD_C-Logo_RGB_low.png",80,80,"#000000","https://files.readme.io/945d379-CPD_C-Logo_RGB_low.png"],"loginLogo":[],"logo_white":["https://files.readme.io/9f504ea-small-CPD_C-Logo_RGB_low.png","CPD_C-Logo_RGB_low.png",80,80,"#000000","https://files.readme.io/37519c1-CPD_C-Logo_RGB_low.png"],"logo_white_use":false,"logo_large":true,"favicon":["https://files.readme.io/5f4c175-small-cpd_favicon.png","cpd_favicon.png",32,32,"#000000","https://files.readme.io/43707bd-cpd_favicon.png"],"stylesheet":"","stylesheet_hub2":".markdown-body { \n font-family: \"Open Sans\",\"Helvetica Neue\",\"Helvetica\",\"Arial\",sans-serif !important;\n}\n\nh1, h2, h3, h4, h5, h6 {font-family: \"Open Sans\",\"Helvetica Neue\",\"Helvetica\",\"Arial\",sans-serif !important;}\n\n.heading-1 {\n padding-top: .4em;\n\tpadding-bottom: .5em; \n}\n\n.heading-2 {\n padding-top: .4em;\n\tpadding-bottom: .4em;\n}\n\n.heading-3, .heading-4 {\n padding-top: .5em;\n\tpadding-bottom: .3em;\n}\n\n\n.main-table tr .sub-heading{\n \n text-align : left;\n}\n\n.round-dots{\nlist-style-type: circle;\n\n}\n.col-txt{\n vertical-align: top;\n}\n.text-block{\n display : block; \n}\n\n.bullet-list{\n margin: 0 40px;\n list-style: circle !important;\n}\n\n.bullet-list.less-spacing{\n margin: 0 50px;\n padding: 0 !important;\n}\n\n.nested-table-wrapper{\n padding-bottom: 280px;\n position: relative;\n}\n\n.nested-table{\n\tposition: absolute;\n margin-top: -145px;\n}\n\n@media only screen and (max-width: 1300px){\n.nested-table{\n\tposition: static;\n margin-top: 0;\n}\n .nested-table-wrapper{\n \tpadding-bottom: 0;\n }\n}\n\n/**Helpers***/\n.left{\ntext-align: left;\n}\n.underline-text {\ntext-decoration: underline;\n display: inline;\n}\n.style-circle li {\n list-style: circle !important;\n}\n.style-alpha li {\n\t\tlist-style: lower-alpha;\n}\n/**Helpers-End***/","stylesheet_hub3":"","javascript":"","javascript_hub2":"","html_promo":"","html_body":"","html_footer":"","html_head":"\n\n","html_footer_meta":"","html_hidelinks":false,"showVersion":false,"hideTableOfContents":false,"nextStepsLabel":"","promos":[{"extras":{"type":"search","buttonPrimary":"get-started","buttonSecondary":""},"title":"CellPoint Digital: Developer Documentation","text":"Unlock the power of seamless payment orchestration with CellPoint Digital's comprehensive suite of integration solutions.","_id":"637d11f8234e9b0099697a1a"}],"changelog":{"layoutExpanded":false,"showAuthor":true,"showExactDate":false},"allowApiExplorerJsonEditor":false,"ai_dropdown":"disabled","ai_options":{"chatgpt":"enabled","claude":"enabled","clipboard":"enabled","view_as_markdown":"enabled","copilot":"enabled"},"showPageIcons":true,"layout":{"full_width":false,"style":"classic"}},"custom_domain":"documentation.cellpointdigital.com","childrenProjects":[],"derivedPlan":"business2018","description":"","isExternalSnippetActive":false,"error404":"","experiments":[],"first_page":"landing","flags":{"allowApiExplorerJsonEditor":false,"allowDarkMode":true,"alwaysShowDocPublishStatus":false,"allowXFrame":false,"correctnewlines":false,"dashReact":false,"disablePasswordlessLogin":false,"directGoogleToStableVersion":false,"disableAnonForum":false,"enterprise":false,"graphql":false,"migrationRun":false,"migrationSwaggerRun":false,"myDevelopers":false,"newEditor":true,"newEditorDash":true,"newMarkdownBetaProgram":true,"newSearch":true,"oauth":false,"oldMarkdown":false,"rdmdCompatibilityMode":false,"reviewWorkflow":true,"singleProjectEnterprise":false,"speedyRender":false,"staging":false,"star":false,"swagger":false,"translation":false,"useReactApp":true,"useReactGLP":false,"superHub":false,"developerDashboard":false,"allowReusableOTPs":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"apiV2":false,"customBlocks":false,"disableAutoTranslate":false,"disableSAMLScoping":false,"git":{"read":false,"write":false},"owlbotAi":false,"superHubBeta":false,"apiAccessRevoked":false,"passwordlessLogin":"default","disableSignups":false,"billingRedesignEnabled":true,"developerPortal":false,"mdx":false,"superHubDevelopment":false,"annualBillingEnabled":true,"devDashBillingRedesignEnabled":false,"enableOidc":false,"customComponents":false,"disableDiscussionSpamRecaptchaBypass":false,"developerViewUsersData":false,"changelogRssAlwaysPublic":false,"bidiSync":false,"superHubMigrationSelfServeFlow":true,"apiDesigner":false,"hideEnforceSSO":false,"localLLM":false,"superHubManageVersions":false,"gitSidebar":false,"superHubGlobalCustomBlocks":false,"childManagedBidi":false,"superHubBranches":false,"externalSdkSnippets":false,"requiresJQuery":false,"migrationPreview":false,"superHubPreview":false,"superHubBranchReviews":false,"superHubMergePermissions":false},"fullBaseUrl":"https://documentation.cellpointdigital.com/","git":{"migration":{"createRepository":{},"transformation":{},"migratingPages":{},"enableSuperhub":{}},"sync":{"linked_repository":{},"installationRequest":{},"connections":[],"providers":[]}},"glossaryTerms":[{"_id":"65df740c7c4f340018cb407a","term":"HPP","definition":"Hosted Payment Pages"},{"_id":"65df74177c4f340018cb429f","term":"PSP","definition":"Payment Service Provider"},{"_id":"65df74258dd4bf0ee8d44494","term":"ACQ","definition":"Acquirer"}],"graphqlSchema":"","gracePeriod":{"enabled":false,"endsAt":null},"shouldGateDash":false,"healthCheck":{"provider":"","settings":{}},"intercom_secure_emailonly":false,"intercom":"","is_active":true,"integrations":{"login":{}},"internal":"","jwtExpirationTime":0,"landing_bottom":[{"type":"text","alignment":"left","text":"CellPoint Digital's comprehensive suite of integration solutions offers payment solutions for high-volume merchants with complex requirements, merchants looking for a hands-off Hosted Payment Page (HPP) option, or merchants seeking bespoke payment experiences:"},{"type":"three","alignment":"left","pageType":"Reference","group0":{"title":"[API Integration](doc:orchestration-overview#api-integration)","text":"For high-volume merchants who prioritize full control over their online channel's user interface and experience."},"group1":{"title":"[HPP](doc:orchestration-overview#hosted-payment-page-hpp)","text":"A hassle-free payment integration for merchants seeking a hands-off approach to payment acceptance."},"group2":{"title":"[Custom HPP](doc:orchestration-overview#custom-hosted-payment-page-hpp)","text":"Provide your customers a customized payment experience while offloading payment management to a trusted partner."}},{"type":"text","alignment":"left","text":" "},{"type":"docs","alignment":"left","pageType":"Documentation"},{"type":"docs","alignment":"left","pageType":"Reference"}],"mdxMigrationStatus":"rdmd","metrics":{"monthlyLimit":0,"planLimit":5000000,"thumbsEnabled":true,"monthlyPurchaseLimit":0,"meteredBilling":{}},"modules":{"landing":true,"docs":true,"examples":true,"reference":false,"graphql":false,"changelog":false,"discuss":false,"suggested_edits":true,"logs":false,"custompages":true,"tutorials":false},"name":"CellPoint Documentation","nav_names":{"docs":"","reference":"","changelog":"","discuss":"","tutorials":"","recipes":""},"oauth_url":"","onboardingCompleted":{"documentation":true,"appearance":true,"jwt":false,"api":true,"logs":false,"domain":false,"metricsSDK":false},"owlbot":{"enabled":false,"isPaying":false,"customization":{"answerLength":"long","customTone":"","defaultAnswer":"","forbiddenWords":"","tone":"neutral"},"copilot":{"enabled":false,"hasBeenUsed":false,"installedCustomPage":""}},"owner":{"id":null,"email":null,"name":null},"plan":"business2018","planOverride":"","planSchedule":{"stripeScheduleId":null,"changeDate":null,"nextPlan":null},"planStatus":"active","planTrial":"business2018","readmeScore":{"components":{"newDesign":{"enabled":true,"points":25},"reference":{"enabled":false,"points":50},"tryItNow":{"enabled":false,"points":35},"syncingOAS":{"enabled":false,"points":10},"customLogin":{"enabled":false,"points":25},"metrics":{"enabled":false,"points":40},"recipes":{"enabled":false,"points":15},"pageVoting":{"enabled":true,"points":1},"suggestedEdits":{"enabled":true,"points":10},"support":{"enabled":false,"points":5},"htmlLanding":{"enabled":false,"points":5},"guides":{"enabled":true,"points":10},"changelog":{"enabled":false,"points":5},"glossary":{"enabled":true,"points":1},"variables":{"enabled":false,"points":1},"integrations":{"enabled":true,"points":2}},"totalScore":49},"reCaptchaSiteKey":"","reference":{"alwaysUseDefaults":true,"defaultExpandResponseExample":false,"defaultExpandResponseSchema":false,"enableOAuthFlows":false},"seo":{"overwrite_title_tag":false},"stable":{"_id":"683f3826ef2131005dc4aaa4","version":"2.2.1","version_clean":"2.2.1","codename":"published 6/2025","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["65df665dc0373e0012b2671f","65df665dc0373e0012b2671f","637d11f9234e9b0099697a21","63f9089917a2c3000bb745ec","63f908a35c346f005ec48f8f","63f908a936e4890026cac28c","63f908b7104d73003b29a9dd","63f908c5488146003e11bc4a","63f908d190690f0018740987","63f908e45c346f005ec49118","63f908f2b46e8e0018c64334","63f9090188b25e0075bfb6fd","640233f1779f9600650a94fd","64089ed25ba213087efa7e2e","65df5c9d2f41d000111baa93","65df665ec0373e0012b26788","663a80d460cde700677088fb","65ea0e104ca63e004a1d8f12","683f3826ef2131005dc4aa36","683f3826ef2131005dc4aa37","67192ae574588c0045a0b9cd","66674781e10aad001eda7959","6669fd16bcf40100183d7130","6669fd1a47cf690019d619c6","67192ae574588c0045a0b9ce","683f3826ef2131005dc4aa38","683f3826ef2131005dc4aa39","683f3826ef2131005dc4aa3a","683f3826ef2131005dc4aa3b","67192ae574588c0045a0b9d3"],"pdfStatus":"complete","source":"readme","project":"637d11f8234e9b0099697a18","releaseDate":"2022-11-22T18:16:25.273Z","createdAt":"2025-06-03T18:00:06.642Z","__v":1,"updatedAt":"2025-06-09T15:29:41.078Z","forked_from":"67192ae574588c0045a0ba54","apiRegistries":[]},"subdomain":"cellpoint-documentation","subpath":"","superHubWaitlist":false,"topnav":{"left":[],"right":[{"type":"user","text":"User","url":"/login?redirect_uri=/docs/initialize-request-params"}],"bottom":[],"edited":false},"trial":{"trialDeadlineEnabled":true,"trialEndsAt":"2022-12-06T18:16:24.937Z"},"translate":{"provider":"transifex","show_widget":false,"key_public":"","org_name":"","project_name":"","languages":[]},"url":"https://cellpointdigital.com","versions":[{"_id":"65b283ae7a6d4a000fdf71ea","version":"0.0","version_clean":"0.0.0","codename":"test","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"categories":["65b283ae7a6d4a000fdf7183","65b283ae7a6d4a000fdf7183","637d11f9234e9b0099697a21","63f9089917a2c3000bb745ec","63f908a35c346f005ec48f8f","63f908a936e4890026cac28c","63f908b7104d73003b29a9dd","63f908c5488146003e11bc4a","63f908d190690f0018740987","63f908e45c346f005ec49118","63f908f2b46e8e0018c64334","63f9090188b25e0075bfb6fd","640233f1779f9600650a94fd","64089ed25ba213087efa7e2e","65b283af7a6d4a000fdf71ec"],"project":"637d11f8234e9b0099697a18","releaseDate":"2022-11-22T18:16:25.273Z","createdAt":"2024-01-25T15:52:14.865Z","__v":0,"forked_from":"637d11f9234e9b0099697a1d","updatedAt":"2024-02-28T16:59:25.329Z"},{"_id":"637d11f9234e9b0099697a1d","version":"1.0","version_clean":"1.0.0","codename":"Amsterdam","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"categories":["637d11f9234e9b0099697a1f","637d11f9234e9b0099697a1f","637d11f9234e9b0099697a21","63f9089917a2c3000bb745ec","63f908a35c346f005ec48f8f","63f908a936e4890026cac28c","63f908b7104d73003b29a9dd","63f908c5488146003e11bc4a","63f908d190690f0018740987","63f908e45c346f005ec49118","63f908f2b46e8e0018c64334","63f9090188b25e0075bfb6fd","640233f1779f9600650a94fd","64089ed25ba213087efa7e2e","65df5c9d2f41d000111baa93"],"project":"637d11f8234e9b0099697a18","releaseDate":"2022-11-22T18:16:25.273Z","createdAt":"2022-11-22T18:16:25.273Z","__v":1,"updatedAt":"2024-07-08T18:41:39.309Z"},{"_id":"63fd68df5d1cbe0011aa89e6","version":"1.1","version_clean":"1.1.0","codename":"","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"categories":["63fd68df5d1cbe0011aa89da","63fd68df5d1cbe0011aa89da","637d11f9234e9b0099697a21","63f9089917a2c3000bb745ec","63f908a35c346f005ec48f8f","63f908a936e4890026cac28c","63f908b7104d73003b29a9dd","63f908c5488146003e11bc4a","63f908d190690f0018740987","63f908e45c346f005ec49118","63f908f2b46e8e0018c64334","63f9090188b25e0075bfb6fd","63fd68df5d1cbe0011aa89e8"],"project":"637d11f8234e9b0099697a18","releaseDate":"2022-11-22T18:16:25.273Z","createdAt":"2022-11-22T18:16:25.273Z","__v":1,"forked_from":"637d11f9234e9b0099697a1d","updatedAt":"2024-02-28T16:59:27.097Z"},{"_id":"6435ab5ef8d79800298c8f79","version":"1.2","version_clean":"1.2.0","codename":"API update","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"categories":["6435ab5ef8d79800298c8f14","6435ab5ef8d79800298c8f14","637d11f9234e9b0099697a21","63f9089917a2c3000bb745ec","63f908a35c346f005ec48f8f","63f908a936e4890026cac28c","63f908b7104d73003b29a9dd","63f908c5488146003e11bc4a","63f908d190690f0018740987","63f908e45c346f005ec49118","63f908f2b46e8e0018c64334","63f9090188b25e0075bfb6fd","640233f1779f9600650a94fd","64089ed25ba213087efa7e2e","6435ab5ff8d79800298c8f7b"],"project":"637d11f8234e9b0099697a18","releaseDate":"2022-11-22T18:16:25.273Z","createdAt":"2022-11-22T18:16:25.273Z","__v":0,"forked_from":"637d11f9234e9b0099697a1d","updatedAt":"2024-02-28T16:59:30.557Z"},{"_id":"65df665dc0373e0012b26786","version":"2.0","version_clean":"2.0.0","codename":"","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"categories":["65df665dc0373e0012b2671f","65df665dc0373e0012b2671f","637d11f9234e9b0099697a21","63f9089917a2c3000bb745ec","63f908a35c346f005ec48f8f","63f908a936e4890026cac28c","63f908b7104d73003b29a9dd","63f908c5488146003e11bc4a","63f908d190690f0018740987","63f908e45c346f005ec49118","63f908f2b46e8e0018c64334","63f9090188b25e0075bfb6fd","640233f1779f9600650a94fd","64089ed25ba213087efa7e2e","65df5c9d2f41d000111baa93","65df665ec0373e0012b26788","65df673f4fef960011de01a6","65ea0e104ca63e004a1d8f12","685aab990e9689004bb02196"],"project":"637d11f8234e9b0099697a18","releaseDate":"2022-11-22T18:16:25.273Z","createdAt":"2024-02-28T16:59:09.739Z","__v":0,"updatedAt":"2025-06-24T13:43:53.372Z","forked_from":"637d11f9234e9b0099697a1d","pdfStatus":""},{"_id":"663a80d460cde70067708aa8","version":"2.1","version_clean":"2.1.0","codename":"consolidated, published til 6/2025","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"categories":["65df665dc0373e0012b2671f","65df665dc0373e0012b2671f","637d11f9234e9b0099697a21","63f9089917a2c3000bb745ec","63f908a35c346f005ec48f8f","63f908a936e4890026cac28c","63f908b7104d73003b29a9dd","63f908c5488146003e11bc4a","63f908d190690f0018740987","63f908e45c346f005ec49118","63f908f2b46e8e0018c64334","63f9090188b25e0075bfb6fd","640233f1779f9600650a94fd","64089ed25ba213087efa7e2e","65df5c9d2f41d000111baa93","65df665ec0373e0012b26788","663a80d460cde700677088fb","65ea0e104ca63e004a1d8f12","663a80d460cde70067708aaa","663d0ee0650a360011f3a208","663d0ef859318f004e1ec2cb","66674781e10aad001eda7959","6669fd16bcf40100183d7130","6669fd1a47cf690019d619c6","6669feadd423ef0019cfdb71","6669feccffcc2a00110fcd26","666ae70996d0670027097975","670e8de65acfcd0011b138f2","670e8ff8d3021400114cabae","670e91c1e468070019583aa7"],"project":"637d11f8234e9b0099697a18","releaseDate":"2022-11-22T18:16:25.273Z","createdAt":"2024-05-07T19:28:20.054Z","__v":2,"updatedAt":"2025-06-09T15:29:24.614Z","forked_from":"65df665dc0373e0012b26786","pdfStatus":"complete","apiRegistries":[],"source":"readme"},{"_id":"67192ae574588c0045a0ba54","version":"2.2","version_clean":"2.2.0","codename":"reorganize, to-do list","is_stable":false,"is_beta":true,"is_hidden":true,"is_deprecated":false,"categories":["65df665dc0373e0012b2671f","65df665dc0373e0012b2671f","637d11f9234e9b0099697a21","63f9089917a2c3000bb745ec","63f908a35c346f005ec48f8f","63f908a936e4890026cac28c","63f908b7104d73003b29a9dd","63f908c5488146003e11bc4a","63f908d190690f0018740987","63f908e45c346f005ec49118","63f908f2b46e8e0018c64334","63f9090188b25e0075bfb6fd","640233f1779f9600650a94fd","64089ed25ba213087efa7e2e","65df5c9d2f41d000111baa93","65df665ec0373e0012b26788","663a80d460cde700677088fb","65ea0e104ca63e004a1d8f12","67192ae574588c0045a0b9cb","67192ae574588c0045a0b9cc","67192ae574588c0045a0b9cd","66674781e10aad001eda7959","6669fd16bcf40100183d7130","6669fd1a47cf690019d619c6","67192ae574588c0045a0b9ce","67192ae574588c0045a0b9cf","67192ae574588c0045a0b9d0","67192ae574588c0045a0b9d1","67192ae574588c0045a0b9d2","67192ae574588c0045a0b9d3"],"pdfStatus":"complete","project":"637d11f8234e9b0099697a18","releaseDate":"2022-11-22T18:16:25.273Z","createdAt":"2024-10-23T16:57:09.294Z","__v":2,"updatedAt":"2025-06-03T17:53:46.693Z","forked_from":"663a80d460cde70067708aa8","apiRegistries":[],"source":"readme"},{"_id":"683f3826ef2131005dc4aaa4","version":"2.2.1","version_clean":"2.2.1","codename":"published 6/2025","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["65df665dc0373e0012b2671f","65df665dc0373e0012b2671f","637d11f9234e9b0099697a21","63f9089917a2c3000bb745ec","63f908a35c346f005ec48f8f","63f908a936e4890026cac28c","63f908b7104d73003b29a9dd","63f908c5488146003e11bc4a","63f908d190690f0018740987","63f908e45c346f005ec49118","63f908f2b46e8e0018c64334","63f9090188b25e0075bfb6fd","640233f1779f9600650a94fd","64089ed25ba213087efa7e2e","65df5c9d2f41d000111baa93","65df665ec0373e0012b26788","663a80d460cde700677088fb","65ea0e104ca63e004a1d8f12","683f3826ef2131005dc4aa36","683f3826ef2131005dc4aa37","67192ae574588c0045a0b9cd","66674781e10aad001eda7959","6669fd16bcf40100183d7130","6669fd1a47cf690019d619c6","67192ae574588c0045a0b9ce","683f3826ef2131005dc4aa38","683f3826ef2131005dc4aa39","683f3826ef2131005dc4aa3a","683f3826ef2131005dc4aa3b","67192ae574588c0045a0b9d3"],"pdfStatus":"complete","source":"readme","project":"637d11f8234e9b0099697a18","releaseDate":"2022-11-22T18:16:25.273Z","createdAt":"2025-06-03T18:00:06.642Z","__v":1,"updatedAt":"2025-06-09T15:29:41.078Z","forked_from":"67192ae574588c0045a0ba54","apiRegistries":[]}],"variableDefaults":[{"source":"security","type":"oauth2","_id":"685aab9a0e9689004bb02198","name":"cpdIssuedJWT","apiSetting":"685aab990e9689004bb02194"},{"source":"security","type":"http","_id":"685aab9a0e9689004bb02197","name":"merchantIssuedJWT","scheme":"bearer","apiSetting":"685aab990e9689004bb02194"}],"webhookEnabled":false,"isHubEditable":true},"projectStore":{"data":{"allow_crawlers":"disabled","canonical_url":null,"default_version":{"name":"2.2.1"},"description":null,"glossary":[{"_id":"65df740c7c4f340018cb407a","term":"HPP","definition":"Hosted Payment Pages"},{"_id":"65df74177c4f340018cb429f","term":"PSP","definition":"Payment Service Provider"},{"_id":"65df74258dd4bf0ee8d44494","term":"ACQ","definition":"Acquirer"}],"homepage_url":"https://cellpointdigital.com","id":"637d11f8234e9b0099697a18","name":"CellPoint Documentation","parent":null,"redirects":[],"sitemap":"disabled","llms_txt":"disabled","subdomain":"cellpoint-documentation","suggested_edits":"enabled","uri":"/projects/me","variable_defaults":[{"name":"cpdIssuedJWT","source":"security","type":"oauth2","id":"685aab9a0e9689004bb02198"},{"name":"merchantIssuedJWT","scheme":"bearer","source":"security","type":"http","id":"685aab9a0e9689004bb02197"}],"webhooks":[],"api_designer":{"allow_editing":"enabled"},"custom_login":{"login_url":null,"logout_url":null},"features":{"mdx":"disabled"},"mcp":{},"onboarding_completed":{"api":true,"appearance":true,"documentation":true,"domain":false,"jwt":false,"logs":false,"metricsSDK":false},"pages":{"not_found":null},"privacy":{"openapi":"admin","password":null,"view":"public"},"refactored":{"status":"disabled","migrated":"unknown"},"seo":{"overwrite_title_tag":"disabled"},"plan":{"type":"business2018","grace_period":{"enabled":false,"end_date":null},"trial":{"expired":false,"end_date":"2022-12-06T18:16:24.937Z"}},"reference":{"api_sdk_snippets":"enabled","defaults":"always_use","json_editor":"disabled","oauth_flows":"disabled","request_history":"enabled","response_examples":"collapsed","response_schemas":"collapsed","sdk_snippets":{"external":"disabled"}},"health_check":{"provider":"none","settings":{"manual":{"status":"down","url":null},"statuspage":{"id":null}}},"integrations":{"aws":{"readme_webhook_login":{"region":null,"external_id":null,"role_arn":null,"usage_plan_id":null}},"bing":{"verify":null},"google":{"analytics":null,"site_verification":null},"heap":{"id":null},"koala":{"key":null},"localize":{"key":null},"postman":{"key":null,"client_id":null,"client_secret":null},"recaptcha":{"site_key":null,"secret_key":null},"segment":{"key":null,"domain":null},"speakeasy":{"key":null,"spec_url":null},"stainless":{"key":null,"name":null},"typekit":{"key":null},"zendesk":{"subdomain":null},"intercom":{"app_id":null,"secure_mode":{"key":null,"email_only":false}}},"permissions":{"appearance":{"private_label":"enabled","custom_code":{"css":"enabled","html":"enabled","js":"disabled"}},"branches":{"merge":{"admin":true}}},"appearance":{"brand":{"primary_color":null,"link_color":"#8f45e6","theme":"light"},"changelog":{"layout":"collapsed","show_author":true,"show_exact_date":false},"layout":{"full_width":"disabled","style":"classic"},"markdown":{"callouts":{"icon_font":"emojis"}},"table_of_contents":"enabled","whats_next_label":null,"footer":{"readme_logo":"hide"},"logo":{"size":"large","dark_mode":{"uri":null,"url":"https://files.readme.io/9f504ea-small-CPD_C-Logo_RGB_low.png","name":"CPD_C-Logo_RGB_low.png","width":80,"height":80,"color":"#000000","links":{"original_url":"https://files.readme.io/37519c1-CPD_C-Logo_RGB_low.png"}},"main":{"uri":null,"url":"https://files.readme.io/d20d0d2-small-CPD_C-Logo_RGB_low.png","name":"CPD_C-Logo_RGB_low.png","width":80,"height":80,"color":"#000000","links":{"original_url":"https://files.readme.io/945d379-CPD_C-Logo_RGB_low.png"}},"favicon":{"uri":null,"url":"https://files.readme.io/5f4c175-small-cpd_favicon.png","name":"cpd_favicon.png","width":32,"height":32,"color":"#000000","links":{"original_url":"https://files.readme.io/43707bd-cpd_favicon.png"}}},"custom_code":{"css":".markdown-body { \n font-family: \"Open Sans\",\"Helvetica Neue\",\"Helvetica\",\"Arial\",sans-serif !important;\n}\n\nh1, h2, h3, h4, h5, h6 {font-family: \"Open Sans\",\"Helvetica Neue\",\"Helvetica\",\"Arial\",sans-serif !important;}\n\n.heading-1 {\n padding-top: .4em;\n\tpadding-bottom: .5em; \n}\n\n.heading-2 {\n padding-top: .4em;\n\tpadding-bottom: .4em;\n}\n\n.heading-3, .heading-4 {\n padding-top: .5em;\n\tpadding-bottom: .3em;\n}\n\n\n.main-table tr .sub-heading{\n \n text-align : left;\n}\n\n.round-dots{\nlist-style-type: circle;\n\n}\n.col-txt{\n vertical-align: top;\n}\n.text-block{\n display : block; \n}\n\n.bullet-list{\n margin: 0 40px;\n list-style: circle !important;\n}\n\n.bullet-list.less-spacing{\n margin: 0 50px;\n padding: 0 !important;\n}\n\n.nested-table-wrapper{\n padding-bottom: 280px;\n position: relative;\n}\n\n.nested-table{\n\tposition: absolute;\n margin-top: -145px;\n}\n\n@media only screen and (max-width: 1300px){\n.nested-table{\n\tposition: static;\n margin-top: 0;\n}\n .nested-table-wrapper{\n \tpadding-bottom: 0;\n }\n}\n\n/**Helpers***/\n.left{\ntext-align: left;\n}\n.underline-text {\ntext-decoration: underline;\n display: inline;\n}\n.style-circle li {\n list-style: circle !important;\n}\n.style-alpha li {\n\t\tlist-style: lower-alpha;\n}\n/**Helpers-End***/","js":null,"html":{"header":"\n\n","home_footer":null,"page_footer":null}},"header":{"type":"line","gradient_color":null,"link_style":"buttons","overlay":{"fill":"auto","type":"triangles","position":"top-left","image":{"uri":null,"url":null,"name":null,"width":null,"height":null,"color":null,"links":{"original_url":null}}}},"ai":{"dropdown":"disabled","options":{"chatgpt":"enabled","claude":"enabled","clipboard":"enabled","copilot":"enabled","view_as_markdown":"enabled"}},"navigation":{"first_page":"landing_page","left":[],"logo_link":"homepage","page_icons":"enabled","right":[{"type":"user_controls","title":null,"url":null,"custom_page":null}],"sub_nav":[],"subheader_layout":"links","version":"disabled","links":{"home":{"label":"Home","visibility":"enabled"},"graphql":{"label":"GraphQL","visibility":"disabled"},"guides":{"label":"Guides","alias":null,"visibility":"enabled"},"reference":{"label":"API Reference","alias":null,"visibility":"disabled"},"recipes":{"label":"Recipes","alias":null,"visibility":"disabled"},"changelog":{"label":"Changelog","alias":null,"visibility":"disabled"},"discussions":{"label":"Discussions","alias":null,"visibility":"disabled"}}}},"git":{"connection":{"repository":{},"organization":null,"status":"inactive"}}}},"version":{"_id":"683f3826ef2131005dc4aaa4","version":"2.2.1","version_clean":"2.2.1","codename":"published 6/2025","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["65df665dc0373e0012b2671f","65df665dc0373e0012b2671f","637d11f9234e9b0099697a21","63f9089917a2c3000bb745ec","63f908a35c346f005ec48f8f","63f908a936e4890026cac28c","63f908b7104d73003b29a9dd","63f908c5488146003e11bc4a","63f908d190690f0018740987","63f908e45c346f005ec49118","63f908f2b46e8e0018c64334","63f9090188b25e0075bfb6fd","640233f1779f9600650a94fd","64089ed25ba213087efa7e2e","65df5c9d2f41d000111baa93","65df665ec0373e0012b26788","663a80d460cde700677088fb","65ea0e104ca63e004a1d8f12","683f3826ef2131005dc4aa36","683f3826ef2131005dc4aa37","67192ae574588c0045a0b9cd","66674781e10aad001eda7959","6669fd16bcf40100183d7130","6669fd1a47cf690019d619c6","67192ae574588c0045a0b9ce","683f3826ef2131005dc4aa38","683f3826ef2131005dc4aa39","683f3826ef2131005dc4aa3a","683f3826ef2131005dc4aa3b","67192ae574588c0045a0b9d3"],"pdfStatus":"complete","source":"readme","project":"637d11f8234e9b0099697a18","releaseDate":"2022-11-22T18:16:25.273Z","createdAt":"2025-06-03T18:00:06.642Z","__v":1,"updatedAt":"2025-06-09T15:29:41.078Z","forked_from":"67192ae574588c0045a0ba54","apiRegistries":[]}},"is404":false,"isDetachedProductionSite":false,"lang":"en","langFull":"Default","reqUrl":"/docs/initialize-request-params","version":{"_id":"683f3826ef2131005dc4aaa4","version":"2.2.1","version_clean":"2.2.1","codename":"published 6/2025","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["65df665dc0373e0012b2671f","65df665dc0373e0012b2671f","637d11f9234e9b0099697a21","63f9089917a2c3000bb745ec","63f908a35c346f005ec48f8f","63f908a936e4890026cac28c","63f908b7104d73003b29a9dd","63f908c5488146003e11bc4a","63f908d190690f0018740987","63f908e45c346f005ec49118","63f908f2b46e8e0018c64334","63f9090188b25e0075bfb6fd","640233f1779f9600650a94fd","64089ed25ba213087efa7e2e","65df5c9d2f41d000111baa93","65df665ec0373e0012b26788","663a80d460cde700677088fb","65ea0e104ca63e004a1d8f12","683f3826ef2131005dc4aa36","683f3826ef2131005dc4aa37","67192ae574588c0045a0b9cd","66674781e10aad001eda7959","6669fd16bcf40100183d7130","6669fd1a47cf690019d619c6","67192ae574588c0045a0b9ce","683f3826ef2131005dc4aa38","683f3826ef2131005dc4aa39","683f3826ef2131005dc4aa3a","683f3826ef2131005dc4aa3b","67192ae574588c0045a0b9d3"],"pdfStatus":"complete","source":"readme","project":"637d11f8234e9b0099697a18","releaseDate":"2022-11-22T18:16:25.273Z","createdAt":"2025-06-03T18:00:06.642Z","__v":1,"updatedAt":"2025-06-09T15:29:41.078Z","forked_from":"67192ae574588c0045a0ba54","apiRegistries":[]}}">
