@plasma-platform/tm-service-balances 1.3.1

▸ createNewDocument()

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

createNewDocument(): object

Returns

object: response

Example

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

▸ getLinkAmazonS3Uploader()

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

getLinkAmazonS3Uploader(): object

Returns

object: response

Example

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

▸ requestTaxpayerDocument()

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

requestTaxpayerDocument(): object

Returns

object: response

Example

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

▸ createTaxpayerDocument(args)

Create taxpayer info or update existent one

createTaxpayerDocument(args: object): object

Parameters

args (object) object with arguments

Name	Description
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)

Returns

object: response

Example

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

▸ checkBalanceByUserId(id)

Check balance of the specified user

checkBalanceByUserId(id: string): array

Parameters

id (string) user id

Returns

array: array with balances info

Example

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

▸ requestTaxpayerInfo()

Returns taxpayer own information by his access_token

requestTaxpayerInfo(): array

Returns

array: array with balances info

Example

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

▸ requestTransactionInfo(id)

Returns taxpayer own information by his access_token

requestTransactionInfo(id: string): array

Parameters

id (string) Transaction unique ID

Returns

array: array with balances info

Example

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

▸ requestTransactionList(args?)

Request Transactions list of authenticated user by balance type

requestTransactionList(args: Object?): array

Parameters

args (Object?) object of params

Name	Description
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')

Returns

array: array with balances info

Example

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

▸ requestBalances(balanceType?)

Request balance of authenticated user by type or default

requestBalances(balanceType: string?): array

Parameters

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

Returns

array: array with balances info

Example

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

▸ createPaymentMethod(args)

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

createPaymentMethod(args: object): object

Parameters

args (object) object with arguments

Name	Description
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)

Returns

object: response

Example

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

▸ createPaymentMethod(args)

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

createPaymentMethod(args: object): object

Parameters

args (object) object with arguments

Name	Description
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)

Returns

object: response

Example

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

▸ createWithdrawRequest(args)

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

createWithdrawRequest(args: object): object

Parameters

args (object) object with arguments

Name	Description
args.amount `string`	amount to withdraw (must be greater than balance) (required)
args.paymentMethod `string`	Payment method (paypal, wire, skrill, payoneer) (required)

Returns

object: response

Example

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

▸ requestUserPaymentMethods()

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

requestUserPaymentMethods(): array

Returns

array: array with balances info

Example

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

▸ requestUserWithdrawInformation()

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

requestUserWithdrawInformation(): array

Returns

array: array with balances info

Example

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

▸ getBalanceByOrderId(params)

Transaction - Request balance of order for balance_type

getBalanceByOrderId(params: object): Promise<any>

Parameters

params (object)

Name	Description
params.orderId `string`	Order id (required).
params.balanceType `string?`	Balance type.

Returns

Promise<any>:

Example

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