Nomad_broker_cli NPM

nomad_broker_cli

NomadBrokerCli - JavaScript client for nomad_broker_cli Nomad payment provider aggregation, including make payments, and customs declaration for orders and etc. This SDK is automatically generated by the OpenAPI Generator project:

API version: 1.6.7
Package version: 1.6.7
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_cli --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_cli 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 NomadBrokerCli = require('nomad_broker_cli');

var defaultClient = NomadBrokerCli.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 NomadBrokerCli.CustomsApi()
var merchant = wechat.prod; // {String} Merchant name to payment company, e.g. wechat.prod
var customs = new NomadBrokerCli.CustomsCode(); // {CustomsCode} Customs code, available options: GUANGZHOU_ZS, HANGZHOU_ZS, NINGBO, ZHENGZHOU_BS, CHONGQING, SHANGHAI_ZS, SHENZHEN, ZHENGZHOU_ZH_ZS
var opts = {
  'orderNo': "orderNo_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 NomadBrokerCli.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
NomadBrokerCli.CustomsApi	getCustomsPayment	GET /customs/payment/{merchant}	GetCustomsPayment
NomadBrokerCli.CustomsApi	postCustomsIdentification	POST /customs/identification/{merchant}	PostCustomsIdentification
NomadBrokerCli.CustomsApi	postCustomsPayment	POST /customs/payment/{merchant}	PostCustomsPayment
NomadBrokerCli.CustomsApi	putCustomsPayment	PUT /customs/payment/{merchant}	PutCustomsPayment
NomadBrokerCli.PaymentApi	closePayment	POST /payment/close/{merchant}/{order_ref}	ClosePayment
NomadBrokerCli.PaymentApi	createPayment	POST /payment/{merchant}	CreatePayment
NomadBrokerCli.PaymentApi	invokePayment	POST /payment/invocation/{merchant}	InvokePayment
NomadBrokerCli.PaymentApi	queryPayment	GET /payment/{merchant}	QueryPayment
NomadBrokerCli.PaymsApi	postNomadPayment	POST /payms/{merchant}	PostNomadPayment
NomadBrokerCli.PaymsApi	postNomadPaymentCallback	POST /payms/callback/{merchant}	PostNomadPaymentCallback
NomadBrokerCli.PaymsApi	queryNomadPayment	GET /payms/{merchant}	QueryNomadPayment
NomadBrokerCli.PayoutApi	getAbroadPayout	GET /payout/abroad/{merchant}	GetAbroadPayout
NomadBrokerCli.PayoutApi	getAbroadPayoutBill	GET /payout/bill/abroad/{merchant}	GetAbroadPayoutBill
NomadBrokerCli.PayoutApi	postAbroadPayout	POST /payout/abroad/{merchant}	PostAbroadPayout
NomadBrokerCli.PayoutApi	postAbroadPayoutBill	POST /payout/bill/abroad/{merchant}	PostAbroadPayoutBill
NomadBrokerCli.ProfitApi	deleteProfitReceiver	DELETE /profit/receiver/{merchant}	DeleteProfitReceiver
NomadBrokerCli.ProfitApi	finishProfitSharing	PUT /profit/sharing/{merchant}	FinishProfitSharing
NomadBrokerCli.ProfitApi	getProfitSharing	GET /profit/sharing/{merchant}	GetProfitSharing
NomadBrokerCli.ProfitApi	postProfitReceiver	POST /profit/receiver/{merchant}	PostProfitReceiver
NomadBrokerCli.ProfitApi	postProfitSharing	POST /profit/sharing/{merchant}	PostProfitSharing
NomadBrokerCli.RefundApi	createRefund	POST /refund/{merchant}	CreateRefund
NomadBrokerCli.RefundApi	queryRefund	GET /refund/{merchant}	QueryRefund