AncillaryPurchase - FR24 OpenAPI

Calling the API to pay for post-sales ancillary orders.
This API is used for order payment & ancillary purchase. Only.
Making payments and request by calling the AncillaryPurchase API. The partner calls this API to inform FR24 to deduct balance for the order requested. If the API called successfully, the payment will be successfully processed.
After the order is created, the order has to be paid within payment deadline, otherwise the order will be canceled.

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

auxOrderNo

string

FR24 ancillary Order Number

required

Match pattern:

^\d*$

partnerAuxOrderNo

string

Ancillary Order Number of Partner

optional

orderNo

string

Ticket Order number

optional

currency

string

Currency

required

totalPrice

number

Total order price of ancillary

required

paymentMethod

string

Payment method

required

Example

{
  "authentication": {},
  "auxOrderNo": "",
  "partnerAuxOrderNo": "",
  "orderNo": "",
  "currency": "",
  "totalPrice": "",
  "paymentMethod": ""
}

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

All the data returned according to the Request

optional

If code returns failure, data would be empty.

auxOrderNo

string

FR24 ancillary Order Number

required

partnerOrderNo

string

Ancillary Order Number of partner

optional

orderNo

string

FR24 order number

required

currency

string

Order currency

required

totalPrice

string

Total price of the order

required

Example

{
  "traceId": "",
  "code": "",
  "message": "",
  "processingTime": "",
  "data": {
    "auxOrderNo": "",
    "partnerOrderNo": "",
    "orderNo": "",
    "currency": "",
    "totalPrice": ""
  }
}