@plasma-platform/tm-service-balances

SDK for service balances

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@plasma-platform/tm-service-balances
Minified + gzip package size for @plasma-platform/tm-service-balances in KB

Readme

Documentation

Table of Contents

BalancesService

Balances Micro Service API

Parameters

  • url string service url
  • token (string | null) user access tocken if available (optional, default null)

createNewDocument

Creates new document based on your user_id ("transactions" scope is needed)

Examples

(async () => {
  const balancesService = new BalancesService('https://jsonplaceholder.typicode.com/', 'dsugsahfdkljhafljkdfhajkldshfad');
  const balances = await balancesService.createNewDocument();
})();

Returns object response

getLinkAmazonS3Uploader

Return link to upload your file ("transactions" scope is needed)

Examples

(async () => {
  const balancesService = new BalancesService('https://jsonplaceholder.typicode.com/', 'dsugsahfdkljhafljkdfhajkldshfad');
  const balances = await balancesService.getLinkAmazonS3Uploader();
})();

Returns object response

requestTaxpayerDocument

Returns taxpayer own document by his access_token ("transactions" scope is required)

Examples

(async () => {
  const balancesService = new BalancesService('https://jsonplaceholder.typicode.com/', 'dsugsahfdkljhafljkdfhajkldshfad');
  const balances = await balancesService.requestTaxpayerDocument();
})();

Returns object response

createTaxpayerDocument

Create taxpayer info or update existent one

Parameters

  • args object object with arguments
    • args.type number taxpayer info type (required)
    • args.countryId string Char code of "Country or Country Residence" (required)
    • args.countryId2 string? Char code of "Country citizenship or Country incorporation"
    • args.stateId string? Char code of "State / Province ID"
    • args.city string? City
    • args.zip string? ZIP-code
    • args.address string? Street & apt. or suite no.
    • args.address2 string? Permanent residence address
    • args.personNumberType string? Tax Number for individual (e.g. "Foreign Tax ID Number")
    • args.companyNumberType string? Tax Number for Corporation (e.g. "Employer Identification Number(EIN)")
    • args.taxIdNumber string? Tax ID number (XXX-XX-XXXX)
    • args.taxClassification string? Tax classification
    • args.name string? Name (shown on your income tax return)
    • args.businessName string? Business name
    • args.organizationName string? Name of organization
    • args.disregardedEntity string? Name of disregarded entity
    • args.chapter3Status string? Chapter 3 status
    • args.signature string? Signature
    • args.residenceNumbers string? Residence numbers (optional) (not implemented yet)

Examples

(async () => {
  const balancesService = new BalancesService('https://jsonplaceholder.typicode.com/', 'dsugsahfdkljhafljkdfhajkldshfad');
  const balances = await balancesService.createTaxpayerDocument({});
})();

Returns object response

checkBalanceByUserId

Check balance of the specified user

Parameters

Examples

(async () => {
  const balancesService = new BalancesService('https://jsonplaceholder.typicode.com/', 'dsugsahfdkljhafljkdfhajkldshfad');
  const balances = await balancesService.checkBalanceByUserId();
})();

Returns array array with balances info

requestTaxpayerInfo

Returns taxpayer own information by his access_token

Examples

(async () => {
  const balancesService = new BalancesService('https://jsonplaceholder.typicode.com/', 'dsugsahfdkljhafljkdfhajkldshfad');
  const balances = await balancesService.requestTaxpayerInfo();
})();

Returns array array with balances info

requestTransactionInfo

Returns taxpayer own information by his access_token

Parameters

  • id string Transaction unique ID

Examples

(async () => {
  const balancesService = new BalancesService('https://jsonplaceholder.typicode.com/', 'dsugsahfdkljhafljkdfhajkldshfad');
  const balances = await balancesService.requestTransactionInfo('1');
})();

Returns array array with balances info

requestTransactionList

Request Transactions list of authenticated user by balance type

Parameters

  • args Object? object of params
    • args.balanceType string? Balance type
    • args.types string? filter by transactions types divided by comma (e.g. types: 'sale,refund')
    • args.type string? Balance type filter by transactions type (e.g. type: 'sale')

Examples

(async () => {
  const balancesService = new BalancesService('https://jsonplaceholder.typicode.com/', 'dsugsahfdkljhafljkdfhajkldshfad');
  const balances = await balancesService.requestTransactionInfo('1');
})();

Returns array array with balances info

requestBalances

Request balance of authenticated user by type or default

Parameters

  • balanceType string? type of balance needed (vendor|bonus)

Examples

(async () => {
  const balancesService = new BalancesService('https://jsonplaceholder.typicode.com/', 'dsugsahfdkljhafljkdfhajkldshfad');
  const balances = await balancesService.requestBalances();
})();

Returns array array with balances info

createPaymentMethod

Creates new payment method ("transactions" scope is needed)

Parameters

  • args object object with arguments
    • args.paymentMethod number Payment method (paypal, wire, skrill, payoneer) (required)
    • args.email string? E-mail (required for paypal & skrill)
    • args.fullName string? First & last name (required for wire)
    • args.address string? Address (required for wire)
    • args.country string? Country char code (required for wire)
    • args.swiftCode string? SWIFT-code (required for wire)
    • args.bankAccountId string? Bank account number (required for wire)
    • args.bankName string? Bank name (required for wire)
    • args.bankAddress string? Bank address (required for wire)
    • args.payonnerId string? (required for payoneer)

Examples

(async () => {
  const balancesService = new BalancesService('https://jsonplaceholder.typicode.com/', 'dsugsahfdkljhafljkdfhajkldshfad');
  const balances = await balancesService.createPaymentMethod({});
})();

Returns object response

createPaymentMethod

Updates existed payment method ("transactions" scope is needed)

Parameters

  • args object object with arguments
    • args.paymentMethod number Payment method (paypal, wire, skrill, payoneer) (required)
    • args.email string? E-mail (required for paypal & skrill)
    • args.fullName string? First & last name (required for wire)
    • args.address string? Address (required for wire)
    • args.country string? Country char code (required for wire)
    • args.swiftCode string? SWIFT-code (required for wire)
    • args.bankAccountId string? Bank account number (required for wire)
    • args.bankName string? Bank name (required for wire)
    • args.bankAddress string? Bank address (required for wire)
    • args.payonnerId string? (required for payoneer)

Examples

(async () => {
  const balancesService = new BalancesService('https://jsonplaceholder.typicode.com/', 'dsugsahfdkljhafljkdfhajkldshfad');
  const balances = await balancesService.createPaymentMethod({});
})();

Returns object response

createWithdrawRequest

Creates new withdraw request ("transactions" scope is needed)

Parameters

  • args object object with arguments
    • args.amount string amount to withdraw (must be greater than balance) (required)
    • args.paymentMethod string Payment method (paypal, wire, skrill, payoneer) (required)

Examples

(async () => {
  const balancesService = new BalancesService('https://jsonplaceholder.typicode.com/', 'dsugsahfdkljhafljkdfhajkldshfad');
  const balances = await balancesService.createWithdrawRequest({});
})();

Returns object response

requestUserPaymentMethods

Get all user payment methods ("transactions" scope is needed)

Examples

(async () => {
  const balancesService = new BalancesService('https://jsonplaceholder.typicode.com/', 'dsugsahfdkljhafljkdfhajkldshfad');
  const balances = await balancesService.requestUserPaymentMethods();
})();

Returns array array with balances info

requestUserWithdrawInformation

Return user own last withdraw request ("transactions" scope is needed)

Examples

(async () => {
  const balancesService = new BalancesService('https://jsonplaceholder.typicode.com/', 'dsugsahfdkljhafljkdfhajkldshfad');
  const balances = await balancesService.requestUserPaymentMethods();
})();

Returns array array with balances info

getBalanceByOrderId

Transaction - Request balance of order for balance_type

Parameters

  • params object
    • params.orderId string Order id (required).
    • params.balanceType string? Balance type.

Examples

(async () => {
  const balancesService = new BalancesService('http://service-balances.dev/api/v2/');
  const request = await balancesService.getBalanceByOrderId(params);
})();

Returns Promise<any>

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.