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:
Parameter | Format | Requirement | Description |
---|---|---|---|
client_id | Integer | Required | The client ID shared by CellPoint Digital. |
account_id | Integer | Required | The account ID shared by CellPoint Digital. |
session_id | Integer | Required | The CellPoint Velocity session ID for the payment transaction. |
session_type | String | Optional | The type of session. Possible values:
|
callback_url | String | Optional | The callback URL. |
sale_amount | Object | Required | This object describes the original/checkout/sale amount. See the sale_amount section below for its contents. |
pending_amount | Object | Optional | This object describes the pending amount. See the pending_amount section below for its contents. |
status | Object | Required | This object describes the status of the transaction. See the status section below for its contents. |
additional_data | Array | Optional | This array provides additional data. See the additional_data section below for its contents. |
transactions | Array | Required | This array provides information on one or more transactions. See the transactions section below for its contents. |
signature | String | Optional | The HMAC signature. |
endpoint_url | String | Optional | Internal code. |
content_type | Integer | Optional | Internal code. |
max_retry | Integer | Optional | Internal code. |
event_type | String | Optional | Internal code. |
event_subtype | String | Optional | Internal code. |
sale_amount
sale_amount
The sale_amount
object is required, and it has the following children:
Parameter | Format | Requirement | Description |
---|---|---|---|
value | Integer | Required | 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_id | Integer | Required | The numeric ISO-4217 currency ID. |
decimals | Integer | Optional | The currency precision, expressed in the number of digits after the decimal separator. Possible values: 0 , 2 , 3 . |
alpha3code | String | Optional | The 3-letter alpha ISO-4217 currency code. |
conversion_rate | Integer | Optional | The conversion rate. |
pending_amount
pending_amount
The pending_amount
object is optional, and it has the following children:
Parameter | Format | Requirement | Description |
---|---|---|---|
value | Integer | Conditional 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_id | Integer | Conditional Requirement: Required if pending_amount is present. | The numeric ISO-4217 currency ID. |
decimals | Integer | Optional | The currency precision, expressed in the number of digits after the decimal separator. |
alpha3code | String | Optional | The 3-letter alpha ISO-4217 currency code. |
conversion_rate | Number | Optional | The conversion rate. |
status
status
The status
object is required, and it has the following children:
Parameter | Format | Requirement | Description |
---|---|---|---|
code | Integer | Required | A code indicating the status of the transaction. |
sub_code | Integer | Optional | A subcode giving further information on the status of the transaction. |
message | String | Required | The status message of a session. |
additional_data
additional_data
The additional_data
array is optional. Each element in the array must have the following parameters:
Parameter | Format | Requirement | Description |
---|---|---|---|
name | String | Conditional Requirement: Required if additional_data is present. | The name of the name-value pair. |
text | String | Conditional Requirement: Required if additional_data is present. | The value of the name-value pair. |
transactions
transactions
The transactions
array is required. Each object in the array describes one transaction, and it contains the following:
Parameter | Format | Requirement | Description |
---|---|---|---|
id | Integer | Required | CellPoint Digital's unique ID for the payment transaction. |
route_config_id | Integer | Required | The route configuration ID. If legacy routing is configured for the merchant, then this value is 0 . |
order_id | String | Required | The order ID that the merchant originally provided when the transaction was initiated. For airlines, this is the passenger number record (PNR). |
description | String | Optional | A description of the transaction. |
fee | Integer | Optional | A 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 . |
hmac | String | Conditional Requirement | 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 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_code | String | Optional | The approval code provided by the PSP for a transaction. Available for card payments only. |
wallet_id | String | Optional | The ID of the wallet used. This will be present for wallet-based transactions only. |
txn_type_id | Integer | Required | The transaction type ID. See Reference for possible values. |
payment_method | String | Required | The type of method used for payment. Possible values:
|
payment_type | String | Required | The numerical code for the type of payment. See Reference for possible values. |
short_code | String | Conditional Requirement: This can be mandatory or optional, depending on configuration. | The short code for the payment. |
date_time | String, in YYYY-MM-DDTHH:MM:SS format | Required | The date and time when the transaction was initiated in UTC. |
local_date_time | String | Optional | The 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_bank | String | Optional | The 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_id | String | Optional | The foreign exchange ID. This is a unique CellPoint Digital-specific identification number for a currency exchange offer. |
service_type_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:
The Exchange Service ID table shows the possible values. |
pos | Integer | Optional | The point of sale of the transaction, expressed as the country ID. See Reference for possible values. |
ip_address | String | Optional | The IP address of the transaction initiation. |
installment | Integer | Optional | The number of installments selected if a customer chooses to pay in installments. |
accept_url | String | Optional | The accept URL. |
cancel_url | String | Optional | The cancel URL. |
amount | Object | Required | Transaction amount details. See the amount section below. |
sale_amount | Object | Optional | Sale 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. |
status | Object | Required | Transaction status details. See the status section below. |
psp | Object | Conditional Requirement: This object may be mandatory or optional, depending on the PSP. | Payment service provider (PSP) details. See the psp section below. |
card | Object | Optional | Card details. See the card section below. |
rebilling_info | Object | Conditional 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_info | Object | Required | Customer information. See the customer_info section below. |
additional_data | Array | Optional | Additional 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_data | Array | Optional | Client data. See the client_data section below. |
product_info | Array | Optional | Product information. See the product_info section below. |
delivery_info | Array | Optional | Delivery information. See the delivery_info section below. |
shipping_info | Array | Optional | Shipping information. See the shipping_info section below. |
billing_address | Object | Optional | The billing address. See the billing_address section below. |
fraud | Object | Conditional Requirement: This can be mandatory or optional, depending on configuration. | Fraud details. See the fraud section below. |
tms_info | Object | Conditional Requirement: This can be mandatory or optional, depending on configuration. | TMS information. See the tms_info section below. |
order_data | Object | Optional | Order data. This can include Airline Itinerary Data (AID). See the order_data section below. |
amount
amount
Parent: transactions
The amount
object is required, and it contains the following children:
Name | Format | Requirement | Description |
---|---|---|---|
value | Integer | Required | The 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_id | Integer | Required | The currency ID for the transaction amount. See Reference for possible values. |
decimals | Integer | Optional | The currency precision for the transaction amount; for example, 2 for USD (which is written with two units after the decimal, as in $1.00.) |
alpha3code | String | Optional | The alpha-3 currency code for the transaction amount. See Reference for possible values. |
conversion_rate | Integer | Optional | The conversion rate. |
sale_amount
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
status
Parent: transactions
The status
object in transactions
is required, and it has the following children:
Parameter | Format | Requirement | Description |
---|---|---|---|
code | Integer | Required | A code indicating the status of the transaction. |
sub_code | Integer | Optional | A subcode giving further information on the status of the transaction. |
message | String | Required | The status message of a session. |
provider_message | String | Optional | The provider message. |
provider_status_code | String | Optional | The provider status code. |
psp
psp
Parent: transactions
The psp
object may be mandatory or optional, depending on the payment service provider (PSP). It has the following children:
Name | Format | Requirement | Description |
---|---|---|---|
id | Integer | Conditional Requirement: This may be mandatory or optional, depending on the PSP. | The PSP ID. This is provided by CellPoint Digital for internal reference. |
name | String | Conditional Requirement: This may be mandatory or optional, depending on the PSP. | The PSP name. |
external-id | String | Conditional Requirement: This may be mandatory or optional, depending on the PSP. | The PSP external ID. |
card
card
Parent: transactions
The card
object is optional, and it has the following children:
Name | Format | Requirement | Description |
---|---|---|---|
id | Integer | Optional | The card ID. See Reference for possible values. |
name | String | Optional | The card name. |
mask_card_number | String | Optional | The masked card number (with the first six and last four digits visible), if present for the transaction. |
expiry | String | Optional | The 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
rebilling_info
Parent: transactions
The rebilling_info
object can be mandatory or optional, depending on configuration, and it has the following children:
Name | Format | Requirement | Description |
---|---|---|---|
id | Integer | Optional | The rebilling info ID. |
frequency | Integer | Optional | The rebilling frequency. |
expiry | String | Optional | The expiry date. |
customer_info
customer_info
Parent: transactions
The customer_info
object is required, and it has the following children:
Name | Format | Requirement | Description |
---|---|---|---|
email | String | Optional | The customer's email address. |
country_id | Integer | Optional | The CellPoint Digital mobile country ID. See Reference for possible values. |
mobile | String | Optional | The MSISDN of the end customer without an International Code (if available). Defaults to 0 if not applicable or available. |
operator | Integer | Optional | The ID of a customer’s Mobile Network Operator as per CellPoint Digital's defined codes:
|
language | String | Required | The default language encoding selected during client onboarding. This includes:
|
device_id | String | Optional | The device ID of the customer (if available). |
additional_data
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
client_data
Parent: transactions
The client_data
array is optional. Each element in the array must have the following parameters:
Parameter | Format | Requirement | Description |
---|---|---|---|
name | String | Conditional Requirement: Required if client_data is present. | The client data name. |
text | String | Conditional Requirement: Required if client_data is present. | The client data value. |
product_info
product_info
Parent: transactions
The product_info
array is optional. Each element in the array must have the following parameters:
Parameter | Format | Requirement | Description |
---|---|---|---|
name | String | Conditional Requirement: Required if product_info is present. | The product name. |
quantity | Integer | Conditional Requirement: Required if product_info is present. | The quantity. |
price | Integer | Conditional Requirement: Required if product_info is present. | The price. |
delivery_info
delivery_info
Parent: transactions
The delivery_info
array is optional. Each element in the array must have the following parameters:
Parameter | Format | Requirement | Description |
---|---|---|---|
name | String | Conditional Requirement: Required if delivery_info is present. | The delivery info name. |
text | String | Conditional Requirement: Required if delivery_info is present. | The delivery info value. |
shipping_info
shipping_info
Parent: transactions
The shipping_info
array is optional. Each element in the array must have the following parameters:
Parameter | Format | Requirement | Description |
---|---|---|---|
name | String | Conditional Requirement: Required if shipping_info is present. | The shipping info name. |
text | String | Conditional Requirement: Required if shipping_info is present. | The shipping info value. |
billing_address
billing_address
Parent: transactions
The billing_address
object is optional, and it has the following children:
Parameter | Format | Requirement | Description |
---|---|---|---|
first_name | String | Conditional Requirement: Required if billing_address is present. | The first name in the cardholder billing address. |
last_name | String | Conditional Requirement: Required if billing_address is present. | The last name in the cardholder billing address. |
street | String | Optional | The street address in the cardholder billing address. |
city | String | Optional | The city name in the cardholder billing address. |
state | String | Optional | The cardholder billing address state/region as provided by the user. |
country | String | Optional | The cardholder billing address country code, as per CellPoint Digital's defined codes. See Reference for possible values. |
postal_code | String | Optional | The zip code or postal code in the cardholder billing address. |
alpha2code | String | Optional | The alpha-2 country code. |
mobile | String | Optional | The cardholder's mobile number. |
email | String | Optional | The cardholder's email address. |
billing_idc | Integer | Optional | The cardholder's mobile dialling country code, provided as per ISO IDC codes. |
fraud
fraud
Parent: transactions
The fraud
object can be mandatory or optional, depending on configuration, and it has the following children:
Name | Format | Requirement | Description |
---|---|---|---|
status_code | String | Conditional Requirement: Required if fraud is present. | The final fraud status code; for example, 3011 or 3111 if the fraud flow is executed. |
status_desc | String | Conditional 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_id | String | Optional | The post-auth fraud check system transaction ID, if the post-auth fraud flow is executed. |
post_auth_ext_status_code | String | Optional | The post-auth fraud check system response code, if the post-auth fraud flow is executed. |
pre_auth_ext_id | String | Optional | The pre-auth fraud check system transaction ID, if the pre-auth fraud flow is executed. |
pre_auth_ext_status_code | String | Optional | The pre-auth fraud check system response code, if the pre-auth fraud flow is executed. |
pre_auth_provider_id | Integer | Optional | The pre-auth provider ID. |
post_auth_provider_id | Integer | Optional | The post-auth provider ID. |
pre_auth_fraud_status | Integer | Optional | The pre-auth fraud status. |
post_auth_fraud_status | Integer | Optional | The post-auth fraud status. |
tms_info
tms_info
Parent: transactions
The tms_info
object can be mandatory or optional, depending on configuration, and it has the following children:
Name | Format | Requirement | Description |
---|---|---|---|
tms_provider_code | Integer | Optional | The TMS provider code; for example, 403 . |
tms_provider_message | String | Optional | The TMS provider message; for example, The IP Address is invalid . |
order_data
order_data
Parent: transactions
The order_data
object is optional, and it has the following children:
Name | Format | Requirement | Description |
---|---|---|---|
product_sku | String | Optional | The short code for travel itinerary; for example, PNR and order number. |
amount | Object | Optional | Transaction 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_no | String | Optional | The ticket number. |
profiles | Array | Optional | An array of profile objects, which provides traveler information for the travel itinerary. See the profiles section below. |
trips | Array | Optional | An array of the trip object, which provides trip information for the travel itinerary. See the trips section below. |
billing_summary | Object | Optional | The 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
profiles
Parents: transactions: order_data
The profiles
array is optional. Each element in the array has the following parameters:
Name | Format | Requirement | Description |
---|---|---|---|
id | Integer | Conditional Requirement: Required if profiles is present. | The passenger's profile ID. |
title | String | Optional | The title of a passenger, such as Mr. , Mrs. , or Ms. |
first_name | String | Optional | First name of the passenger. |
last_name | String | Optional | Last name of the passenger. |
type | String | Optional | The type of a passenger, such as adult, child, or infant. |
email | String | Optional | The email ID of a passenger. |
mobile | Integer | Optional | The mobile number of the passenger. |
country_id | String | Optional | Country ID. |
amount | String | Optional | Amount. |
seq | Integer | Optional | The sequence number of the passenger |
additional_data | Array | Optional | An 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
trips
Parents: transactions: order_data
The trips
array is optional. Each element in the array has the following parameters:
Name | Format | Requirement | Description |
---|---|---|---|
id | Integer | Optional | Trip ID. |
service_class | String | Optional | The booking class (RBD – first letter of fare-basis); for example, H . |
departure_airport | String | Optional | Departure airport code. |
arrival_airport | String | Optional | Arrival airport code. |
op_airline_code | String | Optional | The 2-letter airline code. |
mkt_airline_code | String | Optional | The 2-letter airline code of the operating airline. |
arrival_date | String | Optional | The date and time of arrival, in YYYY-MM-DD HH:MM:SS format. |
departure_date | String | Optional | The date and time of departure, in YYYY-MM-DD HH:MM:SS format. |
additional_data | Array | Optional | An 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_number | String | Optional | Flight number. |
op_flight_number | String | Optional | Flight number of the operating flight. |
tag | String | Optional | The sequence of this trip in the journey. |
trip_count | String | Optional | Number of trip sequences in the journey. |
service_level | String | Optional | The cabin class opted; for example, XL , X , M , or S . |
departure_country_id | String | Optional | Departure country ID. |
arrival_country_id | String | Optional | Arrival country ID. |
dept_time_zone | String | Optional | The local time zone of the flight origin, such as -5:00 . |
arrival_time_zone | String | Optional | The local time zone of the flight arrival, such as -5:00 . |
arrival_terminal | String | Optional | Arrival terminal. |
dept_terminal | String | Optional | Departure terminal. |
dept_city | String | Optional | Departure city. |
arrival_city | String | Optional | Arrival airport city. |
aircraft_type | String | Optional | The aircraft type; for example, Airbus A380 . |
billing_summary
billing_summary
Parents: transactions: order_data
The billing_summary
array is optional. Each element in the array has the following parameters:
Name | Format | Requirement | Description |
---|---|---|---|
fare_details | Array | Optional | The fare details of the journey. See the fare_details section below. |
add_on | Array | Optional | Fees for ancillary services. See the add_on section below. |
fare_details
fare_details
Parents: transactions: order_data: billing_summary
The fare_details
array is optional. Each element in the array has the following parameters:
Name | Format | Requirement | Description |
---|---|---|---|
id | Integer | Required | The ID of this fare. |
journey_ref | String | Optional | Journey reference. |
bill_type | String | Optional | Bill type. |
description | String | Optional | The description of the fare in this object. |
amount | String | Optional | The fare amount. |
currency | String | Optional | The alpha3 ISO currency code of the fare amount. |
profile_seq | String | Optional | The sequence number of the passenger linked to this fare detail. |
trip_tag | String | Optional | The tag number associated with a trip, which helps identify a trip. |
trip_seq | String | Optional | The trip sequence number to identify this trip in the journey. |
product_code | String | Optional | The code number to identify the product. |
product_category | String | Optional | The code number to identify the product category. |
product_item | String | Optional | The code number to identify the product item. |
add_on
add_on
Parents: transactions: order_data: billing_summary
The add_on
array is optional. Each element in the array has the following parameters:
Name | Format | Requirement | Description |
---|---|---|---|
id | Integer | Required | The ID of this add-on ancillary. |
journey_ref | String | Optional | |
bill_type | String | Optional | |
description | String | Optional | The description of the add-on fee in this object. |
amount | String | Optional | The amount of the add-on fee. |
currency | String | Optional | The alpha3 ISO currency code of the add-on amount. |
profile_seq | String | Optional | The sequence number of the passenger linked to this add-on. |
trip_tag | String | Optional | The tag number associated with a trip, which helps identify a trip. |
trip_seq | String | Optional | The trip sequence number to identify this trip in the journey. |
product_code | String | Optional | The code number to identify the add-on product. |
product_category | String | Optional | The code number to identify the add-on product category. |
product_item | String | Optional | The code number to identify the add-on product item. |
Updated 4 days ago