Webhook Parameters

Reference

This page provides sample code and a description of the parameters included in CellPoint Digital Velocity's webhook callback requests. For an integration guide, see Webhooks. For the status changes for which Velocity sends callback requests, see Webhook Status Codes.

Sample callback

Below is a sample payload of the JSON callback request sent to the merchant:

{
	"client_id": 10018,
	"account_id": 1100,
	"session_id": 1234,
	"session_type":1,
	"callback_url": "callback",
	"sale_amount": { 
		"value": 1000, 
		"currency_id": 840,
		"decimals": 2, 
		"alpha3code": "PHP",
		"conversion_rate": 1
	},
	"pending_amount": { 
		"value": 1000, 
		"currency_id": 840,
		"decimals": 2,
		"alpha3code": "PHP",
		"conversion_rate": 1
	},
	"status": { 
		"code": 2000,
		"sub_code": 20102,
		"message": "message"
	},
	"additional_data": [
		{
			"name": "name",
			"text": "value"
		}
	],
	"transactions": [ 
		{
		"id": 1, 
		"route_config_id": 12,
		"order_id": "order_id",
		"description": "description",
		"fee": 0, 
		"hmac": "sdsfsfdsd", 
		"approval_code": "approval-code", 
		"wallet_id": "wallet-id", 
		"txn_type_id": 1, 
		"payment_method": "payment-method", 
		"payment_type": "payment-type", 
		"short_code": "short-code",
		"date_time": "date-time", 
		"local_date_time": "local-date-time", 
		"issuing_bank": "issuing-bank", 
		"foreign_exchange_id": 1, 
		"service_type_id":1, 
		"pos": 640, 
		"ip_address": "106.202.163.166", 
		"installment":0, 
		"accept_url": "//accept_url",
		"cancel_url": "//cancel_url",
		"amount": { 
			"value": 1000,
			"currency_id": 840,
			"decimals": 2,
			"alpha3code": "PHP",
			"conversion_rate": 1
			},
		"status": { 
			"code": 2000,
			"sub_code": 20102, 
			"message": "message", 
			"provider_message" : "provider_message", 
			"provider_status_code" : "code" 
			},
		"psp" : {
			"id": 18, 
			"name": "Wirecard", 
			"external-id": "external-id"
			},
		"card" : {
			"id": 7, 
			"name":"VISA",
			"mask_card_number": "4444********1111", 
			"expiry": "expiry",
			},
		"customer_info" : {
			"email": "email", 
			"country_id": 123, 
			"mobile": "9876543210", 
			"operator": 20000, 
			"language": "en", 
			"device_id": "device-id" 
			},
		"additional_data": [ 
			{
				"name": "name", 
				"text": "value" 
			}
		],
		"client_data": [ 
			{
				"name": "name", 
				"text": "value" 
			}
		],
		"product_info": [ 
			{
				"name": "name", 
				"quantity": 1, 
				"price": 1 
			}
		],
		"delivery_info": [ 
			{
				"name": "name", 
				"text": "value" 
			}
		],
		"shipping_info": [ 
			{
				"name": "name", 
				"text": "value" 
			}
		],
		"billing_address": { 
			"first_name": "First", 
			"last_name": "Last", 
			"street": "Test St.", 
			"city": "Test City", 
			"state": "Abra", 
			"country": "Philippines", 
			"postal_code": "12345", 
			"alpha2code": "PH",
			"mobile": "9999999999", 
			"email": "[email protected]", 
			"billing_idc": "1" 
			},
		"fraud": { 
			"status_code": "Post Auth Success", 
			"status_desc": "Post Auth Success", 
			"post_auth_ext_id": "6255590973676885104011", 
			"post_auth_ext_status_code": "ACCEPT", 
			"pre_auth_ext_id":"77777777", 
			"pre_auth_ext_status_code" : "ACCEPT" 
			},	 
		"order_data": { 
			"ticket_no": 12345, 
			"profiles": [ 
				{
					"id": 1, 
					"title": "Title1", 
					"first_name": "fName", 
					"last_name": "lName", 
					"type": "ADT", 
					"email": "[email protected]", 
					"mobile": "8989898989", 
					"country_id": "130", 
					"amount": "20000", 
					"seq": "1", 
					"additional_data": [ 
						{
							"name": "name1",
							"value": "val1"
						},
						{
							"name": "name2",
							"value": "val2"
						}
					]
				}
			],
			"trips": [
				{
					"id": 1, 
					"service_class": "G",  
					"departure_airport": "DVO", 
					"arrival_airport": "MNL", 
					"op_airline_code": "5J", 
					"mkt_airline_code": "1", 
					"arrival_date": "2028-05-21 01:20:00", 
					"departure_date": "2028-05-20 23:20:00",  
					"additional_data": [ 
						{
							"name": "name1",
							"value": "val1"
						},
						{
							"name": "name2",
							"value": "val2"
						}
					],	
					"mkt_flight_number": "962",  
					"op_flight_number": "XYZ", 
					"tag": "1", 
					"trip_count": "1", 
					"service_level": "3",  
					"departure_country_id": "130", 
					"arrival_country_id": "150",  
					"dept_time_zone": "+08:00", 
					"arrival_time_zone": "+08:00",  
					"arrival_terminal": "testAT1", 
					"dept_terminal": "testDT1",  
					"dept_city": "Francisco Bangoy International Airport", 
					"arrival_city": "Ninoy Aquino International Airport",  
					"aircraft_type": "1" 
				} 
			],
			"billing_summary": { 
				"fare_details": [ 
					{
						"id": 1, 
						"journey_ref": "", 
						"bill_type": "Fare", 
						"description": "Localization Key - SEAT PRICE",  
						"amount": "20000", 
						"currency": "PHP", 
						"profile_seq": "1", 
						"trip_tag": "1", 
						"trip_seq": "1", 
						"product_code": "YSTR",  
						"product_category": "TAX", 
						"product_item": "Sales Tax Colombia" 
					}
				],
				"add_on": [ 
					{ 
						"id": 4, 
						"journey_ref": "", 
						"bill_type": "Addon", 
						"description": "Localization Key - SEAT PRICE",  
						"amount": "20000", 
						"currency": "PHP",  
						"profile_seq": "2",  
						"trip_tag": "2", 
						"trip_seq": "2", 
						"product_code": "YSTR", 
						"product_category": "TAX", 
						"product_item": "Sales Tax Colombia"  
					} 
				]
			}
			},
		},
	],
  "signature": "175f37bb6094bbb...",
  "endpoint_url" : "https://example.dev/cmd/callback/notify_client",
  "content_type" : "3",
  "max_retry" : "3",
  "event_type" : "PAYMENT_EVENT",
  "event_subtype" : "PAYMENT_TRANSACTION_EVENT"
}

JSON callback parameters

Content-type: application/json
HTTP: POST

The following parameters are sent in the callback:

ParameterFormatRequirementDescription
client_idIntegerRequiredThe client ID shared by CellPoint Digital.
account_idIntegerRequiredThe account ID shared by CellPoint Digital.
session_idIntegerRequiredThe CellPoint Velocity session ID for the payment transaction.
session_typeStringOptionalThe type of session. Possible values:
  • 1 - Normal Payment
  • 2 - Split Payment
callback_urlStringOptionalThe callback URL.
sale_amountObjectRequiredThis object describes the original/checkout/sale amount. See the sale_amount section below for its contents.
pending_amountObjectOptionalThis object describes the pending amount. See the pending_amount section below for its contents.
statusObjectRequiredThis object describes the status of the transaction. See the status section below for its contents.
additional_dataArrayOptionalThis array provides additional data. See the additional_data section below for its contents.
transactionsArrayRequiredThis array provides information on one or more transactions. See the transactions section below for its contents.
signatureStringOptionalThe HMAC signature.
endpoint_urlStringOptionalInternal code.
content_typeIntegerOptionalInternal code.
max_retryIntegerOptionalInternal code.
event_typeStringOptionalInternal code.
event_subtypeStringOptionalInternal code.

sale_amount

The sale_amount object is required, and it has the following children:

ParameterFormatRequirementDescription
valueIntegerRequiredThe original/checkout/sale amount in the lowest denomination of the currency used according to ISO-4217. For example, USD 481.00 is sent as 48100.
currency_idIntegerRequiredThe numeric ISO-4217 currency ID.
decimalsIntegerOptionalThe currency precision, expressed in the number of digits after the decimal separator. Possible values: 0, 2, 3.
alpha3codeStringOptionalThe 3-letter alpha ISO-4217 currency code.
conversion_rateIntegerOptionalThe conversion rate.

pending_amount

The pending_amount object is optional, and it has the following children:

ParameterFormatRequirementDescription
valueIntegerConditional Requirement: Required if pending_amount is present.The original/checkout/sale amount in the lowest denomination of the currency used according to ISO-4217. For example, USD 481.00 is sent as 48100.
currency_idIntegerConditional Requirement: Required if pending_amount is present.The numeric ISO-4217 currency ID.
decimalsIntegerOptionalThe currency precision, expressed in the number of digits after the decimal separator.
alpha3codeStringOptionalThe 3-letter alpha ISO-4217 currency code.
conversion_rateNumberOptionalThe conversion rate.

status

The status object is required, and it has the following children:

ParameterFormatRequirementDescription
codeIntegerRequiredA code indicating the status of the transaction.
sub_codeIntegerOptionalA subcode giving further information on the status of the transaction.
messageStringRequiredThe status message of a session.

additional_data

The additional_data array is optional. Each element in the array must have the following parameters:

ParameterFormatRequirementDescription
nameStringConditional Requirement: Required if additional_data is present.The name of the name-value pair.
textStringConditional Requirement: Required if additional_data is present.The value of the name-value pair.

transactions

The transactions array is required. Each object in the array describes one transaction, and it contains the following:

ParameterFormatRequirementDescription
idIntegerRequiredCellPoint Digital's unique ID for the payment transaction.
route_config_idIntegerRequiredThe route configuration ID. If legacy routing is configured for the merchant, then this value is 0.
order_idStringRequiredThe order ID that the merchant originally provided when the transaction was initiated. For airlines, this is the passenger number record (PNR).
descriptionStringOptionalA description of the transaction.
feeIntegerOptionalA fee that the merchant charges a customer in the lowest denomination of the currency used according to ISO-4217. For example, USD 481.00 is sent as 48100.

If not applicable, this value defaults to 0.
hmacStringConditional RequirementThe 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 in Reference.

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 MAC is unique.

Note: CellPoint Digital provides the salt value to merchants. Conditional parameters in the Message Authentication Code table are optional in hmac if not provided in request; if those parameters are present in request, they are mandatory in hmac.
approval_codeStringOptionalThe approval code provided by the PSP for a transaction. Available for card payments only.
wallet_idStringOptionalThe ID of the wallet used. This will be present for wallet-based transactions only.
txn_type_idIntegerRequiredThe transaction type ID. See Reference for possible values.
payment_methodStringRequiredThe type of method used for payment. Possible values:
  • DD - Direct Debit (Online payment)
  • CD - Credit/Debit Card (Card payment)
  • eWallet - Wallet
  • Cash - Other payment methods
payment_typeStringRequiredThe numerical code for the type of payment. See Reference for possible values.
short_codeStringConditional Requirement: This can be mandatory or optional, depending on configuration.The short code for the payment.
date_timeString, in YYYY-MM-DDTHH:MM:SS formatRequiredThe date and time when the transaction was initiated in UTC.
local_date_timeStringOptionalThe merchant's time and date when the transaction was initiated (if the time zone is set up for the merchant during onboarding).

The attribute name will not be available if this is not sent.
issuing_bankStringOptionalThe issuing bank name for a payment transaction requested through an online banking payment option, if available.

The attribute name will not be available if this is not sent.
foreign_exchange_idStringOptionalThe foreign exchange ID. This is a unique CellPoint Digital-specific identification number for a currency exchange offer.
service_type_idIntegerOptionalA 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.
posIntegerOptionalThe point of sale of the transaction, expressed as the country ID. See Reference for possible values.
ip_addressStringOptionalThe IP address of the transaction initiation.
installmentIntegerOptionalThe number of installments selected if a customer chooses to pay in installments.
accept_urlStringOptionalThe accept URL.
cancel_urlStringOptionalThe cancel URL.
amountObjectRequiredTransaction amount details. See the amount section below.
sale_amountObjectOptionalSale amount details.

The structure of this object is identical to that of the sale_amount object at the same hierarchical level as transactions. For more information, refer to that object's description in the sale_amount section above.
statusObjectRequiredTransaction status details. See the status section below.
pspObjectConditional Requirement: This object may be mandatory or optional, depending on the PSP.Payment service provider (PSP) details. See the psp section below.
cardObjectOptionalCard details. See the card section below.
rebilling_infoObjectConditional Requirement: This can be mandatory or optional, depending on configuration.Rebilling information for Merchant Initiated Transaction (MIT) or Customer Initiated Transaction (CIT). See the rebilling_info section below.
customer_infoObjectRequiredCustomer information. See the customer_info section below.
additional_dataArrayOptionalAdditional data.

The structure of this array is identical to that of the additional_data object at the same hierarchical level as transactions. For more information, refer to that array's description in the additional_data section above.
client_dataArrayOptionalClient data. See the client_data section below.
product_infoArrayOptionalProduct information. See the product_info section below.
delivery_infoArrayOptionalDelivery information. See the delivery_info section below.
shipping_infoArrayOptionalShipping information. See the shipping_info section below.
billing_addressObjectOptionalThe billing address. See the billing_address section below.
fraudObjectConditional Requirement: This can be mandatory or optional, depending on configuration.Fraud details. See the fraud section below.
tms_infoObjectConditional Requirement: This can be mandatory or optional, depending on configuration.TMS information. See the tms_info section below.
order_dataObjectOptionalOrder data. This can include Airline Itinerary Data (AID). See the order_data section below.

amount

Parent: transactions

The amount object is required, and it contains the following children:

NameFormatRequirementDescription
valueIntegerRequiredThe transaction amount, expressed as an integer including the precision of decimals in amount. For example, if decimals is 2 and value is 12030, the transaction amount is 120.30.
currency_idIntegerRequiredThe currency ID for the transaction amount. See Reference for possible values.
decimalsIntegerOptionalThe currency precision for the transaction amount; for example, 2 for USD (which is written with two units after the decimal, as in $1.00.)
alpha3codeStringOptionalThe alpha-3 currency code for the transaction amount. See Reference for possible values.
conversion_rateIntegerOptionalThe conversion rate.

sale_amount

Parent: transactions

The sale_amount object in transactions is required. Its structure is identical to that of the sale_amount object at the same hierarchical level as transactions. For more information, refer to that object's description in the sale_amount section above.

status

Parent: transactions

The status object in transactions is required, and it has the following children:

ParameterFormatRequirementDescription
codeIntegerRequiredA code indicating the status of the transaction.
sub_codeIntegerOptionalA subcode giving further information on the status of the transaction.
messageStringRequiredThe status message of a session.
provider_messageStringOptionalThe provider message.
provider_status_codeStringOptionalThe provider status code.

psp

Parent: transactions

The psp object may be mandatory or optional, depending on the payment service provider (PSP). It has the following children:

NameFormatRequirementDescription
idIntegerConditional Requirement: This may be mandatory or optional, depending on the PSP.The PSP ID. This is provided by CellPoint Digital for internal reference.
nameStringConditional Requirement: This may be mandatory or optional, depending on the PSP.The PSP name.
external-idStringConditional Requirement: This may be mandatory or optional, depending on the PSP.The PSP external ID.

card

Parent: transactions

The card object is optional, and it has the following children:

NameFormatRequirementDescription
idIntegerOptionalThe card ID. See Reference for possible values.
nameStringOptionalThe card name.
mask_card_numberStringOptionalThe masked card number (with the first six and last four digits visible), if present for the transaction.
expiryStringOptionalThe masked card expiry date (in YYYY-MM format), if present for the transaction. This is available for card payments only.

If not applicable, defaults to this value: -

rebilling_info

Parent: transactions

The rebilling_info object can be mandatory or optional, depending on configuration, and it has the following children:

NameFormatRequirementDescription
idIntegerOptionalThe rebilling info ID.
frequencyIntegerOptionalThe rebilling frequency.
expiryStringOptionalThe expiry date.

customer_info

Parent: transactions

The customer_info object is required, and it has the following children:

NameFormatRequirementDescription
emailStringOptionalThe customer's email address.
country_idIntegerOptionalThe CellPoint Digital mobile country ID. See Reference for possible values.
mobileStringOptionalThe MSISDN of the end customer without an International Code (if available).

Defaults to0 if not applicable or available.
operatorIntegerOptionalThe ID of a customer’s Mobile Network Operator as per CellPoint Digital's defined codes:
  • A typical value is the value of country_id multiplied by 100 (if available).
  • Defaults to 0 if not applicable.
languageStringRequiredThe default language encoding selected during client onboarding. This includes:
  • DA - Danish
  • EN - English
  • ES - Spanish
  • GB - UK English
  • PT - Portuguese
  • SV - Spanish Salvador
  • US - United States English
device_idStringOptionalThe device ID of the customer (if available).

additional_data

Parent: transactions

The additional_data array in transactions is optional. Its structure is identical to that of the additional_data array at the same hierarchical level as transactions. For more information, refer to that array's description in the additional_data section above.

client_data

Parent: transactions

The client_data array is optional. Each element in the array must have the following parameters:

ParameterFormatRequirementDescription
nameStringConditional Requirement: Required if client_data is present.The client data name.
textStringConditional Requirement: Required if client_data is present.The client data value.

product_info

Parent: transactions

The product_info array is optional. Each element in the array must have the following parameters:

ParameterFormatRequirementDescription
nameStringConditional Requirement: Required if product_info is present.The product name.
quantityIntegerConditional Requirement: Required if product_info is present.The quantity.
priceIntegerConditional Requirement: Required if product_info is present.The price.

delivery_info

Parent: transactions

The delivery_info array is optional. Each element in the array must have the following parameters:

ParameterFormatRequirementDescription
nameStringConditional Requirement: Required if delivery_info is present.The delivery info name.
textStringConditional Requirement: Required if delivery_info is present.The delivery info value.

shipping_info

Parent: transactions

The shipping_info array is optional. Each element in the array must have the following parameters:

ParameterFormatRequirementDescription
nameStringConditional Requirement: Required if shipping_info is present.The shipping info name.
textStringConditional Requirement: Required if shipping_info is present.The shipping info value.

billing_address

Parent: transactions

The billing_address object is optional, and it has the following children:

ParameterFormatRequirementDescription
first_nameStringConditional Requirement: Required if billing_address is present.The first name in the cardholder billing address.
last_nameStringConditional Requirement: Required if billing_address is present.The last name in the cardholder billing address.
streetStringOptionalThe street address in the cardholder billing address.
cityStringOptionalThe city name in the cardholder billing address.
stateStringOptionalThe cardholder billing address state/region as provided by the user.
countryStringOptionalThe cardholder billing address country code, as per CellPoint Digital's defined codes. See Reference for possible values.
postal_codeStringOptionalThe zip code or postal code in the cardholder billing address.
alpha2codeStringOptionalThe alpha-2 country code.
mobileStringOptionalThe cardholder's mobile number.
emailStringOptionalThe cardholder's email address.
billing_idcIntegerOptionalThe cardholder's mobile dialling country code, provided as per ISO IDC codes.

fraud

Parent: transactions

The fraud object can be mandatory or optional, depending on configuration, and it has the following children:

NameFormatRequirementDescription
status_codeStringConditional Requirement: Required if fraud is present.The final fraud status code; for example, 3011 or 3111 if the fraud flow is executed.
status_descStringConditional Requirement: Required if fraud is present.The final fraud status description; for example, Accepted or Review if the fraud flow is executed.
post_auth_ext_idStringOptionalThe post-auth fraud check system transaction ID, if the post-auth fraud flow is executed.
post_auth_ext_status_codeStringOptionalThe post-auth fraud check system response code, if the post-auth fraud flow is executed.
pre_auth_ext_idStringOptionalThe pre-auth fraud check system transaction ID, if the pre-auth fraud flow is executed.
pre_auth_ext_status_codeStringOptionalThe pre-auth fraud check system response code, if the pre-auth fraud flow is executed.
pre_auth_provider_idIntegerOptionalThe pre-auth provider ID.
post_auth_provider_idIntegerOptionalThe post-auth provider ID.
pre_auth_fraud_statusIntegerOptionalThe pre-auth fraud status.
post_auth_fraud_statusIntegerOptionalThe post-auth fraud status.

tms_info

Parent: transactions

The tms_info object can be mandatory or optional, depending on configuration, and it has the following children:

NameFormatRequirementDescription
tms_provider_codeIntegerOptionalThe TMS provider code; for example, 403.
tms_provider_messageStringOptionalThe TMS provider message; for example, The IP Address is invalid.

order_data

Parent: transactions

The order_data object is optional, and it has the following children:

NameFormatRequirementDescription
product_skuStringOptionalThe short code for travel itinerary; for example, PNR and order number.
amountObjectOptionalTransaction amount details.

The structure of this object is identical to that of the amount object that is a child of transactions. For more information, refer to that object's description in the amount section above.
ticket_noStringOptionalThe ticket number.
profilesArrayOptionalAn array of profile objects, which provides traveler information for the travel itinerary. See the profiles section below.
tripsArrayOptionalAn array of the trip object, which provides trip information for the travel itinerary. See the trips section below.
billing_summaryObjectOptionalThe billing summary for the order, which includes an array of fare details and billing add-ons for the travel itinerary. See the billing_summary section below.

profiles

Parents: transactions: order_data

The profiles array is optional. Each element in the array has the following parameters:

NameFormatRequirementDescription
idIntegerConditional Requirement: Required if profiles is present.The passenger's profile ID.
titleStringOptionalThe title of a passenger, such as Mr., Mrs., or Ms.
first_nameStringOptionalFirst name of the passenger.
last_nameStringOptionalLast name of the passenger.
typeStringOptionalThe type of a passenger, such as adult, child, or infant.
emailStringOptionalThe email ID of a passenger.
mobileIntegerOptionalThe mobile number of the passenger.
country_idStringOptionalCountry ID.
amountStringOptionalAmount.
seqIntegerOptionalThe sequence number of the passenger
additional_dataArrayOptionalAn array of additional data in name-value pairs.

The structure of this array is identical to that of the additional_data object at the same hierarchical level as transactions. For more information, refer to that array's description in the additional_data section above.

trips

Parents: transactions: order_data

The trips array is optional. Each element in the array has the following parameters:

NameFormatRequirementDescription
idIntegerOptionalTrip ID.
service_classStringOptionalThe booking class (RBD – first letter of fare-basis); for example, H.
departure_airportStringOptionalDeparture airport code.
arrival_airportStringOptionalArrival airport code.
op_airline_codeStringOptionalThe 2-letter airline code.
mkt_airline_codeStringOptionalThe 2-letter airline code of the operating airline.
arrival_dateStringOptionalThe date and time of arrival, in YYYY-MM-DD HH:MM:SS format.
departure_dateStringOptionalThe date and time of departure, in YYYY-MM-DD HH:MM:SS format.
additional_dataArrayOptionalAn array of additional data in name-value pairs.

The structure of this array is identical to that of the additional_data object at the same hierarchical level as transactions. For more information, refer to that array's description in the additional_data section above.
mkt_flight_numberStringOptionalFlight number.
op_flight_numberStringOptionalFlight number of the operating flight.
tagStringOptionalThe sequence of this trip in the journey.
trip_countStringOptionalNumber of trip sequences in the journey.
service_levelStringOptionalThe cabin class opted; for example, XL, X, M, or S.
departure_country_idStringOptionalDeparture country ID.
arrival_country_idStringOptionalArrival country ID.
dept_time_zoneStringOptionalThe local time zone of the flight origin, such as -5:00.
arrival_time_zoneStringOptionalThe local time zone of the flight arrival, such as -5:00.
arrival_terminalStringOptionalArrival terminal.
dept_terminalStringOptionalDeparture terminal.
dept_cityStringOptionalDeparture city.
arrival_cityStringOptionalArrival airport city.
aircraft_typeStringOptionalThe aircraft type; for example, Airbus A380.

billing_summary

Parents: transactions: order_data

The billing_summary array is optional. Each element in the array has the following parameters:

NameFormatRequirementDescription
fare_detailsArrayOptionalThe fare details of the journey. See the fare_details section below.
add_onArrayOptionalFees for ancillary services. See the add_on section below.

fare_details

Parents: transactions: order_data: billing_summary

The fare_details array is optional. Each element in the array has the following parameters:

NameFormatRequirementDescription
idIntegerRequiredThe ID of this fare.
journey_refStringOptionalJourney reference.
bill_typeStringOptionalBill type.
descriptionStringOptionalThe description of the fare in this object.
amountStringOptionalThe fare amount.
currencyStringOptionalThe alpha3 ISO currency code of the fare amount.
profile_seqStringOptionalThe sequence number of the passenger linked to this fare detail.
trip_tagStringOptionalThe tag number associated with a trip, which helps identify a trip.
trip_seqStringOptionalThe trip sequence number to identify this trip in the journey.
product_codeStringOptionalThe code number to identify the product.
product_categoryStringOptionalThe code number to identify the product category.
product_itemStringOptionalThe code number to identify the product item.

add_on

Parents: transactions: order_data: billing_summary

The add_on array is optional. Each element in the array has the following parameters:

NameFormatRequirementDescription
idIntegerRequiredThe ID of this add-on ancillary.
journey_refStringOptional
bill_typeStringOptional
descriptionStringOptionalThe description of the add-on fee in this object.
amountStringOptionalThe amount of the add-on fee.
currencyStringOptionalThe alpha3 ISO currency code of the add-on amount.
profile_seqStringOptionalThe sequence number of the passenger linked to this add-on.
trip_tagStringOptionalThe tag number associated with a trip, which helps identify a trip.
trip_seqStringOptionalThe trip sequence number to identify this trip in the journey.
product_codeStringOptionalThe code number to identify the add-on product.
product_categoryStringOptionalThe code number to identify the add-on product category.
product_itemStringOptionalThe code number to identify the add-on product item.