Payment Order Query

GET

{{HOST}}/api/v2/payment/order/query

Request

Query Params

appId

string

required

appid

Example:

a0c07e56c281c23c9b0bfd94923cfb9d

merOrderNo

string

optional

merOrderNo (orderNo either one or the other)

Example:

20220408123109677

orderNo

string

optional

orderNo (merOrderNo either one)

sign

string

required

sign

Example:

a8e8789b76d43d57d3b72fdfb14f482761e05a192a86048b90710f517369f5f8

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request GET '{{HOST}}/api/v2/payment/order/query?appId=a0c07e56c281c23c9b0bfd94923cfb9d&merOrderNo=20220408123109677&orderNo&sign=a8e8789b76d43d57d3b72fdfb14f482761e05a192a86048b90710f517369f5f8'

Responses

🟢200成功

application/json

Body

code

integer

Response Status Code

required

data

object

Return Data

required

orderStatus

integer

Order status

required

pending: 0,1,-4
success: 2,3
failed: -1,-2
refunded: -3

orderNo

string

Order Number

required

merOrderNo

string

Merchant order number

required

amount

number

Order amount

required

currency

string

Amount in Currency

required

payer

object

Payer Information

optional

createTime

integer

required

updateTime

integer

required

message

string

Descriptive Information

required

This field is returned in case of order exceptions and is used as an exception description.

sign

string

sign

required

msg

string

Return to Text Description

required

Example

{
    "code": 0,
    "data": {
        "orderStatus": 1,
        "orderNo": "202204181618135202315",
        "merOrderNo": "202204181618132264",
        "amount": 1,
        "currency": "BRL",
        "attach": null,
        "payer": {
            "name": "payername",
            "document": "12345678911"
        },
        "createTime": 1650269893522,
        "updateTime": 1650269896604,
        "sign": "3085389dcc9380239a5d60d4c05bc76eed370d252fdb9f3dd7f4556f4b826d4c"
    },
    "msg": "success"
}

Modified at 2025-02-28 15:29:07

Payment Order Create

Payout Order Create