Pay flight order

POST

https://apiv1.simplifly.tech/api/v1/flight/orders/{orderId}/payments

If only amount is passed, the request defaults to balance payment. For third-party payment, pass channel and returnUrl. Supported third-party channels currently are Airwallex and YeePay.

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: ********************

Path Params

Header Params

Body Params application/jsonRequired

Example

{
    "amount": 0,
    "channel": "balance",
    "returnUrl": "http://example.com"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://apiv1.simplifly.tech/api/v1/flight/orders//payments' \
--header 'code: <api-key>' \
--header 'timestamp: <api-key>' \
--header 'signature: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "amount": 0,
    "channel": "balance",
    "returnUrl": "http://example.com"
}'

Responses

🟢200OK

application/json

Payment response

Bodyapplication/json

Example

{
    "code": 0,
    "message": "string",
    "realMessage": "string",
    "data": {
        "id": "string",
        "originOrderId": "string",
        "externalOrderId": "string",
        "parentOrderId": "string",
        "orderType": "string",
        "status": "string",
        "agencyId": 0,
        "createdAt": "2019-08-24T14:15:22.123Z",
        "updatedAt": "2019-08-24T14:15:22.123Z",
        "lastActionTime": "2019-08-24T14:15:22.123Z",
        "property1": "string",
        "property2": "string"
    }
}

Get order detail by external order id

cancel an order