RefundRequest

POST

/api/new/refundRequest.do

Refund Request Interface. By invoking the refundRequest interface, a refund pricing application will be initiated to FR24.
The pricing result will be pushed through the orderChangeInforming API

Request

Header Params

Accept-Encoding

string

required

Use gzip compression format

Default:

gzip, deflate, br

content-Type

string

required

Response format

Default:

application/json

appKey

string

required

User account

Default:

Body Params application/json

authentication

object

User authentication

required

sign

string

Signature

required

The encrypted string of appkey, appSecret and timestamp.Refer to Appendix I

timestamp

string

Unix timestamp

required

measuring in Second

tktOrderNo

string

FR24 Ticket Order Number

required

Match pattern:

^\d*$

partnerOrderNo

string

Partner order number

optional

passengers

array[object (Refund passenger information) {4}]

Passenger information

required

paxId

string

Passenger’s Id

required

name

string

Passenger’s name

required

English capital LastName/FirstName Spaces”␣” are not permitted

birthday

string

Passenger’s date of birth

optional

YYYY-MM-DD

Match pattern:

^\d{4}-\d{2}-\d{2}$

gender

enum<string>

Passenger’s gender

optional

Allowed values:

segments

array [object {6}]

Segments for ticket refund

optional

If not provided, it represents a refund for the entire itinerary of the passenger's order.

carrier

string

Selling carrier

required

Airline code by IATA

flightNo

string

Flight number

required

used with carrier.E.g. BA1234, carrier is BA, flightNo is 1234.

depAirport

string

Departure airport

required

code by IATA

depTime

string <date-time>

Departure time

required

YYYY-MM-DDThh:mmDeparture airport local timeE.g., 2022-10-21T21:23

arrAirport

string

Arrival airport

required

code by IATA

arrTime

string <date-time>

Arrival time

required

YYYY-MM-DDThh:mmArrival airport local time.

refundReason

enum<string>

Refund reason

required

Allowed values:

0123

remarks

string

Additional notes on the reason for ticket refund

optional

Additional notes on the reason for ticket refund.

fileData

array [object {1}]

Proof documents

optional

with the ID obtained from the file upload interface.

fileId

string

Documents id

optional

Example

{
  "authentication": {
    "sign": "{{sign}}",
    "timestamp": "{{time}}"
  },
  "partnerOrderNo": "",
  "tktOrderNo": "{{orderNo_detail}}",
  "passengers": [
    {
      "paxId": "1",
      "name": "{{pname_detail}}",
      "birthday": "{{pbirthday_detail}}",
      "gender": "{{pgender_detail}}"
    }
  ],
  "segments": [
    {
      "carrier": "{{carrier_detail}}",
      "flightNo": "{{flightNo_detail}}",
      "depAirport": "{{depAirport_detail}}",
      "depTime": "{{depTime_detail}}",
      "arrAirport": "{{arrAirport_detail}}",
      "arrTime": "{{arrTime_detail}}"
    }
  ],
  "refundReason": "1",
  "remarks": "",
  "fileId": [
    "{{fileId}}"
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://flight-test.flightroutes24.com/api/new/refundRequest.do' \
--header 'Accept-Encoding;' \
--header 'appKey;' \
--header 'content-Type: application/json' \
--data-raw '{

    "authentication": {

        "sign": "",

        "timestamp": "{{time}}"

    },

    "partnerOrderNo": "",

    "tktOrderNo": "{{orderNo_detail}}",

    "passengers": [

        {

            "paxId": "1",

            "name": "{{pname_detail}}",

            "birthday": "{{pbirthday_detail}}",

            "gender": "{{pgender_detail}}"

        }

    ],

    "segments":  [

        {

            "carrier": "{{carrier_detail}}",

            "flightNo": "{{flightNo_detail}}",

            "depAirport": "{{depAirport_detail}}",

            "depTime": "{{depTime_detail}}",

            "arrAirport": "{{arrAirport_detail}}",

            "arrTime": "{{arrTime_detail}}"

        }

    ],

    "refundReason": "1",

    "remarks": "",

    "fileId": [

        "{{fileId}}"

    ]

}'

Responses

🟢200OK

application/json

Body

traceId

string

Traceability code

required

traceId can help locate problems when problems occur between partners and FR24.

code

string

Status code

required

000000 means success, others mean failure.

message

string

Error code message

required

processingTime

number

Processing time

required

measuring in ms

>= 0

data

object (Refund response)

All the data returned according to the Request

optional

All the data returned according to the Request.
If code returns failure, data would be empty.

refundOrderNo

string

Refund order number

required

tktOrderNo

string

Ticketing order number

required

refundOrderStatus

string

Refund order status

required

Example

{
  "traceId": "",
  "code": "000000",
  "message": "success",
  "processingTime": 160,
  "data": {
    "refundOrderNo": "{{refundOrderNo}}",
    "tktOrderNo": "ticketing order number",
    "refundOrderStatus": ""
  }
}

Modified at 2024-11-27 10:53:11

ReissueRequest

RefundConfirming