VoidRequest - FR24 OpenAPI

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

Ticket order number

required

Match pattern:

^\d*$

partnerOrderNo

string

Partner order number

optional

passengers

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

Passenger information for ticket void

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:

FM

Example

{
  "authentication": {
    "sign": "{{sign}}",
    "timestamp": "{{time}}"
  },
  "tktOrderNo": "{{orderNo_detail}}",
  "partnerOrderNo": "",
  "passengers": [
    {
      "paxId": "1",
      "name": "{{pname_detail}}",
      "birthday": "{{pbirthday_detail}}",
      "gender": "{{pgender_detail}}"
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

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

    "authentication": {

        "sign": "",

        "timestamp": "{{time}}"

    },

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

    "partnerOrderNo": "",

    "passengers": [

        {

            "paxId": "1",

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

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

            "gender": "{{pgender_detail}}"

        }

    ]

}'

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

All the data returned according to the Request

optional

If code returns failure, data would be empty.

voidOrderNo

string

Invalid order number

required

tktOrderNo

string

Ticket order number

optional

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

voidOrderStatus

string

Invalid order status

required

Status code 000000 means success, others mean failure.

Example

{
  "traceId": "",
  "code": "000000",
  "message": "success",
  "processingTime": 160,
  "data": {
    "voidOrderNo": "",
    "tktOrderNo": "",
    "voidOrderStatus": "36"
  }
}