@plasma-platform/service-payment-gate v3.0.1

Full documentation
install:
npm i @plasma-platform/service-payment-gate -S

Short documentation

Table of Contents

• PaymentClientService
  • Parameters
  • messages
  • createExtendedPayment
    • Parameters
    • Examples
  • createPayment
    • Parameters
    • Examples
  • retryPayment
    • Parameters
    • Examples
  • getSavedPaymentMethodCount
    • Parameters
    • Examples
  • getCommonPaymentMethodsProjects
    • Parameters
    • Examples
  • getCommonPaymentMethods
    • Parameters
    • Examples
  • getUserSavedPaymentMethods
    • Parameters
    • Examples

PaymentClientService

Payment client Micro Service API SDK

Parameters

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

messages

Object with class service messages

Type: Object

createExtendedPayment

Create extended payment

Parameters

• args object (required) arguments for payments
  • args.currency string? currency ISO-3 code (default: USD)
  • args.locale string? locale code, max length 2 (default en)
  • args.cartId string (required) cart id
  • args.project string (required) project id
  • args.paymentMethodIds array (required) payment method ids
  • args.savedPaymentMethodId string Saved arguments for payments
  • args.email string (required) user Email
  • args.phone string (required) user phone number
  • args.bonuses number Amount of bonuses to use for payment.
  • args.trackingInfo object tracking info for payment
  • args.paymentOptions object payment options

Examples

(async () => {
  const paymentClientService = new PaymentClientService('https://jsonplaceholder.typicode.com/', 'dsugsahfdkljhafljkdfhajkldshfad');
  const data = await paymentClientService.createExtendedPayment({
    cartId: 111,
    project:'monster',
    paymentMethodIds: ['dsfsdhfi9i8304ufds'],
    email: 'user@mail.com',
    phone: '123456789',
  });
})();

Returns object object with new cart properties

createPayment

Create payment

Parameters

• args object (required) arguments for payments
  • args.currency string? currency ISO-3 code (default: USD)
  • args.locale string? locale code, max length 2 (default en)
  • args.cartId string (required) cart id
  • args.project string (required) project id
  • args.paymentMethodIds array (required) payment method ids
  • args.email string (required) user Email
  • args.phone string (required) user phone number
  • args.trackingInfo object tracking info for payment
  • args.paymentOptions object payment options

Examples

(async () => {
  const paymentClientService = new PaymentClientService('https://jsonplaceholder.typicode.com/', 'dsugsahfdkljhafljkdfhajkldshfad');
  const data = await paymentClientService.createPayment({
    cartId: 111,
    project:'monster',
    paymentMethodIds: ['dsfsdhfi9i8304ufds'],
    email: 'user@mail.com',
    phone: '123456789',
  });
})();

Returns object object with new cart properties

retryPayment

Retry payment

Parameters

• args object (required) arguments for payments
  • args.orderId string (required) cart id
  • args.paymentMethodId string (required) payment method id
  • args.trackingInfo object tracking info for payment

Examples

(async () => {
  const paymentClientService = new PaymentClientService('https://jsonplaceholder.typicode.com/', 'dsugsahfdkljhafljkdfhajkldshfad');
  const data = await paymentClientService.retryPayment({
    orderId: 111,
    paymentMethodId: 'dsfsdhfi9i8304ufds',
  });
})();

Returns object object with new payment url

getSavedPaymentMethodCount

Get saved payment method count

Parameters

• email string (required) client email

Examples

(async () => {
  const paymentClientService = new PaymentClientService('https://jsonplaceholder.typicode.com/', 'dsugsahfdkljhafljkdfhajkldshfad');
  const data = await paymentClientService.getSavedPaymentMethodCount('user@mail.com');
})();

Returns number payment method count

getCommonPaymentMethodsProjects

Get common payment methods

Parameters

• args object (required) list of arguments for payment methods
  • args.project string (required) project name
  • args.countryCode string country code max length 2 (default us)
  • args.locale string locale code, max length 2 (default en)

Examples

(async () => {
  const paymentClientService = new PaymentClientService('https://jsonplaceholder.typicode.com/', 'dsugsahfdkljhafljkdfhajkldshfad');
  const data = await paymentClientService.getCommonPaymentMethodsProjects({project: 'monster'});
})();

Returns array payment method count

getCommonPaymentMethods

Get common payment methods

Parameters

• args object (required) list of arguments for payment methods
  • args.project string (required) project name
  • args.countryCode string country code max length 2 (default us)
  • args.locale string locale code, max length 2 (default en)

Examples

(async () => {
  const paymentClientService = new PaymentClientService('https://jsonplaceholder.typicode.com/', 'dsugsahfdkljhafljkdfhajkldshfad');
  const data = await paymentClientService.getCommonPaymentMethods({project: 'monster'});
})();

Returns array payment method count

getUserSavedPaymentMethods

Get user saved payment methods

Parameters

• args object (required) list of arguments for payment methods
  • args.project string (required) project name
  • args.locale string locale code, max length 2 (default en)

Examples

(async () => {
  const paymentClientService = new PaymentClientService('https://jsonplaceholder.typicode.com/', 'dsugsahfdkljhafljkdfhajkldshfad');
  const data = await paymentClientService.getUserSavedPaymentMethods({project: 'monster', locale: 'en'});
})();

Returns array payment method count