ticketing - FR24 OpenAPI

This API is used for order payment & ticket issue.
Make payments and request ticketing by calling the Ticketing API. Partner calls this API to inform FR24 to deduct balance for the order requested. If the API call successfully, the payment completed successfully. The ticket number will be obtained via OrderChangeInforming API, or via the OrderDetail API.
After the order is created, the order has to be paid within payment deadline, otherwise the order will be canceled.
Note: Requesting the API of Ticketing successfully only means FR24 has received the ticketing application, and it will be pending rather than being instantly confirmed and issued. FR24 will notify the order status change via orderChangeInforming API if the booking is confirmed and the ticket can be issued.

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

orderNo

string

FR24 order number or reissue order number.

required

or reissue order number.

Match pattern:

^\d*$

partnerOrderNo

string

Partner’s order number

optional

currency

string

Currency

required

totalPrice

number

Total price

required

paymentMethod

string

Payment method

required

0 - Pay by balance in B2B wallet (for users who use either balance or credit for payments)

Match pattern:

^\d*$

seriesTraceId

string

The traceId returned by the last service request interface

optional

This field is a developer option. FR24 uses this traceId to track and analyze the last call interface of the partner, so that both parties can quickly track the entire link when problems occur.

seriesRsTime

number

The last service request interface, the time from requesting the interface to obtaining the result, in ms

optional

This field is a developer option. FR24 uses this time to analyze the partner's network delay to improve the data quality of both parties.

Example

{

    "authentication": {

        "sign": "{{sign}}",

        "timestamp": "{{time}}"

    },

    "orderNo": "{{orderNo_booking}}",

    "partnerOrderNo": "1234567ss",

    "totalPrice": {{totalPrice_booking}},

    "currency": "{{currency_booking}}",

    "paymentMethod": "0",
    
    "seriesTraceId": "order_202410101503481394",
        
    "seriesRsTime": 5

}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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 (Ticket response)

All the data returned according to the Request

optional

If code returns failure, it would be empty.

orderNo

string

FR24 order number

required

orderStatus

enum<string>

Order status

optional

Allowed values:

1112131415

partnerOrderNo

string

Partner’s order number

required

instantTicketing

array [object {5}]

Immediate ticketing information

optional

totalPrice

number

Total price of the order

required

currency

string

Currency

required

Examples

SuccessReal Case

{
    "traceId": "",
    "code": "000000",
    "message": "success",
    "processingTime": 160,
    "data": {
        "orderNo": "{{orderNo_booking}}",
        "orderStatus": "11",
        "partnerOrderNo": "1234567ss ",
        "totalPrice": 1234.5,
        "currency": "{{currency_booking}}"
    }
}