Nomad Broker API changelog
Last update:
API structure has changed
1.7.0
Breaking change
-
Added:
DELETE /settlement/receiver/{merchant}
-
Added:
GET /settlement/receiver/{merchant}
-
Added:
GET /settlement/{merchant}
-
Added:
POST /settlement/receiver/{merchant}
-
Added:
POST /settlement/{merchant}
-
Added:
PUT /settlement/{merchant}
-
Removed:
DELETE /profit/receiver/{merchant}
Breaking -
Removed:
GET /payms/{merchant}
Breaking -
Removed:
GET /profit/sharing/{merchant}
Breaking -
Removed:
POST /payms/callback/{merchant}
Breaking -
Removed:
POST /payms/{merchant}
Breaking -
Removed:
POST /profit/receiver/{merchant}
Breaking -
Removed:
POST /profit/sharing/{merchant}
Breaking -
Removed:
PUT /profit/sharing/{merchant}
Breaking
API structure has changed
1.6.9
-
Modified:
GET /refund/{merchant}
-
order_ref
query parameter was added
-
API structure has changed
1.6.8
-
Modified:
GET /payment/{merchant}
-
200
response was modified-
tradeMessage
body attribute was added
-
-
-
Modified:
POST /payment/{merchant}
-
body was modified
-
spAppId
body attribute was added
-
-
body was modified
API structure has changed
1.6.6
-
Modified:
POST /payment/{merchant}
-
X-Real-Ip
,Client-Id
headers were added
-
API structure has changed
1.6.5
-
Modified:
POST /payment/invocation/{merchant}
-
200
response was modified-
timeStamp
,nonceStr
body attributes were added
-
-
-
Modified:
POST /payment/{merchant}
-
200
response was modified-
timeStamp
,nonceStr
body attributes were added
-
-
API structure has changed
1.6.4
Breaking change
-
Modified:
GET /profit/sharing/{merchant}
-
profit_order_no
query parameter was added -
out_order_no
query parameter was removedBreaking
-
-
Modified:
POST /profit/sharing/{merchant}
-
body was modified
-
orderRef
body attribute was added -
outOrderNo
body attribute was removedBreaking
-
-
body was modified
-
Modified:
PUT /profit/sharing/{merchant}
-
body was modified
-
orderRef
body attribute was added -
outOrderNo
body attribute was removedBreaking
-
-
body was modified
API structure has changed
1.6.3
Breaking change
-
Modified:
GET /refund/{merchant}
-
200
response was modified-
totalAmount
,payerRefund
,payerTotal
,settlementAmount
,settlementTotal
body attributes were added -
payerRefundAmount
body attribute was removedBreaking
-
-
-
Modified:
POST /refund/{merchant}
-
body was modified
-
totalAmount
body attribute was added -
refundTotal
body attribute was removedBreaking -
currency
body attribute was modified
-
-
200
response was modified-
totalAmount
,payerRefund
,payerTotal
,settlementAmount
,settlementTotal
body attributes were added -
payerRefundAmount
body attribute was removedBreaking
-
-
body was modified
API structure has changed
1.6.2
Breaking change
-
Modified:
POST /payment/invocation/{merchant}
-
body was modified
-
payMessage
body attribute was added -
prePayMessage
body attribute was removedBreaking
-
-
200
response was modified-
payInvokeMessage
body attribute was added -
prePayMessage
body attribute was removedBreaking
-
-
body was modified
-
Modified:
POST /payment/{merchant}
-
200
response was modified-
payInvokeMessage
body attribute was added -
prePayMessage
body attribute was removedBreaking
-
-
API structure has changed
1.6.1
Breaking change
-
Modified:
GET /payment/{merchant}
-
200
response was modified-
actualAmount
body attribute was added
-
-
-
Modified:
POST /payment/{merchant}
-
body was modified
-
actualAmount
,costPrice
,invoiceId
,successUrl
,cancelUrl
body attributes were added -
discountCostPrice
,discountInvoiceId
body attributes were removedBreaking -
total
body attribute was modified
-
-
body was modified
API structure has changed
1.6.0
Breaking change
-
Added:
PUT /profit/sharing/{merchant}
-
Modified:
GET /customs/payment/{merchant}
-
order_no
query parameter was added -
out_trade_no
query parameter was removedBreaking -
200
response was modified-
orders
body attribute was added -
body attribute was removed
Breaking
-
-
-
Modified:
POST /customs/identification/{merchant}
-
body was modified
-
orderNo
body attribute was added -
outTradeNo
body attribute was removedBreaking
-
-
200
response was modified-
orderNo
body attribute was added -
outTradeNo
body attribute was removedBreaking
-
-
body was modified
-
Modified:
POST /customs/payment/{merchant}
-
body was modified
-
orderNo
body attribute was added -
outTradeNo
body attribute was removedBreaking
-
-
body was modified
-
Modified:
POST /payment/{merchant}
-
body was modified
-
timeExpire
body attribute was added
-
-
body was modified
-
Modified:
POST /profit/sharing/{merchant}
-
body was modified
-
finishDesc
body attribute was added -
outOrderNo
,transactionId
body attributes were modifiedBreaking
-
-
body was modified
-
Modified:
PUT /customs/payment/{merchant}
-
body was modified
-
orderNo
body attribute was added -
outTradeNo
body attribute was removedBreaking
-
-
body was modified
API structure has changed
1.5.0
-
Added:
POST /customs/identification/{merchant}
-
Added:
POST /payms/callback/{merchant}
-
Modified:
GET /payout/abroad/{merchant}
-
200
response was modified-
payoutOrderId
,foreignCurrency
body attributes were added
-
-
-
Modified:
POST /customs/payment/{merchant}
-
200
response was modified-
orderNo
body attribute was added
-
-
-
Modified:
POST /payment/{merchant}
-
body was modified
-
attach
,goodsTag
body attributes were added
-
-
body was modified
-
Modified:
POST /payout/abroad/{merchant}
-
200
response was modified-
payoutOrderId
,foreignCurrency
body attributes were added
-
-
-
Modified:
POST /payout/bill/abroad/{merchant}
-
200
response was modified-
payoutOrderId
,foreignCurrency
body attributes were added
-
-
-
Modified:
PUT /customs/payment/{merchant}
-
200
response was modified-
orderNo
body attribute was added
-
-
API structure has changed
Breaking change
-
Added:
POST /payms/{merchant}
-
Modified:
DELETE /profit/receiver/{merchant}
-
400
response was modified-
type
,account
body attributes were removedBreaking
-
-
401
response was modified-
type
,account
body attributes were removedBreaking
-
-
500
response was modified-
errors
body attribute was added -
type
,account
body attributes were removedBreaking
-
-
-
Modified:
GET /customs/payment/{merchant}
-
400
response was modified-
customsMessage
,resultCode
,state
,transactionId
,subOrderNo
,modifyTime
,certCheckResult
,verifyDepartment
,verifyDepartmentTradeId
body attributes were removedBreaking
-
-
401
response was modified-
customsMessage
,resultCode
,state
,transactionId
,subOrderNo
,modifyTime
,certCheckResult
,verifyDepartment
,verifyDepartmentTradeId
body attributes were removedBreaking
-
-
500
response was modified-
errors
body attribute was added -
customsMessage
,resultCode
,state
,transactionId
,subOrderNo
,modifyTime
,certCheckResult
,verifyDepartment
,verifyDepartmentTradeId
body attributes were removedBreaking
-
-
-
Modified:
GET /payms/{merchant}
-
200
response was modified-
data
body attribute was added -
prePayUrl
,payUrl
,payPage
body attributes were removedBreaking
-
-
-
Modified:
GET /payout/abroad/{merchant}
-
400
response was modified-
outOrderId
,transactionId
,result
,failReason
,amount
,foreignAmount
,rate
,exchangeRateTime
,estimateExchangeRateTime
,availableAbroadAmount
body attributes were removedBreaking
-
-
401
response was modified-
outOrderId
,transactionId
,result
,failReason
,amount
,foreignAmount
,rate
,exchangeRateTime
,estimateExchangeRateTime
,availableAbroadAmount
body attributes were removedBreaking
-
-
500
response was modified-
errors
body attribute was added -
outOrderId
,transactionId
,result
,failReason
,amount
,foreignAmount
,rate
,exchangeRateTime
,estimateExchangeRateTime
,availableAbroadAmount
body attributes were removedBreaking
-
-
-
Modified:
GET /payout/bill/abroad/{merchant}
-
500
response was modified-
errors
body attribute was added
-
-
-
Modified:
GET /profit/sharing/{merchant}
-
400
response was modified-
outOrderNo
,transactionId
,orderId
,status
,receivers
,finishDescription
,finishAmount
body attributes were removedBreaking
-
-
401
response was modified-
outOrderNo
,transactionId
,orderId
,status
,receivers
,finishDescription
,finishAmount
body attributes were removedBreaking
-
-
500
response was modified-
errors
body attribute was added -
outOrderNo
,transactionId
,orderId
,status
,receivers
,finishDescription
,finishAmount
body attributes were removedBreaking
-
-
-
Modified:
POST /customs/payment/{merchant}
-
400
response was modified-
customsMessage
,resultCode
,state
,transactionId
,subOrderNo
,modifyTime
,certCheckResult
,verifyDepartment
,verifyDepartmentTradeId
body attributes were removedBreaking
-
-
401
response was modified-
customsMessage
,resultCode
,state
,transactionId
,subOrderNo
,modifyTime
,certCheckResult
,verifyDepartment
,verifyDepartmentTradeId
body attributes were removedBreaking
-
-
500
response was modified-
errors
body attribute was added -
customsMessage
,resultCode
,state
,transactionId
,subOrderNo
,modifyTime
,certCheckResult
,verifyDepartment
,verifyDepartmentTradeId
body attributes were removedBreaking
-
-
-
Modified:
POST /payout/abroad/{merchant}
-
400
response was modified-
outOrderId
,transactionId
,result
,failReason
,amount
,foreignAmount
,rate
,exchangeRateTime
,estimateExchangeRateTime
,availableAbroadAmount
body attributes were removedBreaking
-
-
401
response was modified-
outOrderId
,transactionId
,result
,failReason
,amount
,foreignAmount
,rate
,exchangeRateTime
,estimateExchangeRateTime
,availableAbroadAmount
body attributes were removedBreaking
-
-
500
response was modified-
errors
body attribute was added -
outOrderId
,transactionId
,result
,failReason
,amount
,foreignAmount
,rate
,exchangeRateTime
,estimateExchangeRateTime
,availableAbroadAmount
body attributes were removedBreaking
-
-
-
Modified:
POST /profit/receiver/{merchant}
-
400
response was modified-
type
,account
body attributes were removedBreaking
-
-
401
response was modified-
type
,account
body attributes were removedBreaking
-
-
500
response was modified-
errors
body attribute was added -
type
,account
body attributes were removedBreaking
-
-
-
Modified:
POST /profit/sharing/{merchant}
-
400
response was modified-
outOrderNo
,transactionId
,orderId
,status
,receivers
,finishDescription
,finishAmount
body attributes were removedBreaking
-
-
401
response was modified-
outOrderNo
,transactionId
,orderId
,status
,receivers
,finishDescription
,finishAmount
body attributes were removedBreaking
-
-
500
response was modified-
errors
body attribute was added -
outOrderNo
,transactionId
,orderId
,status
,receivers
,finishDescription
,finishAmount
body attributes were removedBreaking
-
-
-
Modified:
PUT /customs/payment/{merchant}
-
400
response was modified-
customsMessage
,resultCode
,state
,transactionId
,subOrderNo
,modifyTime
,certCheckResult
,verifyDepartment
,verifyDepartmentTradeId
body attributes were removedBreaking
-
-
401
response was modified-
customsMessage
,resultCode
,state
,transactionId
,subOrderNo
,modifyTime
,certCheckResult
,verifyDepartment
,verifyDepartmentTradeId
body attributes were removedBreaking
-
-
500
response was modified-
errors
body attribute was added -
customsMessage
,resultCode
,state
,transactionId
,subOrderNo
,modifyTime
,certCheckResult
,verifyDepartment
,verifyDepartmentTradeId
body attributes were removedBreaking
-
-
API structure has changed
1.4.11
-
Added:
GET /refund/{merchant}
-
Added:
POST /refund/{merchant}
API structure has changed
1.4.10
Breaking change
-
Modified:
GET /customs/payment/{merchant}
-
200
response was modified-
customsMessage
body attribute was added
-
-
400
response was modified-
customsMessage
body attribute was added
-
-
401
response was modified-
customsMessage
body attribute was added
-
-
500
response was modified-
customsMessage
body attribute was added
-
-
-
Modified:
POST /customs/payment/{merchant}
-
200
response was modified-
customsMessage
body attribute was added
-
-
400
response was modified-
customsMessage
body attribute was added
-
-
401
response was modified-
customsMessage
body attribute was added
-
-
500
response was modified-
customsMessage
body attribute was added
-
-
-
Modified:
POST /payment/invocation/{merchant}
-
body was modified
-
prePayMessage
,timeStamp
,nonceStr
body attributes were added -
invocationUrl
body attribute was removedBreaking
-
-
200
response was modified-
prePayMessage
,payMessage
body attributes were added -
prePayUrl
,payUrl
,payPage
body attributes were removedBreaking
-
-
body was modified
-
Modified:
POST /payment/{merchant}
-
body was modified
-
payerId
,merchantPayerId
,notifyUrl
body attributes were added
-
-
200
response was modified-
prePayMessage
,payMessage
body attributes were added -
prePayUrl
,payUrl
,payPage
body attributes were removedBreaking
-
-
body was modified
-
Modified:
PUT /customs/payment/{merchant}
-
200
response was modified-
customsMessage
body attribute was added
-
-
400
response was modified-
customsMessage
body attribute was added
-
-
401
response was modified-
customsMessage
body attribute was added
-
-
500
response was modified-
customsMessage
body attribute was added
-
-
API structure has changed
1.4.9
Breaking change
-
Added:
GET /payms/{merchant}
-
Modified:
DELETE /profit/receiver/{merchant}
-
payment_method
query parameter was added
-
-
Modified:
GET /customs/payment/{merchant}
-
payment_method
query parameter was added
-
-
Modified:
GET /payment/{merchant}
-
payment_method
query parameter was added
-
-
Modified:
GET /payout/abroad/{merchant}
-
payment_method
query parameter was added
-
-
Modified:
GET /payout/bill/abroad/{merchant}
-
payment_method
query parameter was added
-
-
Modified:
GET /profit/sharing/{merchant}
-
payment_method
query parameter was added
-
-
Modified:
POST /customs/payment/{merchant}
-
body was modified
-
paymentMethod
body attribute was added
-
-
body was modified
-
Modified:
POST /payment/close/{merchant}/{order_ref}
-
payment_method
query parameter was added
-
-
Modified:
POST /payment/{merchant}
-
body was modified
-
products
,discountCostPrice
,discountInvoiceId
body attributes were added -
product
body attribute was removedBreaking
-
-
body was modified
-
Modified:
POST /payout/abroad/{merchant}
-
body was modified
-
paymentMethod
body attribute was added -
goodsInfo
body attribute was modified
-
-
body was modified
-
Modified:
POST /payout/bill/abroad/{merchant}
-
body was modified
-
paymentMethod
body attribute was added
-
-
body was modified
-
Modified:
POST /profit/receiver/{merchant}
-
body was modified
-
paymentMethod
body attribute was added
-
-
body was modified
-
Modified:
POST /profit/sharing/{merchant}
-
body was modified
-
paymentMethod
body attribute was added
-
-
body was modified
-
Modified:
PUT /customs/payment/{merchant}
-
body was modified
-
paymentMethod
body attribute was added
-
-
body was modified
-
Removed:
POST /declare
Breaking -
Removed:
POST /declare-order/youzan
Breaking -
Removed:
POST /pay
Breaking -
Removed:
POST /query-order/youzan
Breaking
API structure has changed
1.4.8-alpha
Breaking change
-
Added:
GET /payout/bill/abroad/{merchant}
-
Added:
POST /payout/bill/abroad/{merchant}
-
Modified:
GET /payout/abroad/{merchant}
-
200
response was modified-
transactionId
,availableAbroadAmount
body attributes were added -
orderId
body attribute was removedBreaking
-
-
400
response was modified-
transactionId
,availableAbroadAmount
body attributes were added -
orderId
body attribute was removedBreaking
-
-
401
response was modified-
transactionId
,availableAbroadAmount
body attributes were added -
orderId
body attribute was removedBreaking
-
-
500
response was modified-
transactionId
,availableAbroadAmount
body attributes were added -
orderId
body attribute was removedBreaking
-
-
-
Modified:
POST /payout/abroad/{merchant}
-
200
response was modified-
transactionId
,availableAbroadAmount
body attributes were added -
orderId
body attribute was removedBreaking
-
-
400
response was modified-
transactionId
,availableAbroadAmount
body attributes were added -
orderId
body attribute was removedBreaking
-
-
401
response was modified-
transactionId
,availableAbroadAmount
body attributes were added -
orderId
body attribute was removedBreaking
-
-
500
response was modified-
transactionId
,availableAbroadAmount
body attributes were added -
orderId
body attribute was removedBreaking
-
-
API structure has changed
1.4.7
Breaking change
-
Modified:
GET /payment/{merchant}
-
401
response was modified-
code
,message
body attributes were added -
field
,msg
body attributes were removedBreaking
-
-
500
response was modified-
code
,message
body attributes were added
-
-
-
Modified:
POST /declare
-
401
response was modified-
code
,message
body attributes were added -
field
,msg
body attributes were removedBreaking
-
-
422
response was modified-
code
,message
body attributes were added -
field
,msg
body attributes were removedBreaking
-
-
500
response was modified-
code
,message
body attributes were added
-
-
-
Modified:
POST /declare-order/youzan
-
401
response was modified-
code
,message
body attributes were added -
field
,msg
body attributes were removedBreaking
-
-
422
response was modified-
code
,message
body attributes were added -
field
,msg
body attributes were removedBreaking
-
-
500
response was modified-
code
,message
body attributes were added
-
-
-
Modified:
POST /payment/close/{merchant}/{order_ref}
-
401
response was modified-
code
,message
body attributes were added -
field
,msg
body attributes were removedBreaking
-
-
422
response was modified-
code
,message
body attributes were added -
field
,msg
body attributes were removedBreaking
-
-
500
response was modified-
code
,message
body attributes were added
-
-
-
Modified:
POST /payment/invocation/{merchant}
-
401
response was modified-
code
,message
body attributes were added -
field
,msg
body attributes were removedBreaking
-
-
422
response was modified-
code
,message
body attributes were added -
field
,msg
body attributes were removedBreaking
-
-
500
response was modified-
code
,message
body attributes were added
-
-
-
Modified:
POST /payment/{merchant}
-
401
response was modified-
code
,message
body attributes were added -
field
,msg
body attributes were removedBreaking
-
-
422
response was modified-
code
,message
body attributes were added -
field
,msg
body attributes were removedBreaking
-
-
500
response was modified-
code
,message
body attributes were added
-
-
-
Modified:
POST /query-order/youzan
-
401
response was modified-
code
,message
body attributes were added -
field
,msg
body attributes were removedBreaking
-
-
422
response was modified-
code
,message
body attributes were added -
field
,msg
body attributes were removedBreaking
-
-
500
response was modified-
code
,message
body attributes were added
-
-
API structure has changed
1.4.6
Breaking change
-
Modified:
GET /payment/{merchant}
Breaking-
order_ref
query parameter was addedBreaking -
order_ref
path parameter was removedBreaking
-
API structure has changed
1.4.5
Breaking change
-
Added:
DELETE /profit/receiver/{merchant}
-
Added:
GET /profit/sharing/{merchant}
-
Added:
POST /profit/receiver/{merchant}
-
Added:
POST /profit/sharing/{merchant}
-
Modified:
POST /payment/{merchant}
-
body was modified
-
profitSharing
,subsidyAmount
body attributes were added -
orderSuccessUrl
body attribute was removedBreaking
-
-
body was modified
API structure has changed
1.4.2
-
Added:
GET /payout/abroad/{merchant}
-
Added:
POST /payout/abroad/{merchant}