Check Refund and Change Availability

Determine refund, change, and void availability from the order and passenger ticket status, and return reasons when an action is unavailable.

Request

Authorization

API Key

Add parameter in header

code

Example:

code: ********************

API Key

Add parameter in header

timestamp

Example:

timestamp: ********************

API Key

Add parameter in header

signature

Example:

signature: ********************

Body Params application/jsonRequired

Example

{
    "orderId": "FO202607090001",
    "actionCode": "CHANGE",
    "checkTime": "2026-07-09T12:00:00+08:00"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200

application/json

Query completed successfully.

Bodyapplication/json

Example

{
    "code": 0,
    "message": "ok",
    "realErrorMsg": "",
    "data": {
        "id": "FO202607090001",
        "orderType": "origin",
        "status": "reviewing",
        "source": "api",
        "solutionId": "sol_2f4d3c",
        "currency": "CNY",
        "validatingCarrier": "CA",
        "originOrderId": "FO202607090001",
        "parentOrderId": "",
        "externalOrderId": "EXT-20260709-0001",
        "contactName": "Zhang San",
        "contactEmail": "zhangsan@example.com",
        "contactRegion": "86",
        "contactPhone": "13800138000",
        "rejectReason": "",
        "isHolding": false,
        "incomeId": 0,
        "lastActionTime": "2026-07-09 12:00:00",
        "lastTicketingTime": "2026-07-09 13:00:00",
        "isVoidPermitted": true,
        "lastVoidTime": "2026-07-09 23:59:59",
        "createdAt": "2026-07-09 10:00:00",
        "updatedAt": "2026-07-09 10:05:00",
        "completedAt": "",
        "journeys": [
            {
                "id": 201,
                "orderId": "FO202607090001",
                "origin": "BJS",
                "destination": "BKK",
                "departureDate": "2026-08-01",
                "departureTime": "08:00",
                "departureTimeZo": "Asia/Shanghai",
                "arrivalDate": "2026-08-01",
                "arrivalTime": "15:00",
                "duration": "7h00m",
                "transferNum": 1,
                "segments": [
                    {
                        "id": 301,
                        "orderId": "FO202607090001",
                        "coreSegmentId": "PEK-SHA-20260801-CA1234",
                        "journeyIndex": 0,
                        "index": 0,
                        "cabinClass": "economy",
                        "cabinCode": "Y",
                        "subCabinCode": "Y1",
                        "fareBasisCode": "YOWCN",
                        "stayTime": "2h10m",
                        "pnr": "ABC123",
                        "airlinePnr": "CA1ABC",
                        "baggageRules": [
                            {
                                "passengerType": "adult",
                                "personal": {
                                    "pieces": 1,
                                    "weight": 23,
                                    "unit": "KG",
                                    "dimension": "158CM",
                                    "description": "1 piece, 23KG"
                                },
                                "carryOn": {
                                    "pieces": 1,
                                    "weight": 23,
                                    "unit": "KG",
                                    "dimension": "158CM",
                                    "description": "1 piece, 23KG"
                                },
                                "checked": {
                                    "pieces": 1,
                                    "weight": 23,
                                    "unit": "KG",
                                    "dimension": "158CM",
                                    "description": "1 piece, 23KG"
                                }
                            }
                        ],
                        "coreSegment": {
                            "id": "PEK-SHA-20260801-CA1234",
                            "airline": "CA",
                            "flightNo": "CA1234",
                            "isCodeShare": false,
                            "opAirline": "CA",
                            "opFlightNo": "CA1234",
                            "equipment": "738",
                            "mealType": "Meal",
                            "departure": "PEK",
                            "departureDate": "2026-08-01",
                            "departureTime": "08:00",
                            "departureTerminal": "T3",
                            "arrival": "SHA",
                            "arrivalDate": "2026-08-01",
                            "arrivalTime": "10:20",
                            "arrivalTerminal": "T2",
                            "distance": 1080,
                            "flightTime": "2h20m",
                            "stopovers": [
                                {
                                    "city": "HGH",
                                    "airport": "HGH",
                                    "duration": "1h10m",
                                    "arrivalTime": "10:00",
                                    "departureTime": "11:10"
                                }
                            ]
                        },
                        "createdAt": "string",
                        "updatedAt": "string"
                    }
                ],
                "createdAt": "string",
                "updatedAt": "string"
            }
        ],
        "passengers": [
            {
                "id": 101,
                "parentPassengerId": 0,
                "orderId": "FO202607090001",
                "type": "adult",
                "index": 0,
                "associatedIndex": 0,
                "surname": "ZHANG",
                "givenNames": "SAN",
                "gender": "male",
                "birthday": "1990-01-01",
                "nationality": "CN",
                "travelDocument": "passport",
                "travelDocumentExpireDate": "2030-01-01",
                "travelDocumentNumber": "E12345678",
                "email": "passenger@example.com",
                "region": "86",
                "phone": "13800138000",
                "airline": "CA",
                "cardNo": "CA123456",
                "tickets": [
                    {
                        "id": 401,
                        "parentTicketId": 0,
                        "passengerId": 101,
                        "segmentId": 301,
                        "ticketNo": "9991234567890",
                        "pnr": "ABC123",
                        "issueDate": "2026-07-09",
                        "expireDate": "2027-07-09",
                        "status": "issued",
                        "remark": "",
                        "voidOrderId": "",
                        "refundOrderId": "",
                        "changeOrderId": "",
                        "createdAt": "string",
                        "updatedAt": "string"
                    }
                ],
                "createdAt": "string",
                "updatedAt": "string",
                "changeable": true,
                "refundable": true,
                "voidable": false,
                "used": false,
                "nonChangeableReason": "",
                "nonRefundableReason": "",
                "nonVoidReason": "",
                "askChangeDetails": [
                    {
                        "changeType": 1,
                        "changeFlightDateFrom": "2026-08-01",
                        "changeFlightDateTo": "2026-08-31"
                    }
                ],
                "askRefundDetails": [
                    {
                        "refundType": 1,
                        "needRepricing": true,
                        "priceValidity": "",
                        "usedAmount": 0,
                        "usedTax": 0,
                        "refundFee": 300,
                        "refundAmount": 900
                    }
                ]
            }
        ],
        "priceDetail": {
            "productType": "publish",
            "priceList": [
                {
                    "passengerType": "adult",
                    "num": 1,
                    "publishPrice": 1000,
                    "tax": 200,
                    "price": 950,
                    "salePrice": 1200,
                    "currency": "CNY"
                },
                {
                    "passengerType": "adult",
                    "num": 1,
                    "priceDiff": 100,
                    "taxDiff": 20,
                    "changeFee": 30,
                    "serviceFee": 10,
                    "salePrice": 160,
                    "currency": "CNY"
                },
                {
                    "passengerType": "adult",
                    "num": 1,
                    "refundableAmount": 800,
                    "usedAmount": 0,
                    "refundFee": 50,
                    "serviceFee": 10,
                    "refundPrice": 740,
                    "currency": "CNY"
                }
            ],
            "priceTotal": 1200,
            "transactionFee": 0
        },
        "fareRules": [
            {
                "passengerType": "adult",
                "canVoid": true,
                "currency": "CNY",
                "change": {
                    ">0": 300,
                    ">4": 200,
                    "<-4": 500
                },
                "changeDescription": "Change before departure CNY 300",
                "refund": {
                    ">0": 500,
                    ">4": 300,
                    "<-4": 800
                },
                "refundDescription": "Refund before departure CNY 500",
                "originText": "Original fare rule text",
                "longestStay": "1Y",
                "shortestStay": "0D",
                "convertedCurrency": "USD",
                "convertedChange": {
                    "property1": 0,
                    "property2": 0
                },
                "convertedRefund": {
                    "property1": 0,
                    "property2": 0
                }
            }
        ]
    }
}

⚪default