nomad_broker

NomadBroker - JavaScript client for nomad_broker Make payments, and customs declaration for orders. This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.4.11
• Package version: 1.4.11
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install nomad_broker --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your nomad_broker from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var NomadBroker = require('nomad_broker');

var defaultClient = NomadBroker.ApiClient.instance;
// Configure API key authorization: authorization
var authorization = defaultClient.authentications['authorization'];
authorization.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authorization.apiKeyPrefix['app-api-key'] = "Token"

var api = new NomadBroker.CustomsApi()
var merchant = wechat.prod; // {String} Merchant name to payment company, e.g. wechat.prod
var customs = new NomadBroker.CustomsCode(); // {CustomsCode} Customs code, available options: GUANGZHOU_ZS, HANGZHOU_ZS, NINGBO, ZHENGZHOU_BS, CHONGQING, SHANGHAI_ZS, SHENZHEN, ZHENGZHOU_ZH_ZS
var opts = {
  'outTradeNo': "outTradeNo_example", // {String} The internal order number of the merchant system
  'transactionId': "transactionId_example", // {String} Payment system internal order number
  'subOrderNo': "subOrderNo_example", // {String} The internal sub-order number of the merchant system
  'subOrderId': "subOrderId_example", // {String} The internal sub-order number of the payment company system
  'paymentMethod': new NomadBroker.PaymentMethod() // {PaymentMethod} Must be `wechatpay` or `alipay`
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCustomsPayment(merchant, customs, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://nomad.samarkand-global.cn/broker/v1

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- NomadBroker.CustomsApi | getCustomsPayment | GET /customs/payment/{merchant} | GetCustomsPayment NomadBroker.CustomsApi | postCustomsPayment | POST /customs/payment/{merchant} | PostCustomsPayment NomadBroker.CustomsApi | putCustomsPayment | PUT /customs/payment/{merchant} | PutCustomsPayment NomadBroker.PaymentApi | closePayment | POST /payment/close/{merchant}/{order_ref} | ClosePayment NomadBroker.PaymentApi | createPayment | POST /payment/{merchant} | CreatePayment NomadBroker.PaymentApi | invokePayment | POST /payment/invocation/{merchant} | InvokePayment NomadBroker.PaymentApi | queryPayment | GET /payment/{merchant} | QueryPayment NomadBroker.PaymsApi | queryNomadPayment | GET /payms/{merchant} | QueryNomadPayment NomadBroker.PayoutApi | getAbroadPayout | GET /payout/abroad/{merchant} | GetAbroadPayout NomadBroker.PayoutApi | getAbroadPayoutBill | GET /payout/bill/abroad/{merchant} | GetAbroadPayoutBill NomadBroker.PayoutApi | postAbroadPayout | POST /payout/abroad/{merchant} | PostAbroadPayout NomadBroker.PayoutApi | postAbroadPayoutBill | POST /payout/bill/abroad/{merchant} | PostAbroadPayoutBill NomadBroker.ProfitApi | deleteProfitReceiver | DELETE /profit/receiver/{merchant} | DeleteProfitReceiver NomadBroker.ProfitApi | getProfitSharing | GET /profit/sharing/{merchant} | GetProfitSharing NomadBroker.ProfitApi | postProfitReceiver | POST /profit/receiver/{merchant} | PostProfitReceiver NomadBroker.ProfitApi | postProfitSharing | POST /profit/sharing/{merchant} | PostProfitSharing NomadBroker.RefundApi | createRefund | POST /refund/{merchant} | CreateRefund NomadBroker.RefundApi | queryRefund | GET /refund/{merchant} | QueryRefund

Documentation for Models

• NomadBroker.BaseApiResponse
• NomadBroker.CustomsCode
• NomadBroker.CustomsPaymentOrder
• NomadBroker.CustomsPaymentRedeclareRequest
• NomadBroker.CustomsPaymentRequest
• NomadBroker.CustomsPaymentResponse
• NomadBroker.CustomsPaymentsResponse
• NomadBroker.ErrorApiResponse
• NomadBroker.GoodsInfo
• NomadBroker.NomadPaymentResponse
• NomadBroker.PaymentCloseResponse
• NomadBroker.PaymentDetailResponse
• NomadBroker.PaymentInvocationRequest
• NomadBroker.PaymentMethod
• NomadBroker.PaymentProduct
• NomadBroker.PaymentProductReq
• NomadBroker.PaymentRequest
• NomadBroker.PaymentResponse
• NomadBroker.PaymentType
• NomadBroker.PayoutBillRequest
• NomadBroker.PayoutRequest
• NomadBroker.PayoutRequestExpressInfo
• NomadBroker.PayoutRequestPayeeInfo
• NomadBroker.PayoutRequestSellerInfo
• NomadBroker.PayoutResponse
• NomadBroker.ProfitReceiverRequest
• NomadBroker.ProfitReceiverResponse
• NomadBroker.ProfitSharingReceiver
• NomadBroker.ProfitSharingReceiverBase
• NomadBroker.ProfitSharingReceiverReq
• NomadBroker.ProfitSharingRequest
• NomadBroker.ProfitSharingResponse
• NomadBroker.RefundAccount
• NomadBroker.RefundRequest
• NomadBroker.RefundResponse

Documentation for Authorization

authorization

• Type: API key
• API key parameter name: app-api-key
• Location: URL query string