API docs by Redocly

Online Payment Gateway (20260825)

Download OpenAPI specification:

License: Global

Visa & Mastercard支付服务商 & Global Collection Account

Access Token

Authentication / 授权

Request an access token / 获取凭证令牌

Your access token authorizes you to use the payment REST api server Please keep the key information safe and secure

Authorizations:
Authorization
Request Body schema: application/json
appId
required
string

Merchant client id

secret
required
string

Merchant client secret

Responses

Request samples

Content type
application/json
{
  • "appId": "086666075137001",
  • "secret": "184E52CF5365D2D7EE8EDA************"
}

Checkout Session

Checkout Sessions / 收单收银台pay by link

Create a Payment Link / 创建支付链接

Checkout session

Authorizations:
Authorization
Request Body schema: application/json
amount
required
string

eg 100.99

object (Billing)

Billing

captureMethod
string

auto、manual

currency
required
string

ISO 4217 code eg USD

description
string

Description [1..25] characters

expiryTime
string

Expire time [30-120]minutes

fraudMode
string

Fraud Mode

frontUrl
string

Redirect url [3..128] characters

linkMode
string

Cashier mode - please contact the operations personnel

object

metadata

notificationUrl
string

Notification Url eg https://api.xxx.com/notify

orderNo
required
string

Order no [5..64] characters

paymentMethodType
string

Payment Method eg card

Array of objects (ProductInfo)

Product information

object (Shipping)

Shipping

threeDsMode
string

no、auto、standard

Responses

Request samples

Content type
application/json
{
  • "amount": "100.99",
  • "billing": {
    },
  • "captureMethod": "auto",
  • "currency": "USD",
  • "description": "string",
  • "expiryTime": "60",
  • "fraudMode": "N",
  • "frontUrl": "https://www.example.com",
  • "linkMode": "session",
  • "metadata": {
    },
  • "notificationUrl": "string",
  • "orderNo": "20220828000002",
  • "paymentMethodType": "card",
  • "productInfo": [],
  • "shipping": {
    },
  • "threeDsMode": "no、auto、standard"
}

Exchange

Provided a global FX platform based on API / 提供了基于全面API的全球FX平台

申请换汇

申请换汇

Authorizations:
Authorization
Request Body schema: application/json
description
required
string [ 1 .. 64 ] characters

Description

obo
required
string [ 5 .. 20 ] characters

Merchant number

orderNo
required
string [ 0 .. 32 ] characters ^[a-zA-Z0-9_-]+$

Partner order number

quoteId
required
string [ 0 .. 64 ] characters

Quote ID

Responses

Request samples

Content type
application/json
{
  • "description": "附言信息",
  • "obo": "00001",
  • "orderNo": "202608240002",
  • "quoteId": "0c0b344bc1d020ffc40b20e71d980100"
}

换汇历史

换汇历史

Authorizations:
Authorization
query Parameters
buyAccount
string [ 0 .. 32 ] characters [ 0 .. 32 ]

Buy global account

createdAtEnd
required
string [ 0 .. 19 ] characters [ 0 .. 19 ] ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

Create end time

createdAtStart
required
string [ 0 .. 19 ] characters [ 0 .. 19 ] ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

Create start time

currencyPair
string = 7 characters [ 7 .. 7 ]

货币对

obo
string [ 5 .. 20 ] characters [ 5 .. 20 ]

obo

pageNo
required
string [ 1 .. 99999999 ]

当前页码,最小为1

pageSize
required
string [ 10 .. 100 ]

分页条数,最小10条,最大100条

quoteId
string [ 0 .. 64 ] characters [ 0 .. 64 ]

Quote ID

sellAccount
string [ 0 .. 32 ] characters [ 0 .. 32 ]

Sell global account

tradeNo
string [ 0 .. 32 ] characters [ 0 .. 32 ]

Platform trade number

tradeStatus
string

Trade status

Responses

换汇询价

换汇询价

Authorizations:
Authorization
Request Body schema: application/json
obo
required
string [ 5 .. 20 ] characters

Merchant number

required
object (PartnerExchangeQuoteTradeInfo)

Exchange quote trade info

Responses

Request samples

Content type
application/json
{
  • "obo": "00001",
  • "tradeInfo": {
    }
}

换汇详情

换汇详情

Authorizations:
Authorization
query Parameters
obo
required
string [ 5 .. 32 ] characters [ 5 .. 32 ]

OBO

orderNo
required
string [ 0 .. 32 ] characters [ 0 .. 32 ]

Partner order number

Responses

Global Collection Account

Quick account opening,beneficiary management,payment,webhook,and balance inquiry / 快速开户、受益人管理、付款、webhook以及余额查询等

全球账户余额

全球账户余额

Authorizations:
Authorization
query Parameters
globalAccount
string [ 1 .. 50 ] characters [ 1 .. 50 ]

Global account number

obo
required
string [ 5 .. 20 ] characters [ 5 .. 20 ]

obo

Responses

日终余额

日终余额

Authorizations:
Authorization
query Parameters
bookingDate
required
string = 10 characters [ 10 .. 10 ] ^\d{4}-\d{2}-\d{2}$

Booking date

currency
string

Currency

obo
string [ 5 .. 20 ] characters [ 5 .. 20 ]

Merchant number

pageNo
required
string [ 1 .. 99999999 ]

当前页码,最小为1

pageSize
required
string [ 10 .. 100 ]

分页条数,最小10条,最大100条

Responses

创建全球账户

创建全球账户

Authorizations:
Authorization
Request Body schema: application/json
accountPurpose
required
string [ 0 .. 2 ] characters

Account Purpose

bank
required
string [ 0 .. 50 ] characters

bankingcircle

country
string = 2 characters

Country Code

currencies
required
Array of strings

Currencies

defaultCurrency
string

Enums: GBP,上送的值必须是集合 currencies 中的一个

nickName
required
string [ 0 .. 50 ] characters

Nick Name

obo
required
string [ 5 .. 20 ] characters

Merchant number

requestId
required
string [ 0 .. 64 ] characters

Request ID

Responses

Request samples

Content type
application/json
{
  • "accountPurpose": "1",
  • "bank": "ifast/bankingcircle",
  • "country": "GB",
  • "currencies": "[\"GBP\",\"HKD\"]",
  • "defaultCurrency": "GBP",
  • "nickName": "CC",
  • "obo": "00001",
  • "requestId": "b4e9c9fc7a4545e493239c65d8f6b32e"
}

全球账户详情

全球账户详情

Authorizations:
Authorization
query Parameters
currency
string

Currency

globalAccount
required
string

Global account number

obo
required
string [ 5 .. 20 ] characters [ 5 .. 20 ]

Merchant number

Responses

全球账户列表

全球账户列表

Authorizations:
Authorization
query Parameters
obo
string [ 5 .. 20 ] characters [ 5 .. 20 ]

obo

pageNo
required
string [ 1 .. 99999999 ]

当前页码,最小为1

pageSize
required
string [ 10 .. 100 ]

分页条数,最小10条,最大100条

Responses

新增收款人

新增收款人

Authorizations:
Authorization
Request Body schema: application/json
required
object (PartnerBankAccountInfo)

Structured bank account information

required
object (PartnerBeneficiaryInfo)

Structured beneficiary information

obo
required
string [ 1 .. 20 ] characters

Merchant number

Responses

Request samples

Content type
application/json
{
  • "bankAccountInfo": {
    },
  • "beneficiaryInfo": {
    },
  • "obo": "00001"
}

删除收款人

删除收款人

Authorizations:
Authorization
Request Body schema: application/json
beneficiaryId
required
string [ 1 .. 50 ] characters

Beneficiary ID

obo
required
string [ 5 .. 20 ] characters

Merchant number

Responses

Request samples

Content type
application/json
{
  • "beneficiaryId": "10001",
  • "obo": "00001"
}

收款人详情

收款人详情

Authorizations:
Authorization
query Parameters
beneficiaryId
required
string [ 1 .. 30 ] characters [ 1 .. 30 ]

Beneficiary ID

obo
required
string [ 1 .. 20 ] characters [ 1 .. 20 ]

OBO (On Behalf Of)

Responses

收款人列表

收款人列表

Authorizations:
Authorization
query Parameters
accountName
string [ 0 .. 150 ] characters [ 0 .. 150 ]

Account name

accountNumber
string [ 0 .. 100 ] characters [ 0 .. 100 ]

Bank account number

companyName
string [ 0 .. 200 ] characters [ 0 .. 200 ]

Company name

currency
string [ 0 .. 3 ] characters [ 0 .. 3 ]

Currency

nickName
string [ 0 .. 100 ] characters [ 0 .. 100 ]

Nickname

obo
required
string [ 5 .. 20 ] characters [ 5 .. 20 ]

Merchant number

pageNo
required
string [ 1 .. 99999999 ]

当前页码,最小为1

pageSize
required
string [ 10 .. 100 ]

分页条数,最小10条,最大100条

reviewStatus
string

pending_approval、approved、rejected

Responses

修改收款人

修改收款人

Authorizations:
Authorization
Request Body schema: application/json
required
object (PartnerBankAccountInfo)

Structured bank account information

beneficiaryId
required
string [ 1 .. 50 ] characters

Beneficiary ID (required). Primary key of an existing beneficiary to update. Numeric string

required
object (PartnerBeneficiaryInfo)

Structured beneficiary information

obo
required
string [ 5 .. 20 ] characters

Merchant number

Responses

Request samples

Content type
application/json
{
  • "bankAccountInfo": {
    },
  • "beneficiaryId": "10001",
  • "beneficiaryInfo": {
    },
  • "obo": "00001"
}

交易补充资料

交易补充资料

Authorizations:
Authorization
Request Body schema: application/json
bizNo
required
string [ 0 .. 64 ] characters

Business number

bizType
required
string

Enums: payout、collection

extension
object

Extension pass-through

required
Array of objects (PartnerSupplementFileItem)

File list

obo
required
string [ 5 .. 20 ] characters

Operating entity number

remark
string [ 0 .. 500 ] characters

Remark

Responses

Request samples

Content type
application/json
{
  • "bizNo": "T202608200001",
  • "bizType": "payout",
  • "extension": { },
  • "files": [
    ],
  • "obo": "B1000001",
  • "remark": "supplement invoice"
}

创建付款

autoQuote=true: platform quotes internally. autoQuote=false: a valid quoteId is required. orderNo is required and used as the idempotency key

Authorizations:
Authorization
Request Body schema: application/json
autoQuote
required
string

true: quote inside payout flow, no prior quote call; false: quoteId is required

required
object (PartnerPaymentBeneficiaryInfo)

Beneficiary info

obo
required
string [ 5 .. 20 ] characters

Merchant number

orderNo
required
string [ 3 .. 32 ] characters

Partner order number

required
object (PartnerPaymentPayerInfo)

Payer info

quoteId
string [ 0 .. 32 ] characters

Quote ID

required
object (PartnerPaymentTradeInfo)

Payout trade info

Responses

Request samples

Content type
application/json
{
  • "autoQuote": "true",
  • "beneficiaryInfo": {
    },
  • "obo": "00001",
  • "orderNo": "202608130001",
  • "payerInfo": {
    },
  • "quoteId": "Q202608130001",
  • "tradeInfo": {
    }
}

内部转账

Authorizations:
Authorization
Request Body schema: application/json
required
object (PartnerPaymentBeneficiaryModel)

request

obo
required
string [ 5 .. 20 ] characters

Merchant number

orderNo
required
string [ 1 .. 32 ] characters

Partner order number

required
object (PartnerPaymentPayerInfo)

Payer info

required
object (PartnerPaymentTradeInfoModel)

request

Responses

Request samples

Content type
application/json
{
  • "beneficiaryInfo": {
    },
  • "obo": "00001",
  • "orderNo": "202608130001",
  • "payerInfo": {
    },
  • "tradeInfo": {
    }
}

付款目的数据查询

付款目的数据查询

Authorizations:
Authorization
query Parameters
bank
required
string [ 0 .. 50 ] characters [ 0 .. 50 ]

bankingcircle、ifast

Responses

询价

Preview payout method, fee and FX. Returns quoteId, which is required when autoQuote=false

Authorizations:
Authorization
Request Body schema: application/json
required
object (PartnerPaymentBeneficiaryInfo)

Beneficiary info

obo
required
string [ 5 .. 20 ] characters

Merchant number

required
object (PartnerPaymentPayerInfo)

Payer info

requestId
required
string [ 0 .. 32 ] characters

Request ID

required
object (PartnerQuoteTradeInfo)

Quote trade info

Responses

Request samples

Content type
application/json
{
  • "beneficiaryInfo": {
    },
  • "obo": "00001",
  • "payerInfo": {
    },
  • "requestId": "REQ202608130001",
  • "tradeInfo": {
    }
}

付款状态查询

付款状态查询

Authorizations:
Authorization
query Parameters
obo
required
string [ 5 .. 20 ] characters [ 5 .. 20 ]

Merchant number

orderNo
required
string [ 1 .. 32 ] characters [ 1 .. 32 ]

202608130001

Responses

交易明细列表

交易明细列表

Authorizations:
Authorization
query Parameters
beneficiaryName
string [ 0 .. 255 ] characters [ 0 .. 255 ]

Beneficiary name

currency
string [ 0 .. 3 ] characters [ 0 .. 3 ]

USD

obo
string [ 5 .. 20 ] characters [ 5 .. 20 ]

Merchant number

orderNo
string [ 0 .. 32 ] characters [ 0 .. 32 ]

202608130001

pageNo
required
string [ 1 .. 99999999 ]

当前页码,最小为1

pageSize
required
string [ 10 .. 100 ]

分页条数,最小10条,最大100条

paymentCode
string [ 0 .. 32 ] characters [ 0 .. 32 ]

SWIFT

tradeNo
string [ 0 .. 32 ] characters [ 0 .. 32 ]

Platform trade number

tradeStatus
string [ 0 .. 32 ] characters [ 0 .. 32 ] ^(processing|success|failed|pending_supplemen...

Enums: processing、success、failed、pending_supplement、under_review

tradeTimeAtEnd
required
string = 19 characters [ 19 .. 19 ] ^$|^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

2026-08-13 23:59:59

tradeTimeAtStart
required
string = 19 characters [ 19 .. 19 ] ^$|^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

2026-08-13 00:00:00

Responses

webhook订阅状态启停

webhook订阅状态启停

Authorizations:
Authorization
Request Body schema: application/json
enableStatus
required
string^[YN]$

Enable status

Responses

Request samples

Content type
application/json
{
  • "enableStatus": "Y"
}

webhook订阅事件集合

webhook订阅事件集合

Authorizations:
Authorization

Responses

修改webhook订阅

修改webhook订阅

Authorizations:
Authorization
Request Body schema: application/json
apiVersion
required
string = 8 characters

Enums: 20260813、20260101

enableStatus
required
string^[YN]$

Enums: Y、N 当上送Y的时候表示启用 当上送N的时候表示停用

eventIds
Array of strings

事件集合id

signMethod
required
string [ 0 .. 32 ] characters

Enums: sha256

webhookUrl
required
string [ 3 .. 512 ] characters ^https?://(?:(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,}...

Webhook URL

Responses

Request samples

Content type
application/json
{}

webhook订阅详情

webhook订阅详情

Authorizations:
Authorization

Responses

webhook订阅

webhook订阅

Authorizations:
Authorization
Request Body schema: application/json
apiVersion
required
string = 8 characters

Enums: 20260813、20260101

signMethod
required
string [ 0 .. 32 ] characters

Enums: sha256

webhookUrl
required
string [ 3 .. 512 ] characters ^https?://(?:(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,}...

Webhook webhook url

Responses

Request samples

Content type
application/json
{}

Onboarding

Onboarding / 快速入网

obo提交入网

obo提交入网

Authorizations:
Authorization
Request Body schema: application/json
areaCode
required
string [ 1 .. 5 ] characters

44、852、65

email
required
string [ 3 .. 128 ] characters
required
object (Enterprise)

Enterprise

oboType
required
string

Enums: enterprise、individual

phone
required
string [ 0 .. 30 ] characters

phone number

productType
required
string

globalaccount、acquiring、globalaccount&acquiring

requestId
required
string [ 5 .. 64 ] characters ^[a-zA-Z0-9_-]+$

流水号 length 5~64

userId
string [ 0 .. 40 ] characters ^[0-9]+$

User Id

Responses

Request samples

Content type
application/json
{
  • "areaCode": "44",
  • "email": "exp@xxx.com",
  • "enterprise": {
    },
  • "oboType": "enterprise",
  • "phone": "15989890000",
  • "productType": "globalaccount",
  • "requestId": "202608130001",
  • "userId": "26080133"
}

obo信息查询

obo信息查询

Authorizations:
Authorization
query Parameters
obo
string [ 0 .. 30 ] characters [ 0 .. 30 ]

obo

userId
string [ 0 .. 30 ] characters [ 0 .. 30 ]

userId

Responses

obo状态查询

obo状态查询

Authorizations:
Authorization
query Parameters
obo
string [ 0 .. 30 ] characters [ 0 .. 30 ]

obo

userId
string [ 0 .. 30 ] characters [ 0 .. 30 ]

userId

Responses

obo入网信息修改

obo入网信息修改

Authorizations:
Authorization
Request Body schema: application/json
required
object (EnterpriseUpdateBaseInfo)

EnterpriseUpdateBaseInfo

Array of objects (PersonInfoUpdate)

Enterprise Beneficiaries Information

Array of objects (PersonInfoUpdate)

Enterprise Legal Information

obo
required
string [ 5 .. 20 ] characters

OBO (On Behalf Of). Max length 30.OBO identifier (required)

Responses

Request samples

Content type
application/json
{
  • "enterpriseBaseInfo": {
    },
  • "enterpriseBeneficiariesInfo": [
    ],
  • "enterpriseLegalInfo": [
    ],
  • "obo": "54731"
}

用户注册

用户注册

Authorizations:
Authorization
Request Body schema: application/json
country
required
string = 2 characters

公司注册所在国家 ISO 3166 code

email
required
string [ 3 .. 128 ] characters

有效邮箱号 length 3~128

firstName
required
string [ 2 .. 40 ] characters

名

lastName
required
string [ 2 .. 40 ] characters

姓

password
required
string [ 8 .. 25 ] characters

password length 8~25

Responses

Request samples

Content type
application/json
{
  • "country": "GB",
  • "email": "xxx@example.com",
  • "firstName": "string",
  • "lastName": "string",
  • "password": "cC12345678."
}

上传文件

上传文件

Authorizations:
Authorization
Request Body schema: multipart/form-data
file
required
string <binary>

bankingcircle最大支持5M、ifast最大支持10M,请按实际需求上传符合条件的文件资料；支持格式:jpg, jpeg, png, pdf, doc, docx, zip, rar, 7z, gz, tar

Responses

Payment Intents

Request a payment、refund / 快速接入支付、申请退款以及查询等

Get Payment details

inquiry Requests

Authorizations:
Authorization
Request Body schema: application/json
orderNo
string

订单编号/平台流水号任意上送其中一个即可

paymentMethodType
required
string

支付方式枚举值(M)

tradeNo
string

平台流水号/订单编号任意上送其中一个即可

Responses

Request samples

Content type
application/json
{
  • "orderNo": "202308161615130001",
  • "paymentMethodType": "card、payNow、wechat、upi、upay、alipay、alipayPlus、payNow、shopeePay",
  • "tradeNo": "202308161615130001"
}

Get refund details

inquiry Requests

Authorizations:
Authorization
Request Body schema: application/json
orderNo
string

订单编号/平台流水号任意上送其中一个即可

paymentMethodType
required
string

支付方式枚举值(M)

tradeNo
string

平台流水号/订单编号任意上送其中一个即可

Responses

Request samples

Content type
application/json
{
  • "orderNo": "202308161615130001",
  • "paymentMethodType": "card、payNow、wechat、upi、upay、alipay、alipayPlus、payNow、shopeePay",
  • "tradeNo": "202308161615130001"
}

Request a payment / server to server 的对接方式，快速接入支付服务

使用任何可用的付款方式创建新付款

Authorizations:
Authorization
Request Body schema: application/json
object (Alipay)

Alipay

object (AlipayPlus)

AlipayPlus

amount
required
string

Amount 100.98

object (Billing)

Billing

object (Card)

Card

currency
required
string

USD、SGD、GBP、EUR、JPY、HKD、ISO-4217

description
string

eg buy a apple

required
object (DeviceInfo)

DeviceInfo

expiryTime
string

eg 60

fraudMode
string

N、Y

frontUrl
string

Redirect url eg.https://api.xxx.com/callback;After the transaction is completed, a redirect will occur with the provided example parameters:{frontUrl}?tradeNo={tradeNo}&orderNo={orderNo}&status={orderStatus}&language=en-US&amount={amount}

object (GrabPay)

GrabPay

object

metadata K -V

notificationUrl
string

Webhook notify url eg.https://api.xxx.com/gateway/notify

orderNo
required
string

string[5..64]

object (PayNow)

PayNow info

paymentMethodType
required
string

card、payNow、paypal、wechat、upay、alipay、alipayPlus、shopeePay、applePay、googlePay、cashPay、zip、affirm、ideal、klarna、afterpay、bancontact、billie

object (PayPal)

PayPal

Array of objects (ProductInfo)

Product Info

object (Shipping)

Shipping

object (ShopeePay)

ShopeePay

object (ThreeDsData)

3ds infomation

threeDsMode
string

no、auto、standard

object (Upay)

Upay

object (Wechat)

Wechat

Responses

Request samples

Content type
application/json
{
  • "alipay": {
    },
  • "alipayPlus": {
    },
  • "amount": "199.68",
  • "billing": {
    },
  • "card": {
    },
  • "currency": "USD、SGD、HKD、ISO-4217",
  • "description": "buy a apple",
  • "deviceInfo": {
    },
  • "expiryTime": "60",
  • "fraudMode": "N、Y",
  • "frontUrl": "https://www.xxx.com",
  • "grabPay": {
    },
  • "metadata": {
    },
  • "notificationUrl": "https://api.xxx.com/gateway/notify",
  • "orderNo": "20220828000002",
  • "payNow": {
    },
  • "paymentMethodType": "card、payNow、paypal、wechat、upay、alipay、alipayPlus、shopeePay、applePay、googlePay、cashPay、zip、affirm、ideal、klarna、afterpay、bancontact、billie...",
  • "paypal": {
    },
  • "productInfo": [],
  • "shipping": {
    },
  • "shopeePay": {
    },
  • "threeDsData": {
    },
  • "threeDsMode": "no、auto、standard",
  • "upay": {
    },
  • "wechat": {
    }
}

Refund a payment

Refund objects allow you to refund a previously created charge that isn’t refunded yet. Funds are refunded to the credit or debit card that’s initially charged.

Authorizations:
Authorization
Request Body schema: application/json
amount
required
string

amount

clientIp
required
string

Client ip

notificationUrl
string

通知地址

orderNo
string

Transaction order no

reason
required
string

reason

refundNumber
required
string

Refund order no

tradeNo
string

Transaction reference

Responses

Request samples

Content type
application/json
{
  • "amount": "100.99",
  • "clientIp": "10.1.1.1",
  • "notificationUrl": "string",
  • "orderNo": "string",
  • "reason": "The product does not match the description",
  • "refundNumber": "202208280000001",
  • "tradeNo": "string"
}

Tracking

Tracking / 物流信息登记

Retrieve Tracking Details

Retrieve Tracking Details

Authorizations:
Authorization
Request Body schema: application/json
object

matedata

orderNo
required
string

Order no

trackingNo
required
string

Tracking No

Responses

Request samples

Content type
application/json
{
  • "matedata": "K-V",
  • "orderNo": "202308161615130001",
  • "trackingNo": "202208290000001"
}

Add logistics information for a single order

Adds tracking information for an Order.

Authorizations:
Authorization
Request Body schema: application/json
carrier
required
string

carrier

orderNo
required
string

Order no [5..64]

shipmentDate
required
string

Shipment date

shipmentDirection
required
string

Shipment direction

shippingStatus
required
string

Status

trackingNo
required
string

Tracking no

trackingNumberType
required
string

Tracking number type

trackingUrl
string

tracking url

Responses

Request samples

Content type
application/json
{
  • "carrier": "2EBOX",
  • "orderNo": "202308161615130001",
  • "shipmentDate": "2025-06-09",
  • "shipmentDirection": "FORWARD",
  • "shippingStatus": "SHIPPED、CANCELLED、DELIVERED",
  • "trackingNo": "Fb202208290000001",
  • "trackingNumberType": "CARRIER_PROVIDED",
  • "trackingUrl": "https://t.17track.net/en#nums=76708433717662"
}

Batch add logistics information for orders

Add tracking information for multiple for Order.

Authorizations:
Authorization
Request Body schema: application/json
Array
carrier
required
string

carrier

orderNo
required
string

Order no [5..64]

shipmentDate
required
string

Shipment date

shipmentDirection
required
string

Shipment direction

shippingStatus
required
string

Status

trackingNo
required
string

Tracking no

trackingNumberType
required
string

Tracking number type

trackingUrl
string

tracking url

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Updates or cancels the tracking

Updates or cancels the tracking information for a order

Authorizations:
Authorization
Request Body schema: application/json
required
Array of objects (TrackingIterm)
object

matedata K-V

orderNo
required
string

Order no [5..64]

trackingNo
required
string

tracking no

Responses

Request samples

Content type
application/json
{
  • "iterms": [
    ],
  • "matedata": "K-V",
  • "orderNo": "202308161615130001",
  • "trackingNo": "FB202208290000001"
}

Wechat Customs Declaration

Customs Declaration 海关申报单

海关申报单

海关申报单 Tenpay的10位数字海关注册号为：4403169D3W

Authorizations:
Authorization
Request Body schema: application/json
customs
required
duty
string

Tariff (in 0.01 CNY). It is not required and will not be submitted to the customs.

feeType
required
string [ 1 .. 32 ] characters

The currency used for order payment via WeChat Pay. Only CNY is currently supported. It is required if there is a split order.

merchantCustomNo
required
string [ 1 .. 32 ] characters

Customs registration No. of the merchant

orderFee
string

mount (in 0.01 CNY). Cannot exceed the original order amount. order_fee=transport_fee+product_fee (payable amount = logistics fee + product price). It is required if there is a split order

productFee
string

Product price (in 0.01 CNY). It is required if there is a split order.

tradeNo
required
string [ 5 .. 50 ] characters
transportFee
string

Logistics fee (in 0.01 CNY). It is required if there is a split order.

Responses

Request samples

Content type
application/json
{
  • "customs": "SHANGHAI_ZS",
  • "duty": "0.01",
  • "feeType": "CNY",
  • "merchantCustomNo": "123456",
  • "orderFee": "0.01",
  • "productFee": "0.01",
  • "tradeNo": "26013014374061701",
  • "transportFee": "0.01"
}