Merchant SDK
Merchant SDK is simple API client
Installation
You can use this package over CDN
For that you need to add this script iside your head tag on yout HTML template.
<script src="https://unpkg.com/@paycore/merchant-sdk-js@0.1.1/dist/MerchantSDK.umd.min.js"></script>
<script type= text/javascript>
const PaycoreClient = new MerchantSDK(
{
apiKey: "*****" // Your public API key
});
</script>
Or via npm\yarn
yarn add @paycore/merchant-sdk-js
const MerchantSDK = require('@paycore/merchant-sdk-js');
const client = new MerchantSDK({
apiKey: '*****', // Your public API key
});
client
.makePaymentPrerequest('USD')
.then(res => console.log(res))
.catch(e => {
console.error('Error', e);
});
List of methods
SDK
Initialize the SDK instance
Parameters
-
options
Object Required -
options.apiKey
String Commerce account API_KEY -
options.BASE_URL
String Base endpoint to commerce backend (default = 'https://com-dev.paycore.io/public-api') -
options.currency
String The currency of the SDK client (optional) (3-letter ISO 4217 code). Must be a supported currency.
Returns Object Returns SDK object instance
makePaymentPrerequest
Payment prerequest
Parameters
-
currency
String The currency of the amount (3-letter ISO 4217 code). Must be a supported currency. -
includes
Array The optional relations for entity (PaymentService, PaymentMethod). (optional, default[]
) - Number Not required amount, can be null or float.
Returns Promise
makePayoutPrerequest
Payout prerequest .
Parameters
-
currency
String The currency of the amount (3-letter ISO 4217 code). Must be a supported currency. -
amount
The amount of payout. -
includes
Array The optional relations for entity (PayoutService, PayoutMethod) (optional, default[]
)
Returns Promise
createPaymentInvoice
Payment invoice creation
Parameters
-
options
Object PaymentInvoice config -
options.reference_id
String The amount of payout. -
options.description
String The description of payment invoice -
options.currency
String The currency of the amount (3-letter ISO 4217 code). Must be a supported currency. -
options.amount
Number The amount of payout. -
options.service
String Service id -
options.fields
Object The amount of payout. -
options.metadata
Object The amount of payout.
Returns Promise
getPayoutInvoiceStatus
Payout invoice status
Parameters
-
id
String
getPaymentInvoiceStatus
Payment invoice status
Parameters
-
id
String
Returns Promise