@isabbah/checkout-node-sdk-v5
v5.4.0
Published
API_specification_to_use_the_Orbipay_Checkout_APIs__This_documentation_covers_the_Charge_Management_related_APIs__
Downloads
7
Readme
orbipay_checkout_ap_is
OrbipayCheckoutApIs - JavaScript client for orbipay_checkout_ap_is API specification to use the Orbipay-Checkout APIs. This documentation covers the Merchant Account Management and Charge Management related APIs. This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Package version: 1.0.0
- Build date: 2017-09-05T12:27:44.174+05:30
- Build package: class io.swagger.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 orbipay_checkout_ap_is --save
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.
Getting Started
Please follow the installation instruction and execute the following JS code:
var OrbipayCheckoutApIs = require('orbipay_checkout_ap_is');
var api = new OrbipayCheckoutApIs.ChargeApi()
var partnerId = "partnerId_example"; // {String} Unique client Identifier, for example cli_example5852kw555
var confirmChargeRequest = new OrbipayCheckoutApIs.ConfirmChargeRequest(); // {ConfirmChargeRequest} This JSON contains all the attributes to Confirm Charge.
var opts = {
'tokenId': "tokenId_example", // {String} One time usage token issued by Checkout as part of Validate-Charge to confirm the charge or confirm add funding account, for example ctk_av5q525f52m455mf
'digiSign': "digiSign_example" // {String} Generated Digital Signature for data using private key, for example dyYku51gDp+ieXSQa+oL+0LPNiFDVur6A8z2s/O6r7yI9se4odzQD1Y8pb4jwHFnbwVYKfFQ/tDgFppuphtzQ9QKkL7fOyYwvG9dcWFUT6PUJBpbIecUmxkxaLRvdulcDSnFbHaHDALQUdaelCHsUZxNl06oJhsTLd+2Aa5fMIeYKvguF4O8whB9BqjK9VFSYTmnQgAAUMV+TNv21BTpIkcORNS08h/G9UPR4EYvwOc9xKohC3bkOaZc3qTcvrlCUtg6inhuafafrc7wXDGieXGccY5+dR/FObqcBZEYX9xFDfsHTy485Y4bbgQNUmRWcMxepw/6TthLPlybrYZPCw==
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.confirmCharge(partnerId, confirmChargeRequest, opts, callback);
Documentation for API Endpoints
All URIs are relative to https://www.orbipay.com/app/opco/v1
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- OrbipayCheckoutApIs.ChargeApi | confirmCharge | POST /service/payments/confirm-charge | Confirm Charge OrbipayCheckoutApIs.ChargeApi | validateCharge | POST /public/service/payments/validate-charge/{PARTNER_ID} | Validate Charge OrbipayCheckoutApIs.MerchantAccountApi | retrieveMerchantAccount | GET /public/service/accounts/{PARTNER_ID} | Retrieve Merchant Account
Documentation for Models
- OrbipayCheckoutApIs.AddressInfo
- OrbipayCheckoutApIs.Charge
- OrbipayCheckoutApIs.ConfirmChargeRequest
- OrbipayCheckoutApIs.CustomerAccountInfo
- OrbipayCheckoutApIs.CustomerInfo
- OrbipayCheckoutApIs.Error
- OrbipayCheckoutApIs.ErrorsResponse
- OrbipayCheckoutApIs.FundingAccountInfo
- OrbipayCheckoutApIs.FundingAccountMinimalInfo
- OrbipayCheckoutApIs.MerchantAccount
- OrbipayCheckoutApIs.ValidateChargeRequest
- OrbipayCheckoutApIs.ValidateChargeTokenResponse
Documentation for Authorization
All endpoints do not require authorization.