Nomad Broker API documentation

1.7.0 Jul 5, 2022

Compare

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

1.6.9 Jun 21, 2022

Compare

Modified: GET /refund/{merchant}
- order_ref query parameter was added

1.6.8 May 28, 2022

Compare

Modified: GET /payment/{merchant}
- 200 response was modified
  - tradeMessage attribute was added
Modified: POST /payment/{merchant}
- body was modified
  - spAppId attribute was added

1.6.6 Apr 7, 2022

Compare

Modified: POST /payment/{merchant}
- X-Real-Ip, Client-Id headers were added

1.6.5 Mar 17, 2022

Compare

Modified: POST /payment/invocation/{merchant}
- 200 response was modified
  - timeStamp, nonceStr attributes were added
Modified: POST /payment/{merchant}
- 200 response was modified
  - timeStamp, nonceStr attributes were added

1.6.4 Mar 9, 2022

Compare

Modified: GET /profit/sharing/{merchant}
- profit_order_no query parameter was added
- out_order_no query parameter was removed
  Breaking
Modified: POST /profit/sharing/{merchant}
- body was modified
  - orderRef attribute was added
  - outOrderNo attribute was removed
    Breaking
Modified: PUT /profit/sharing/{merchant}
- body was modified
  - orderRef attribute was added
  - outOrderNo attribute was removed
    Breaking

1.6.3 Mar 5, 2022

Compare

Modified: GET /refund/{merchant}
- 200 response was modified
  - totalAmount, payerRefund, payerTotal, settlementAmount, settlementTotal attributes were added
  - payerRefundAmount attribute was removed
    Breaking
Modified: POST /refund/{merchant}
- body was modified
  - totalAmount attribute was added
  - refundTotal attribute was removed
    Breaking
  - currency attribute was modified
- 200 response was modified
  - totalAmount, payerRefund, payerTotal, settlementAmount, settlementTotal attributes were added
  - payerRefundAmount attribute was removed
    Breaking

1.6.2 Mar 4, 2022

Compare

Modified: POST /payment/invocation/{merchant}
- body was modified
  - payMessage attribute was added
  - prePayMessage attribute was removed
    Breaking
- 200 response was modified
  - payInvokeMessage attribute was added
  - prePayMessage attribute was removed
    Breaking
Modified: POST /payment/{merchant}
- 200 response was modified
  - payInvokeMessage attribute was added
  - prePayMessage attribute was removed
    Breaking

1.6.1 Mar 1, 2022

Compare

Modified: GET /payment/{merchant}
- 200 response was modified
  - actualAmount attribute was added
Modified: POST /payment/{merchant}
- body was modified
  - actualAmount, costPrice, invoiceId, successUrl, cancelUrl attributes were added
  - discountCostPrice, discountInvoiceId attributes were removed
    Breaking
  - total attribute was modified

1.6.0 Feb 28, 2022

Compare

Added: PUT /profit/sharing/{merchant}
Modified: GET /customs/payment/{merchant}
- order_no query parameter was added
- out_trade_no query parameter was removed
  Breaking
- 200 response was modified
  - orders attribute was added
  - attribute was removed
    Breaking
Modified: POST /customs/identification/{merchant}
- body was modified
  - orderNo attribute was added
  - outTradeNo attribute was removed
    Breaking
- 200 response was modified
  - orderNo attribute was added
  - outTradeNo attribute was removed
    Breaking
Modified: POST /customs/payment/{merchant}
- body was modified
  - orderNo attribute was added
  - outTradeNo attribute was removed
    Breaking
Modified: POST /payment/{merchant}
- body was modified
  - timeExpire attribute was added
Modified: POST /profit/sharing/{merchant}
- body was modified
  - finishDesc attribute was added
  - outOrderNo, transactionId attributes were modified
    Breaking
Modified: PUT /customs/payment/{merchant}
- body was modified
  - orderNo attribute was added
  - outTradeNo attribute was removed
    Breaking

1.5.0 Feb 21, 2022

Compare

Added: POST /customs/identification/{merchant}
Added: POST /payms/callback/{merchant}
Modified: GET /payout/abroad/{merchant}
- 200 response was modified
  - payoutOrderId, foreignCurrency attributes were added
Modified: POST /customs/payment/{merchant}
- 200 response was modified
  - orderNo attribute was added
Modified: POST /payment/{merchant}
- body was modified
  - attach, goodsTag attributes were added
Modified: POST /payout/abroad/{merchant}
- 200 response was modified
  - payoutOrderId, foreignCurrency attributes were added
Modified: POST /payout/bill/abroad/{merchant}
- 200 response was modified
  - payoutOrderId, foreignCurrency attributes were added
Modified: PUT /customs/payment/{merchant}
- 200 response was modified
  - orderNo attribute was added

1.4.11 Feb 8, 2022

Compare

Added: POST /payms/{merchant}
Modified: DELETE /profit/receiver/{merchant}
- 400 response was modified
  - type, account attributes were removed
    Breaking
- 401 response was modified
  - type, account attributes were removed
    Breaking
- 500 response was modified
  - errors attribute was added
  - type, account attributes were removed
    Breaking
Modified: GET /customs/payment/{merchant}
- 400 response was modified
  - customsMessage, resultCode, state, transactionId, subOrderNo, modifyTime, certCheckResult, verifyDepartment, verifyDepartmentTradeId attributes were removed
    Breaking
- 401 response was modified
  - customsMessage, resultCode, state, transactionId, subOrderNo, modifyTime, certCheckResult, verifyDepartment, verifyDepartmentTradeId attributes were removed
    Breaking
- 500 response was modified
  - errors attribute was added
  - customsMessage, resultCode, state, transactionId, subOrderNo, modifyTime, certCheckResult, verifyDepartment, verifyDepartmentTradeId attributes were removed
    Breaking
Modified: GET /payms/{merchant}
- 200 response was modified
  - data attribute was added
  - prePayUrl, payUrl, payPage attributes were removed
    Breaking
Modified: GET /payout/abroad/{merchant}
- 400 response was modified
  - outOrderId, transactionId, result, failReason, amount, foreignAmount, rate, exchangeRateTime, estimateExchangeRateTime, availableAbroadAmount attributes were removed
    Breaking
- 401 response was modified
  - outOrderId, transactionId, result, failReason, amount, foreignAmount, rate, exchangeRateTime, estimateExchangeRateTime, availableAbroadAmount attributes were removed
    Breaking
- 500 response was modified
  - errors attribute was added
  - outOrderId, transactionId, result, failReason, amount, foreignAmount, rate, exchangeRateTime, estimateExchangeRateTime, availableAbroadAmount attributes were removed
    Breaking
Modified: GET /payout/bill/abroad/{merchant}
- 500 response was modified
  - errors attribute was added
Modified: GET /profit/sharing/{merchant}
- 400 response was modified
  - outOrderNo, transactionId, orderId, status, receivers, finishDescription, finishAmount attributes were removed
    Breaking
- 401 response was modified
  - outOrderNo, transactionId, orderId, status, receivers, finishDescription, finishAmount attributes were removed
    Breaking
- 500 response was modified
  - errors attribute was added
  - outOrderNo, transactionId, orderId, status, receivers, finishDescription, finishAmount attributes were removed
    Breaking
Modified: POST /customs/payment/{merchant}
- 400 response was modified
  - customsMessage, resultCode, state, transactionId, subOrderNo, modifyTime, certCheckResult, verifyDepartment, verifyDepartmentTradeId attributes were removed
    Breaking
- 401 response was modified
  - customsMessage, resultCode, state, transactionId, subOrderNo, modifyTime, certCheckResult, verifyDepartment, verifyDepartmentTradeId attributes were removed
    Breaking
- 500 response was modified
  - errors attribute was added
  - customsMessage, resultCode, state, transactionId, subOrderNo, modifyTime, certCheckResult, verifyDepartment, verifyDepartmentTradeId attributes were removed
    Breaking
Modified: POST /payout/abroad/{merchant}
- 400 response was modified
  - outOrderId, transactionId, result, failReason, amount, foreignAmount, rate, exchangeRateTime, estimateExchangeRateTime, availableAbroadAmount attributes were removed
    Breaking
- 401 response was modified
  - outOrderId, transactionId, result, failReason, amount, foreignAmount, rate, exchangeRateTime, estimateExchangeRateTime, availableAbroadAmount attributes were removed
    Breaking
- 500 response was modified
  - errors attribute was added
  - outOrderId, transactionId, result, failReason, amount, foreignAmount, rate, exchangeRateTime, estimateExchangeRateTime, availableAbroadAmount attributes were removed
    Breaking
Modified: POST /profit/receiver/{merchant}
- 400 response was modified
  - type, account attributes were removed
    Breaking
- 401 response was modified
  - type, account attributes were removed
    Breaking
- 500 response was modified
  - errors attribute was added
  - type, account attributes were removed
    Breaking
Modified: POST /profit/sharing/{merchant}
- 400 response was modified
  - outOrderNo, transactionId, orderId, status, receivers, finishDescription, finishAmount attributes were removed
    Breaking
- 401 response was modified
  - outOrderNo, transactionId, orderId, status, receivers, finishDescription, finishAmount attributes were removed
    Breaking
- 500 response was modified
  - errors attribute was added
  - outOrderNo, transactionId, orderId, status, receivers, finishDescription, finishAmount attributes were removed
    Breaking
Modified: PUT /customs/payment/{merchant}
- 400 response was modified
  - customsMessage, resultCode, state, transactionId, subOrderNo, modifyTime, certCheckResult, verifyDepartment, verifyDepartmentTradeId attributes were removed
    Breaking
- 401 response was modified
  - customsMessage, resultCode, state, transactionId, subOrderNo, modifyTime, certCheckResult, verifyDepartment, verifyDepartmentTradeId attributes were removed
    Breaking
- 500 response was modified
  - errors attribute was added
  - customsMessage, resultCode, state, transactionId, subOrderNo, modifyTime, certCheckResult, verifyDepartment, verifyDepartmentTradeId attributes were removed
    Breaking

1.4.11 Jan 25, 2022

Compare

Added: GET /refund/{merchant}
Added: POST /refund/{merchant}

1.4.10 Jan 20, 2022

Compare

Modified: GET /customs/payment/{merchant}
- 200 response was modified
  - customsMessage attribute was added
- 400 response was modified
  - customsMessage attribute was added
- 401 response was modified
  - customsMessage attribute was added
- 500 response was modified
  - customsMessage attribute was added
Modified: POST /customs/payment/{merchant}
- 200 response was modified
  - customsMessage attribute was added
- 400 response was modified
  - customsMessage attribute was added
- 401 response was modified
  - customsMessage attribute was added
- 500 response was modified
  - customsMessage attribute was added
Modified: POST /payment/invocation/{merchant}
- body was modified
  - prePayMessage, timeStamp, nonceStr attributes were added
  - invocationUrl attribute was removed
    Breaking
- 200 response was modified
  - prePayMessage, payMessage attributes were added
  - prePayUrl, payUrl, payPage attributes were removed
    Breaking
Modified: POST /payment/{merchant}
- body was modified
  - payerId, merchantPayerId, notifyUrl attributes were added
- 200 response was modified
  - prePayMessage, payMessage attributes were added
  - prePayUrl, payUrl, payPage attributes were removed
    Breaking
Modified: PUT /customs/payment/{merchant}
- 200 response was modified
  - customsMessage attribute was added
- 400 response was modified
  - customsMessage attribute was added
- 401 response was modified
  - customsMessage attribute was added
- 500 response was modified
  - customsMessage attribute was added

1.4.9 Jan 18, 2022

Compare

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 attribute was added
Modified: POST /payment/close/{merchant}/{order_ref}
- payment_method query parameter was added
Modified: POST /payment/{merchant}
- body was modified
  - products, discountCostPrice, discountInvoiceId attributes were added
  - product attribute was removed
    Breaking
Modified: POST /payout/abroad/{merchant}
- body was modified
  - paymentMethod attribute was added
  - goodsInfo attribute was modified
Modified: POST /payout/bill/abroad/{merchant}
- body was modified
  - paymentMethod attribute was added
Modified: POST /profit/receiver/{merchant}
- body was modified
  - paymentMethod attribute was added
Modified: POST /profit/sharing/{merchant}
- body was modified
  - paymentMethod attribute was added
Modified: PUT /customs/payment/{merchant}
- body was modified
  - paymentMethod attribute was added
Removed: POST /declare
Breaking
Removed: POST /declare-order/youzan
Breaking
Removed: POST /pay
Breaking
Removed: POST /query-order/youzan
Breaking

1.4.8-alpha Jan 13, 2022

Compare

Added: GET /payout/bill/abroad/{merchant}
Added: POST /payout/bill/abroad/{merchant}
Modified: GET /payout/abroad/{merchant}
- 200 response was modified
  - transactionId, availableAbroadAmount attributes were added
  - orderId attribute was removed
    Breaking
- 400 response was modified
  - transactionId, availableAbroadAmount attributes were added
  - orderId attribute was removed
    Breaking
- 401 response was modified
  - transactionId, availableAbroadAmount attributes were added
  - orderId attribute was removed
    Breaking
- 500 response was modified
  - transactionId, availableAbroadAmount attributes were added
  - orderId attribute was removed
    Breaking
Modified: POST /payout/abroad/{merchant}
- 200 response was modified
  - transactionId, availableAbroadAmount attributes were added
  - orderId attribute was removed
    Breaking
- 400 response was modified
  - transactionId, availableAbroadAmount attributes were added
  - orderId attribute was removed
    Breaking
- 401 response was modified
  - transactionId, availableAbroadAmount attributes were added
  - orderId attribute was removed
    Breaking
- 500 response was modified
  - transactionId, availableAbroadAmount attributes were added
  - orderId attribute was removed
    Breaking

1.4.7 Jan 5, 2022

Compare

Modified: GET /payment/{merchant}
- 401 response was modified
  - code, message attributes were added
  - field, msg attributes were removed
    Breaking
- 500 response was modified
  - code, message attributes were added
Modified: POST /declare
- 401 response was modified
  - code, message attributes were added
  - field, msg attributes were removed
    Breaking
- 422 response was modified
  - code, message attributes were added
  - field, msg attributes were removed
    Breaking
- 500 response was modified
  - code, message attributes were added
Modified: POST /declare-order/youzan
- 401 response was modified
  - code, message attributes were added
  - field, msg attributes were removed
    Breaking
- 422 response was modified
  - code, message attributes were added
  - field, msg attributes were removed
    Breaking
- 500 response was modified
  - code, message attributes were added
Modified: POST /payment/close/{merchant}/{order_ref}
- 401 response was modified
  - code, message attributes were added
  - field, msg attributes were removed
    Breaking
- 422 response was modified
  - code, message attributes were added
  - field, msg attributes were removed
    Breaking
- 500 response was modified
  - code, message attributes were added
Modified: POST /payment/invocation/{merchant}
- 401 response was modified
  - code, message attributes were added
  - field, msg attributes were removed
    Breaking
- 422 response was modified
  - code, message attributes were added
  - field, msg attributes were removed
    Breaking
- 500 response was modified
  - code, message attributes were added
Modified: POST /payment/{merchant}
- 401 response was modified
  - code, message attributes were added
  - field, msg attributes were removed
    Breaking
- 422 response was modified
  - code, message attributes were added
  - field, msg attributes were removed
    Breaking
- 500 response was modified
  - code, message attributes were added
Modified: POST /query-order/youzan
- 401 response was modified
  - code, message attributes were added
  - field, msg attributes were removed
    Breaking
- 422 response was modified
  - code, message attributes were added
  - field, msg attributes were removed
    Breaking
- 500 response was modified
  - code, message attributes were added

1.4.6 Dec 31, 2021

Compare

Modified: GET /payment/{merchant}
Breaking
- order_ref query parameter was added
  Breaking
- order_ref path parameter was removed
  Breaking

1.4.5 Dec 30, 2021

Compare

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 attributes were added
  - orderSuccessUrl attribute was removed
    Breaking

1.4.2 Dec 27, 2021

Compare

Added: GET /payout/abroad/{merchant}
Added: POST /payout/abroad/{merchant}

Changelog

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

Do not miss any Nomad Broker API changes, ever again

Changelog

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

Do not miss any Nomad Broker API changes,
ever again