Change Updates

Do not miss any Nomad Broker API changes, ever again

Subscribe to the Nomad Broker API changelog to be up to date on recent changes.

RSS
Nomad /

Changelog

Last update:
Compare
1.7.0
14 structure changes including:
8 Breaking changes
6 Additions
8 Removals
Removed 8 Breaking
DELETE /profit/receiver/{merchant}
GET /payms/{merchant}
GET /profit/sharing/{merchant}
POST /payms/callback/{merchant}
POST /payms/{merchant}
POST /profit/receiver/{merchant}
POST /profit/sharing/{merchant}
PUT /profit/sharing/{merchant}
Added 6
DELETE /settlement/receiver/{merchant}
GET /settlement/receiver/{merchant}
GET /settlement/{merchant}
POST /settlement/receiver/{merchant}
POST /settlement/{merchant}
PUT /settlement/{merchant}
1.6.9
1 structure change including:
1 Modification
Modified 1
GET /refund/{merchant}
  • Query
  • order_ref query parameter Added
1.6.8
2 structure changes including:
2 Modifications
Modified 2
GET /payment/{merchant}
  • Response
  • 200 response Modified
    • tradeMessage attribute Added
POST /payment/{merchant}
  • Body
  • content type Modified
    • spAppId attribute Added
1.6.6
1 structure change including:
1 Modification
Modified 1
POST /payment/{merchant}
  • Header
  • X-Real-Ip, Client-Id headers Added
1.6.5
2 structure changes including:
2 Modifications
Modified 2
POST /payment/invocation/{merchant}
  • Response
  • 200 response Modified
    • timeStamp, nonceStr attributes Added
POST /payment/{merchant}
  • Response
  • 200 response Modified
    • timeStamp, nonceStr attributes Added
1.6.4
3 structure changes including:
3 Modifications
Modified 3 Breaking
GET /profit/sharing/{merchant}
  • Query
  • out_order_no query parameter Removed
  • profit_order_no query parameter Added
POST /profit/sharing/{merchant}
  • Body
  • content type Modified
    • outOrderNo attribute Removed
    • orderRef attribute Added
PUT /profit/sharing/{merchant}
  • Body
  • content type Modified
    • outOrderNo attribute Removed
    • orderRef attribute Added
1.6.3
2 structure changes including:
2 Modifications
Modified 2 Breaking
GET /refund/{merchant}
  • Response
  • 200 response Modified
    • payerRefundAmount attribute Removed
    • totalAmount, payerRefund, payerTotal, settlementAmount, settlementTotal attributes Added
POST /refund/{merchant}
  • Body
  • content type Modified
    • currency attribute Modified
    • refundTotal attribute Removed
    • totalAmount attribute Added
  • Response
  • 200 response Modified
    • payerRefundAmount attribute Removed
    • totalAmount, payerRefund, payerTotal, settlementAmount, settlementTotal attributes Added
1.6.2
2 structure changes including:
2 Modifications
Modified 2 Breaking
POST /payment/invocation/{merchant}
  • Body
  • content type Modified
    • prePayMessage attribute Removed
    • payMessage attribute Added
  • Response
  • 200 response Modified
    • prePayMessage attribute Removed
    • payInvokeMessage attribute Added
POST /payment/{merchant}
  • Response
  • 200 response Modified
    • prePayMessage attribute Removed
    • payInvokeMessage attribute Added
1.6.1
2 structure changes including:
2 Modifications
Modified 2 Breaking
GET /payment/{merchant}
  • Response
  • 200 response Modified
    • actualAmount attribute Added
POST /payment/{merchant}
  • Body
  • content type Modified
    • total attribute Modified
    • discountCostPrice, discountInvoiceId attributes Removed
    • actualAmount, costPrice, invoiceId, successUrl, cancelUrl attributes Added
1.6.0
7 structure changes including:
1 Addition
6 Modifications
Modified 6 Breaking
GET /customs/payment/{merchant}
  • Response
  • 200 response Modified
    • attribute Removed
    • orders attribute Added
  • Query
  • out_trade_no query parameter Removed
  • order_no query parameter Added
POST /customs/identification/{merchant}
  • Body
  • content type Modified
    • outTradeNo attribute Removed
    • orderNo attribute Added
  • Response
  • 200 response Modified
    • outTradeNo attribute Removed
    • orderNo attribute Added
POST /customs/payment/{merchant}
  • Body
  • content type Modified
    • outTradeNo attribute Removed
    • orderNo attribute Added
POST /payment/{merchant}
  • Body
  • content type Modified
    • timeExpire attribute Added
POST /profit/sharing/{merchant}
  • Body
  • content type Modified
    • outOrderNo, transactionId attributes Modified
    • finishDesc attribute Added
PUT /customs/payment/{merchant}
  • Body
  • content type Modified
    • outTradeNo attribute Removed
    • orderNo attribute Added
Added 1
PUT /profit/sharing/{merchant}
1.5.0
8 structure changes including:
2 Additions
6 Modifications
Modified 6
GET /payout/abroad/{merchant}
  • Response
  • 200 response Modified
    • payoutOrderId, foreignCurrency attributes Added
POST /customs/payment/{merchant}
  • Response
  • 200 response Modified
    • orderNo attribute Added
POST /payment/{merchant}
  • Body
  • content type Modified
    • attach, goodsTag attributes Added
POST /payout/abroad/{merchant}
  • Response
  • 200 response Modified
    • payoutOrderId, foreignCurrency attributes Added
POST /payout/bill/abroad/{merchant}
  • Response
  • 200 response Modified
    • payoutOrderId, foreignCurrency attributes Added
PUT /customs/payment/{merchant}
  • Response
  • 200 response Modified
    • orderNo attribute Added
Added 2
POST /customs/identification/{merchant}
POST /payms/callback/{merchant}
12 structure changes including:
1 Addition
11 Modifications
Modified 11 Breaking
DELETE /profit/receiver/{merchant}
  • Response
  • 400 response Modified
    • type, account attributes Removed
  • 401 response Modified
    • type, account attributes Removed
  • 500 response Modified
    • type, account attributes Removed
    • errors attribute Added
GET /customs/payment/{merchant}
  • Response
  • 400 response Modified
    • customsMessage, resultCode, state, transactionId, subOrderNo, modifyTime, certCheckResult, verifyDepartment, verifyDepartmentTradeId attributes Removed
  • 401 response Modified
    • customsMessage, resultCode, state, transactionId, subOrderNo, modifyTime, certCheckResult, verifyDepartment, verifyDepartmentTradeId attributes Removed
  • 500 response Modified
    • customsMessage, resultCode, state, transactionId, subOrderNo, modifyTime, certCheckResult, verifyDepartment, verifyDepartmentTradeId attributes Removed
    • errors attribute Added
GET /payms/{merchant}
  • Response
  • 200 response Modified
    • prePayUrl, payUrl, payPage attributes Removed
    • data attribute Added
GET /payout/abroad/{merchant}
  • Response
  • 400 response Modified
    • outOrderId, transactionId, result, failReason, amount, foreignAmount, rate, exchangeRateTime, estimateExchangeRateTime, availableAbroadAmount attributes Removed
  • 401 response Modified
    • outOrderId, transactionId, result, failReason, amount, foreignAmount, rate, exchangeRateTime, estimateExchangeRateTime, availableAbroadAmount attributes Removed
  • 500 response Modified
    • outOrderId, transactionId, result, failReason, amount, foreignAmount, rate, exchangeRateTime, estimateExchangeRateTime, availableAbroadAmount attributes Removed
    • errors attribute Added
GET /payout/bill/abroad/{merchant}
  • Response
  • 500 response Modified
    • errors attribute Added
GET /profit/sharing/{merchant}
  • Response
  • 400 response Modified
    • outOrderNo, transactionId, orderId, status, receivers, finishDescription, finishAmount attributes Removed
  • 401 response Modified
    • outOrderNo, transactionId, orderId, status, receivers, finishDescription, finishAmount attributes Removed
  • 500 response Modified
    • outOrderNo, transactionId, orderId, status, receivers, finishDescription, finishAmount attributes Removed
    • errors attribute Added
POST /customs/payment/{merchant}
  • Response
  • 400 response Modified
    • customsMessage, resultCode, state, transactionId, subOrderNo, modifyTime, certCheckResult, verifyDepartment, verifyDepartmentTradeId attributes Removed
  • 401 response Modified
    • customsMessage, resultCode, state, transactionId, subOrderNo, modifyTime, certCheckResult, verifyDepartment, verifyDepartmentTradeId attributes Removed
  • 500 response Modified
    • customsMessage, resultCode, state, transactionId, subOrderNo, modifyTime, certCheckResult, verifyDepartment, verifyDepartmentTradeId attributes Removed
    • errors attribute Added
POST /payout/abroad/{merchant}
  • Response
  • 400 response Modified
    • outOrderId, transactionId, result, failReason, amount, foreignAmount, rate, exchangeRateTime, estimateExchangeRateTime, availableAbroadAmount attributes Removed
  • 401 response Modified
    • outOrderId, transactionId, result, failReason, amount, foreignAmount, rate, exchangeRateTime, estimateExchangeRateTime, availableAbroadAmount attributes Removed
  • 500 response Modified
    • outOrderId, transactionId, result, failReason, amount, foreignAmount, rate, exchangeRateTime, estimateExchangeRateTime, availableAbroadAmount attributes Removed
    • errors attribute Added
POST /profit/receiver/{merchant}
  • Response
  • 400 response Modified
    • type, account attributes Removed
  • 401 response Modified
    • type, account attributes Removed
  • 500 response Modified
    • type, account attributes Removed
    • errors attribute Added
POST /profit/sharing/{merchant}
  • Response
  • 400 response Modified
    • outOrderNo, transactionId, orderId, status, receivers, finishDescription, finishAmount attributes Removed
  • 401 response Modified
    • outOrderNo, transactionId, orderId, status, receivers, finishDescription, finishAmount attributes Removed
  • 500 response Modified
    • outOrderNo, transactionId, orderId, status, receivers, finishDescription, finishAmount attributes Removed
    • errors attribute Added
PUT /customs/payment/{merchant}
  • Response
  • 400 response Modified
    • customsMessage, resultCode, state, transactionId, subOrderNo, modifyTime, certCheckResult, verifyDepartment, verifyDepartmentTradeId attributes Removed
  • 401 response Modified
    • customsMessage, resultCode, state, transactionId, subOrderNo, modifyTime, certCheckResult, verifyDepartment, verifyDepartmentTradeId attributes Removed
  • 500 response Modified
    • customsMessage, resultCode, state, transactionId, subOrderNo, modifyTime, certCheckResult, verifyDepartment, verifyDepartmentTradeId attributes Removed
    • errors attribute Added
Added 1
POST /payms/{merchant}
1.4.11
2 structure changes including:
2 Additions
Added 2
GET /refund/{merchant}
POST /refund/{merchant}
1.4.10
5 structure changes including:
5 Modifications
Modified 5 Breaking
GET /customs/payment/{merchant}
  • Response
  • 200 response Modified
    • customsMessage attribute Added
  • 400 response Modified
    • customsMessage attribute Added
  • 401 response Modified
    • customsMessage attribute Added
  • 500 response Modified
    • customsMessage attribute Added
POST /customs/payment/{merchant}
  • Response
  • 200 response Modified
    • customsMessage attribute Added
  • 400 response Modified
    • customsMessage attribute Added
  • 401 response Modified
    • customsMessage attribute Added
  • 500 response Modified
    • customsMessage attribute Added
POST /payment/invocation/{merchant}
  • Body
  • content type Modified
    • invocationUrl attribute Removed
    • prePayMessage, timeStamp, nonceStr attributes Added
  • Response
  • 200 response Modified
    • prePayUrl, payUrl, payPage attributes Removed
    • prePayMessage, payMessage attributes Added
POST /payment/{merchant}
  • Body
  • content type Modified
    • payerId, merchantPayerId, notifyUrl attributes Added
  • Response
  • 200 response Modified
    • prePayUrl, payUrl, payPage attributes Removed
    • prePayMessage, payMessage attributes Added
PUT /customs/payment/{merchant}
  • Response
  • 200 response Modified
    • customsMessage attribute Added
  • 400 response Modified
    • customsMessage attribute Added
  • 401 response Modified
    • customsMessage attribute Added
  • 500 response Modified
    • customsMessage attribute Added
1.4.9
19 structure changes including:
4 Breaking changes
1 Addition
14 Modifications
4 Removals
Modified 14 Breaking
DELETE /profit/receiver/{merchant}
  • Query
  • payment_method query parameter Added
GET /customs/payment/{merchant}
  • Query
  • payment_method query parameter Added
GET /payment/{merchant}
  • Query
  • payment_method query parameter Added
GET /payout/abroad/{merchant}
  • Query
  • payment_method query parameter Added
GET /payout/bill/abroad/{merchant}
  • Query
  • payment_method query parameter Added
GET /profit/sharing/{merchant}
  • Query
  • payment_method query parameter Added
POST /customs/payment/{merchant}
  • Body
  • content type Modified
    • paymentMethod attribute Added
POST /payment/close/{merchant}/{order_ref}
  • Query
  • payment_method query parameter Added
POST /payment/{merchant}
  • Body
  • content type Modified
    • product attribute Removed
    • products, discountCostPrice, discountInvoiceId attributes Added
POST /payout/abroad/{merchant}
  • Body
  • content type Modified
    • goodsInfo attribute Modified
    • paymentMethod attribute Added
POST /payout/bill/abroad/{merchant}
  • Body
  • content type Modified
    • paymentMethod attribute Added
POST /profit/receiver/{merchant}
  • Body
  • content type Modified
    • paymentMethod attribute Added
POST /profit/sharing/{merchant}
  • Body
  • content type Modified
    • paymentMethod attribute Added
PUT /customs/payment/{merchant}
  • Body
  • content type Modified
    • paymentMethod attribute Added
Removed 4 Breaking
POST /declare-order/youzan
POST /pay
POST /query-order/youzan
POST /declare
Added 1
GET /payms/{merchant}
1.4.8-alpha
4 structure changes including:
2 Additions
2 Modifications
Modified 2 Breaking
GET /payout/abroad/{merchant}
  • Response
  • 200 response Modified
    • orderId attribute Removed
    • transactionId, availableAbroadAmount attributes Added
  • 400 response Modified
    • orderId attribute Removed
    • transactionId, availableAbroadAmount attributes Added
  • 401 response Modified
    • orderId attribute Removed
    • transactionId, availableAbroadAmount attributes Added
  • 500 response Modified
    • orderId attribute Removed
    • transactionId, availableAbroadAmount attributes Added
POST /payout/abroad/{merchant}
  • Response
  • 200 response Modified
    • orderId attribute Removed
    • transactionId, availableAbroadAmount attributes Added
  • 400 response Modified
    • orderId attribute Removed
    • transactionId, availableAbroadAmount attributes Added
  • 401 response Modified
    • orderId attribute Removed
    • transactionId, availableAbroadAmount attributes Added
  • 500 response Modified
    • orderId attribute Removed
    • transactionId, availableAbroadAmount attributes Added
Added 2
GET /payout/bill/abroad/{merchant}
POST /payout/bill/abroad/{merchant}
1.4.7
7 structure changes including:
7 Modifications
Modified 7 Breaking
GET /payment/{merchant}
  • Response
  • 401 response Modified
    • field, msg attributes Removed
    • code, message attributes Added
  • 500 response Modified
    • code, message attributes Added
POST /declare
  • Response
  • 401 response Modified
    • field, msg attributes Removed
    • code, message attributes Added
  • 422 response Modified
    • field, msg attributes Removed
    • code, message attributes Added
  • 500 response Modified
    • code, message attributes Added
POST /declare-order/youzan
  • Response
  • 401 response Modified
    • field, msg attributes Removed
    • code, message attributes Added
  • 422 response Modified
    • field, msg attributes Removed
    • code, message attributes Added
  • 500 response Modified
    • code, message attributes Added
POST /payment/close/{merchant}/{order_ref}
  • Response
  • 401 response Modified
    • field, msg attributes Removed
    • code, message attributes Added
  • 422 response Modified
    • field, msg attributes Removed
    • code, message attributes Added
  • 500 response Modified
    • code, message attributes Added
POST /payment/invocation/{merchant}
  • Response
  • 401 response Modified
    • field, msg attributes Removed
    • code, message attributes Added
  • 422 response Modified
    • field, msg attributes Removed
    • code, message attributes Added
  • 500 response Modified
    • code, message attributes Added
POST /payment/{merchant}
  • Response
  • 401 response Modified
    • field, msg attributes Removed
    • code, message attributes Added
  • 422 response Modified
    • field, msg attributes Removed
    • code, message attributes Added
  • 500 response Modified
    • code, message attributes Added
POST /query-order/youzan
  • Response
  • 401 response Modified
    • field, msg attributes Removed
    • code, message attributes Added
  • 422 response Modified
    • field, msg attributes Removed
    • code, message attributes Added
  • 500 response Modified
    • code, message attributes Added
1.4.6
1 structure change including:
1 Breaking change
1 Modification
Modified 1 Breaking
GET /payment/{merchant}
  • Path
  • order_ref path parameter Removed
  • Query
  • order_ref query parameter Added
1.4.5
5 structure changes including:
4 Additions
1 Modification
Modified 1 Breaking
POST /payment/{merchant}
  • Body
  • content type Modified
    • orderSuccessUrl attribute Removed
    • profitSharing, subsidyAmount attributes Added
Added 4
DELETE /profit/receiver/{merchant}
GET /profit/sharing/{merchant}
POST /profit/receiver/{merchant}
POST /profit/sharing/{merchant}
1.4.2
2 structure changes including:
2 Additions
Added 2
GET /payout/abroad/{merchant}
POST /payout/abroad/{merchant}