See the following sections for descriptions of Pay By Link (PBL) request parameters:

For PBL sample code, see Pay By Link (PBL).

`payment_links`

The payment_links array is required, and it can contain up to 20 objects.

Each object in this array contains the following:

Name	Requirement	Format	Description
`account_id`	Required	Number	Storefront identifier number for the merchant in CellPoint Digital's echo system.
`amount`	Required	Object	See `amount`, below.
`client_id`	Required	Number	Merchant identifier number in CellPoint Digital's echo system.
`link_expiry`	Required	Object	See `link_expiry`, below.
`order_summary`	Required	Object	See `order_summary`, below.
`payment_link_source`	Required	Number	The type identifier for the payment link. This value should be `2`.

`amount`

Parent: payment_links

The amount object is required, and it contains the following name-value pairs:

Name	Requirement	Format of value	Description of value
`country_id`	Required	Integer	Represents mpoint country_id.
`currency_id`	Required	Integer	Represents mpoint currency_id.
`decimal`	Required	Integer	‭The currency decimal of the transaction amount. For example, if the amount is $2660.71, then the value of `decimal` is `2`.
`value`	Required	Integer	The original transaction amount without‬ decimal multiplied. For example, if `decimal` is `2`, then $2660.71 is represented in `value` as `266071`.

`link_expiry`

Parent: payment_links

The link_expiry object is required; it provides details about link expiration.

The link expiry object contains the following name-value pairs:

Name	Requirement	Format of value	Description of value
`expiry_type_id`	Required	Integer	A numeric identifier for the unit of time. Possible values: `1` - minutes `2` - hours `3` - days
`period`	Required	Integer	The amount of time after which the link expires, measured in the unit defined in `expiry_type_id`.

`order_summary`

Parent: payment_links

The order_summary object is required; it provides order details such as the order identifier, products purchased, amount, currency, and invoice details.

The order_summary object contains the following:

Name	Requirement	Format	Description
`order_data`	Optional	Object	See `order_data`, below.
`reference`	Required	String	Order identifier provided by merchant.‬

`order_data`

Parents: payment_links: order_summary

Note the following:

The order_data object is optional for airline order data; it provides standard airline order data in JSON format.
If order_data is present, it must contain the order object, which provides standard airline order data for the passenger name record (PNR).‬
If order is present, it must contain the line_items object.
If line_items is present, it must contain at least one line_item array. It may contain multiple line_item arrays.

Each line_item array element may contain the following values:

Name	Requirement	Format	Description
`additional_data`	Optional	Object	See `additional_data`, below. Applicable to airline order data.
`amount`	Conditional Requirement: Required in a `line_item` array element.	Integer	The amount charged for the line item, in the currency and format defined in `payment_links: amount`. Applicable to airline order data.
`fare_summary`	Optional	Object	See `fare_summary`, below. Applicable to airline order data.
`product`	Optional	Object	See `product`, below. Applicable to airline order data.

`additional_data`

Parents: payment_links: order_summary: order_data: order: line_items: line_item

Note the following:

The additional_data object in line_item is optional, and it contains the param array.
The param array provides additional parameters describing the line item.

Each element in the param array defines a parameter through name and text:

Name	Requirement	Format of value	Description of value
`name`	Optional	String	The parameter name. Applicable to airline order data.
`text`	Optional	String	The value of the parameter defined in `name`. Applicable to airline order data.

`fare_summary`

Parents: payment_links: order_summary: order_data: order: line_items: line_item

The fare_summary object is optional; it provides fare information for airline transactions. It has the following name-value pairs:

Name	Requirement	Format of value	Description of value
`base_fare`	Optional	Integer	The base fare amount of the line item, in the currency described in `currency`. Applicable to airline order data.
`currency`	Optional	String	The currency of the line item. Applicable to airline order data.
`service_charges`	Optional	Integer	The amount of service charges for the line item, in the currency described in `currency`. Applicable to airline order data.
`taxes_fees`	Optional	Integer	The amount of taxes and fees for the line item, in the currency described in `currency`. Applicable to airline order data.

`product`

Parents: payment_links: order_summary: order_data: order: line_items: line_item

The product object is optional for airline order data, and it may contain the following:

Name	Requirement	Format	Description
`additional_data`	Optional	Object	See `additional_data`, below. Applicable to airline order data.
`airline_data`	Optional	Object	See `airline_data`, below. Applicable to airline order data.
`name`	Optional	String	The merchant-generated name of the line item. Applicable to airline order data.
`sku`	Optional	String	The SKU of the line item. Applicable to airline order data.

`additional_data`

Parents: payment_links: order_summary: order_data: order: line_items: line_item: product

Note the following:

The additional_data object in product is optional, and it contains the param array.
The param array provides additional parameters describing the product.

Each element in the param array defines a parameter through name and text:

Name	Requirement	Format of value	Description of value
`name`	Optional	String	The parameter name. Applicable to airline order data.
`text`	Optional	String	The value of the parameter defined in `name`. Applicable to airline order data.

`airline_data`

Parents: payment_links: order_summary: order_data: order: line_items: line_item: product

The airline_data object is optional for airline order data, and it contains three objects: billing_summary, profiles, and trips. See their descriptions below.

`billing_summary`

Parents: payment_links: order_summary: order_data: order: line_items: line_item: product: airline_data

Note the following:

The billing_summary object is optional; it is applicable to airline order data.
The billing_summary object contains two objects: add_ons and fare_detail. See their descriptions below.

`add_ons`

Parents: payment_links: order_summary: order_data: order: line_items: line_item: product: airline_data: billing_summary

Note the following:

The add_ons object is optional; it describes additional charges in airline order data.
The add_ons object contains the add_on array.

Each object in the add_on array describes an additional charge through the following name-value pairs:

Name	Requirement	Format of value	Description of value
`amount`	Optional	Integer	The amount of the additional charge, in the currency defined in `currency`. Applicable to airline order data.
`currency`	Optional	String	The currency of the additional charge. Applicable to airline order data.
`description`	Optional	String	A description of the additional charge. Applicable to airline order data.
`product_category`	Optional	String	The product category of the additional charge. Applicable to airline order data.
`product_code`	Optional	String	The product code of the additional charge. Applicable to airline order data.
`product_item`	Optional	String	A description of the additional charge. Applicable to airline order data.
`profile_seq`	Optional	Integer	A numeric identifier for the profile assigned the additional charge. This is the `seq` value of the passenger in `profiles`. Applicable to airline order data.
`trip_seq`	Optional	Integer	A numeric identifier for the trip assigned the additional charge. This is the `seq` value of the trip in `trips`. Applicable to airline order data.
`trip_tag`	Optional	Integer	The trip tag associated with the additional charge. Applicable to airline order data.

`fare_detail`

Parents: payment_links: order_summary: order_data: order: line_items: line_item: product: airline_data: billing_summary

Note the following:

The fare_detail object is optional; it is applicable to airline data.
The fare_detail object contains the fare array.
The fare array provides information on one or more airline fares.

Each element in the fare array describes an airline fare through the following name-value pairs:

Name	Requirement	Format of value	Description of value
`amount`	Optional	Integer	The amount of the fare, in the currency defined in `currency`. Applicable to airline order data.
`currency`	Optional	String	The currency of the fare amount. Applicable to airline order data.
`description`	Optional	String	A description of the fare. Applicable to airline order data.
`product_category`	Optional	String	The product category of the fare. Applicable to airline order data.
`product_code`	Optional	String	The product code of the fare. Applicable to airline order data.
`product_item`	Optional	String	A description of the fare. Applicable to airline order data.
`profile_seq`	Optional	Integer	A numeric identifier for the profile assigned the fare. This is the `seq` value of the passenger in `profiles`. Applicable to airline order data.

`profiles`

Parents: payment_links: order_summary: order_data: order: line_items: line_item: product: airline_data

Note the following:

The profiles object is optional; it provides passenger information for airline order data.
The profiles object contains the profile array.
profile is an array of profile information about one or more passengers.

Each object in the profile array provides profile information on one passenger through the following:

Name	Requirement	Format	Description
`contact_info`	Optional	Object	See `contact_info`, below. Applicable to airline order data.
`first_name`	Optional	String	The passenger's first name. Applicable to airline order data.
`last_name`	Optional	String	The passenger's last name. Applicable to airline order data.
`seq`	Optional	Integer	The sequence number of the passenger in this order. Applicable to airline order data.
`type`	Optional	String	The passenger type, such as adult (`ADT`), child (`CHD`), or infant (`INF`). Find all possible values in Reference. Applicable to airline order data.

`contact_info`

Parents: payment_links: order_summary: order_data: order: line_items: line_item: product: airline_data: profiles: profile

Please note:

If the profile array is present, the contact_info object is required for one passenger.
The contact_info object provides contact details for the customer to whom the payment link is to be sent.

The contact_info object contains the following:

Name	Requirement	Format	Description
`email`	Conditional Requirement: Required if `profile` is present.	String	The email address of the customer to whom the payment link is to be sent. Applicable to airline order data.
`mobile`	Conditional Requirement: Required if `profile` is present.	Object	See `mobile`, below. Applicable to airline order data.

`mobile`

Parents: payment_links: order_summary: order_data: order: line_items: line_item: product: airline_data: profiles: profile: contact_info

The mobile object is required if profile is present; it describes the phone number of the customer to whom the payment link is to be sent through the following name-value pairs:

Name	Requirement	Format of value	Description of value
`country_id`	Conditional Requirement: Required if `profile` is present.	Integer	The country ID of the phone number defined in `text`. Applicable to airline order data.
`text`	Conditional Requirement: Required if `profile` is present.	Integer	The contact phone number of the customer to whom the payment link is to be sent. Applicable to airline order data.

`trips`

Parents: payment_links: order_summary: order_data: order: line_items: line_item: product: airline_data

Please note:

The trips object can contain multiple trip arrays.
Each trip array describes one trip in the journey.

Each element of a trip array may contain the following:

Name	Requirement	Format	Description
`additional_data`	Optional	Object	See `additional_data`, below.
`arrival_time`	Optional	String, in `YYYY-MM-DDTHH:MM:SS` format	The arrival time in the destination time zone. (See `destination`.) Applicable to airline order data.
`booking_class`	Optional	String	The booking class. Applicable to airline order data.
`departure_time`	Optional	String, in `YYYY-MM-DDTHH:MM:SS` format	The departure time in the origin time zone. (See `origin`.) Applicable to airline order data.
`destination`	Optional	Object	See `destination`, below.
`origin`	Optional	Object	See `origin`, below.
`seq`	Optional	Integer	The sequence number of this trip in the journey. Applicable to airline order data.
`service_level`	Optional	String	The service level of this trip. Applicable to airline order data.
`tag`	Optional	Integer	The tag associated with this trip. Applicable to airline order data.
`transportation`	Optional	Object	See `transportation`, below. Applicable to airline order data. Applicable to airline order data.

`additional_data`

Parents: payment_links: order_summary: order_data: order: line_items: line_item: product: airline_data: trips: trip

Note the following:

The additional_data object in trip is optional, and it contains the param array.
The param array provides additional parameters describing the trip.

Each element in the param array defines a parameter through name and text:

Name	Requirement	Format of value	Description of value
`name`	Optional	String	The parameter name. Applicable to airline order data.
`text`	Optional	String	The parameter value. Applicable to airline order data.

`destination`

Parents: payment_links: order_summary: order_data: order: line_items: line_item: product: airline_data: trips: trip

The destination object describes the trip destination by containing the following name-value pairs:

Element	Requirement	Format of text content	Description of text content
`country_id`	Optional	Integer	The numeric ID for the trip destination's country. Applicable to airline order data.
`external_id`	Optional	String	A three-letter ID for the trip destination. Applicable to airline order data.
`text`	Optional	String	The name or identifier for the trip destination. Applicable to airline order data.
`time_zone`	Optional	String	The time zone of the trip destination, expressed as GMT offset. Applicable to airline order data.

`origin`

Parents: payment_links: order_summary: order_data: order: line_items: line_item: product: airline_data: trips: trip

The origin object describes the trip's origin by containing the following name-value pairs:

Element	Requirement	Format of text content	Description of text content
`country_id`	Optional	Integer	The numeric ID for the trip's country of origin. Applicable to airline order data.
`external_id`	Optional	String	A three-letter ID for the trip's origin. Applicable to airline order data.
`terminal`	Optional	String	The terminal from which the trip originates. Applicable to airline order data.
`text`	Optional	String	The name or identifier for the trip's origin. Applicable to airline order data.
`time_zone`	Optional	String	The time zone of the trip's origin, expressed as GMT offset. Applicable to airline order data.

`transportation`

Parents: payment_links: order_summary: order_data: order: line_items: line_item: product: airline_data: trips: trip

The transportation object is optional; it describes the transportation used for the trip. It has the following children:

Name	Requirement	Format	Description
`carriers`	Optional	Object	See `carriers`, below. Applicable to airline order data.
`code`	Optional	String	The code of the airline carrier used for this trip. Applicable to airline order data.
`number`	Optional	Integer	The flight number of this trip. Applicable to airline order data.

`carriers`

Parents: payment_links: order_summary: order_data: order: line_items: line_item: product: airline_data: trips: trip: transportation

Please note:

The carriers object is optional; it describes at least one airline carrier for a trip.
The carriers object contains the carrier array.

Each element in a carrier array provides information on the carrier used for one portion of a trip through the following name-value pairs:

Element	Requirement	Format of text content	Description of text content
`code`	Optional	String	The code of the airline carrier used for this portion of the trip. Applicable to airline order data.
`number`	Optional	Integer	The flight number of this portion of the trip. Applicable to airline order data.
`type`	Optional	String	The type of airplane for this portion of the trip. Applicable to airline order data.