TicketIssuanceNotify_V2

1 Function

Buyer partners should provide a webhook/URL based on HTTP/HTTPS protocol to PKFARE for push ticket numbers and airlines PNR. PKFARE will push ticket numbers when the tickets are issued. In another case, if the request was rejected, a rejected reason would be provided.

2 Versioning

Version	Sandbox Invoking Address	Update
TicketingNumPush	This address is provided by the customer.
TicketingNumPush_V2	This address is provided by the customer.	Add information about voiding tickets.
TicketingNumPush_V3	This address is provided by the customer.	Add PNR list for more accurate mapping relations between airlines PNR and pax/flight.
TicketIssuanceNotify	This address is provided by the customer.	Support infant ticket. More parameters are provided for change orders.
TicketIssuanceNotify_V2	This address is provided by the customer.	Support ticketing fasilure screnarios with reasons

3 Character Encoding

The character code of this API is UTF-8.

4 Request

The request is sent by PKFARE API. Requesting method would be POST.

4.1 Schema

Name	Type	Parameter Description	Sample
Basic Parameter
orderNum	String	[PKFARE] order number	1012674912
status	String	Order status, it contains: ISSUED, CHANGED, or REJECTED	ISSUED
rejectReason	String	Reject reason	change is not permitted as per fare rules.
remark	String	Reject reason remark	-
parentOrderNum	String	Parent order number of this order	96848725690201
refOrderNum	String	Main order number, it could be considered as the original ticketing order number, it will relate to multiple orders if VOID/CHANGE/REFUND requested.	943473218357
informType	String	Include Ticket_Issued, Ticket_Reissued, Ticket_Change	Ticket_Issued
airPnr	String	Airline PNR	EDTCZP
pnr	String	GDS PNR	EDTCZP
pnrList	Array	PNR list, refer to pnrList	-
passengers	Array	Passenger list, refer to passengers	-
paymentGate	String	Payment gate	ALIPAY
serialNum	String	Payment serial number	2013012200021000200172105074
merchantOrder	String	Merchant order number (for ALIPAY only)	ALIPAY_20161101105225_1028814703
permitVoid	Integer	Allow to void ticket or not. [1-yes, 0-not allowed]	1
lastVoidTime	String	Voiding deadline. Voiding operation would not be allowed after lastVoidTime. (GMT) [yyyy-mm-dd hh : mm : ss]	2023-01-01 13:00:00
voidServiceFee	BigDecimal	Void service fee	5.00
currency	String	Currency for void service fee	USD
buyerOrder	String	BuyerOrder	1234567
data	Object	Include remark field for reference	-
passengers
passengerIndex	String	Passenger sequence no. Positive and continuous integer starting from 1. If this booking contains infants. The passengerIndex is all the same as those in the booking request. If no infant, the passengerIndex(s) are generated by the system automatically.	3
birthday	String	Birthday, format[yyyy-mm-dd]	2000-01-01
cardExpiredDate	String	Travel document expired date, format[yyyy-mm-dd]	2000-01-01
cardNum	String	Travel document number	P1234567
cardType	String	Travel document type including P for Passport, N for Chinese Identity and O for Others.	P
firstName	String	First name	JANGO
lastName	String	Last name	WANG
nationality	String	Nationality [country code]	CN
psgType	String	Passenger type, including ADT for adults, CHD for children [age 2-12] and INF for infants [age 0-2, no seat]	ADT
sex	String	Gender, including M for male, F for female	F
associatedPassengerIndex	Integer	The associated adult passengerIndex. Only infant passengers have this parameter.	1
ticketNum	String	Ticket number, multiple numbers will be separated by '/', like 9991234567890/9991234567891	1122334455667
pnrList
segmentNo	Integer	Segment No.	1
departure	String	Departure [IATA airport code]	BKK
arrival	String	Destination [IATA airport code]	CNX
flightNum	String	Flight No.	FD112
cabinClass	String	Cabin class including ECONOMY, PREMIUM ECONOMY, BUSINESS, and FIRST.	ECONOMY
bookingCode	String	Cabin code	E
pnr	String	PNR	EDTCZP
airPnr	String	Airline PNR	EDTCZP
ticketNums	Array	Passengers and corresponding ticket numbers, refer to ticketNum	-
ticketNums
passengerIndex	Integer	Passenger sequence no. Consistent with the passengerIndex under each passenger.	1
ticketNum	String	Ticket number	9991234567890
orderStatus	String	status for canceled order	CNCL_TO_BE_REIM

4.2 Example

Request Sample (Two Adults, One Way Trip with Two Segments)

plainCopy code{
    "airPnr": "15CUCZ|25CUCZ|35CUCZ|45CUCZ",
    "currency": "CNY",
    "merchantOrder": "PREPAY_20221222145440_916716911545376001_4677",
    "orderNum": "916716911545376001",
    "passengers": [
        {
            "passengerIndex": 1,
            "birthday": "1995-06-15",
            "cardExpiredDate": "2024-05-01",
            "cardNum": "E29384798",
            "cardType": "PP",
            "firstName": "Wei",
            "lastName": "Chen",
            "nationality": "CN",
            "psgType": "ADT",
            "sex": "M",
            "ticketNum": "1T9LO2/3T9LO2"
        },
        {
            "passengerIndex": 2,
            "birthday": "1993-04-01",
            "cardExpiredDate": "2024-07-01",
            "cardNum": "E05849326",
            "cardType": "PP",
            "firstName": "Xiaotong",
            "lastName": "Li",
            "nationality": "CN",
            "psgType": "ADT",
            "sex": "F",
            "ticketNum": "2T9LO2/4T9LO2"
        }
    ],
    "paymentGate": "PREPAY",
    "permitVoid": 0,
    "pnr": "187UIJHNJUIJIU8789|287UIJHNJUIJIU8789|387UIJHNJUIJIU8789|487UIJHNJUIJIU8789",
    "pnrList": [
        {
            "airPnr": "15CUCZ",
            "arrival": "NRT",
            "bookingCode": "H",
            "cabinClass": "ECONOMY",
            "departure": "HKG",
            "flightNum": "812",
            "pnr": "187UIJHNJUIJIU8789",
            "segmentNo": 1,
            "ticketNums": [
                {
                    "passengerIndex": 1,
                    "ticketNum": "1T9LO2"
                }
            ]
        },
        {
            "airPnr": "25CUCZ",
            "arrival": "NRT",
            "bookingCode": "H",
            "cabinClass": "ECONOMY",
            "departure": "HKG",
            "flightNum": "812",
            "pnr": "287UIJHNJUIJIU8789",
            "segmentNo": 1,
            "ticketNums": [
                {
                    "passengerIndex": 2,
                    "ticketNum": "2T9LO2"
                }
            ]
        },
        {
            "airPnr": "45CUCZ",
            "arrival": "MEX",
            "bookingCode": "H",
            "cabinClass": "ECONOMY",
            "departure": "NRT",
            "flightNum": "180",
            "pnr": "487UIJHNJUIJIU8789",
            "segmentNo": 2,
            "ticketNums": [
                {
                    "passengerIndex": 2,
                    "ticketNum": "4T9LO2"
                }
            ]
        },
        {
            "airPnr": "35CUCZ",
            "arrival": "MEX",
            "bookingCode": "H",
            "cabinClass": "ECONOMY",
            "departure": "NRT",
            "flightNum": "180",
            "pnr": "387UIJHNJUIJIU8789",
            "segmentNo": 2,
            "ticketNums": [
                {
                    "passengerIndex": 1,
                    "ticketNum": "3T9LO2"
                }
            ]
        }
    ],
    "serialNum": "PREPAY_20221222145440_916716911545376001_4677"
}

Request Sample (Two Adults with One Infant, One Way Trip with One Segment)

plainCopy code{
    "airPnr": "15CUCZ|25CUCZ",
    "currency": "CNY",
    "merchantOrder": "PREPAY_20221222145440_916716911545376001_4677",
    "orderNum": "916716911545376001",
    "passengers": [
        {
            "passengerIndex": 1,
            "birthday": "1995-06-15",
            "cardExpiredDate": "2024-05-01",
            "cardNum": "E29384798",
            "cardType": "PP",
            "firstName": "Xiaoqing",
            "lastName": "Ding",
            "nationality": "CN",
            "psgType": "ADT",
            "sex": "F",
            "ticketNum": "1T9LO2"
        },
        {
            "passengerIndex": 2,
            "birthday": "1993-04-01",
            "cardExpiredDate": "2024-07-01",
            "cardNum": "E05849326",
            "cardType": "PP",
            "firstName": "Zhigang",
            "lastName": "Zhao",
            "nationality": "CN",
            "psgType": "ADT",
            "sex": "M",
            "ticketNum": "2T9LO2"
        },
        {
            "passengerIndex": 3,
            "birthday": "2022-06-17",
            "cardExpiredDate": "2042-10-01",
            "cardNum": "E09819649",
            "cardType": "PP",
            "firstName": "Weiwei",
            "lastName": "Zhao",
            "nationality": "CN",
            "psgType": "INF",
            "sex": "M",
            "associatedPassengerIndex": 1,
            "ticketNum": "3T9LO2"
        }
    ],
    "paymentGate": "PREPAY",
    "permitVoid": 0,
    "pnr": "187UIJHNJUIJIU8789|287UIJHNJUIJIU8789",
    "pnrList": [
        {
            "airPnr": "15CUCZ",
            "arrival": "NRT",
            "bookingCode": "H",
            "cabinClass": "ECONOMY",
            "departure": "HKG",
            "flightNum": "812",
            "pnr": "187UIJHNJUIJIU8789",
            "segmentNo": 1,
            "ticketNums": [
                {
                    "passengerIndex": 1,
                    "ticketNum": "1T9LO2"
                },
                {
                    "passengerIndex": 3,
                    "ticketNum": "3T9LO2"
                }
                
            ]
        },
        {
            "airPnr": "25CUCZ",
            "arrival": "NRT",
            "bookingCode": "H",
            "cabinClass": "ECONOMY",
            "departure": "HKG",
            "flightNum": "812",
            "pnr": "287UIJHNJUIJIU8789",
            "segmentNo": 1,
            "ticketNums": [
                {
                    "passengerIndex": 2,
                    "ticketNum": "2T9LO2"
                }
            ]
        }       
    ],
    "serialNum": "PREPAY_20221222145440_916716911545376001_4677"
}

Request Sample (When the order is refused)

plainCopy code{
    "airPnr": "N82AS5",
    "currency": "USD",
    "data": {
        "remark": {}
    },
    "merchantOrder": "PREPAY_20240826220617_917246811144783701_3065",
    "orderNum": "917246811144783701",
    "orderStatus": "CNCL_TO_BE_REIM",
    "passengers": [
        {
            "birthday": "2004-08-26",
            "cardExpiredDate": "2025-09-07",
            "cardNum": "G10455525",
            "cardType": "PP",
            "firstName": "a",
            "lastName": "a",
            "nationality": "CN",
            "passengerIndex": 1,
            "psgType": "ADT",
            "sex": "M",
            "ticketNum": ""
        },
        {
            "birthday": "2004-08-26",
            "cardExpiredDate": "2025-09-07",
            "cardNum": "G25480126",
            "cardType": "PP",
            "firstName": "b",
            "lastName": "b",
            "nationality": "CN",
            "passengerIndex": 2,
            "psgType": "ADT",
            "sex": "M",
            "ticketNum": ""
        },
        {
            "birthday": "2004-08-26",
            "cardExpiredDate": "2025-09-07",
            "cardNum": "G79655975",
            "cardType": "PP",
            "firstName": "c",
            "lastName": "c",
            "nationality": "CN",
            "passengerIndex": 3,
            "psgType": "ADT",
            "sex": "M",
            "ticketNum": ""
        },
        {
            "birthday": "2004-08-26",
            "cardExpiredDate": "2025-09-07",
            "cardNum": "G65770019",
            "cardType": "PP",
            "firstName": "d",
            "lastName": "d",
            "nationality": "CN",
            "passengerIndex": 4,
            "psgType": "ADT",
            "sex": "M",
            "ticketNum": ""
        },
        {
            "birthday": "2018-08-26",
            "cardExpiredDate": "2025-09-07",
            "cardNum": "G31283047",
            "cardType": "PP",
            "firstName": "e",
            "lastName": "e",
            "nationality": "CN",
            "passengerIndex": 5,
            "psgType": "CHD",
            "sex": "M",
            "ticketNum": ""
        }
    ],
    "paymentGate": "PREPAY",
    "permitVoid": 0,
    "pnr": "N82AS5",
    "pnrList": [],
    "rejectReason": "Flight change during ticket issuance",
    "remarks": "The flight has changed, please rebook",
    "serialNum": "PREPAY_20240826220617_917246811144783701_3065"
}

5 Response

5.1 Schema

Name	Type	Parameter Description	Sample
errorCode	String	error code	0
errorMsg	String	error message	ok

5.2 Example

Success Response

{"errorCode":0,"errorMsg":"ok"}

1 Function#

2 Versioning#

3 Character Encoding#

4 Request#

4.1 Schema#

4.2 Example#

5 Response#

5.1 Schema#

5.2 Example#