createPaymentCollections - Payment Module Reference

This documentation provides a reference to the createPaymentCollections method. This belongs to the Payment Module.

createPaymentCollections(data, sharedContext?): Promise<PaymentCollectionDTO[]>

This method creates payment collections.

Example

const paymentCollections = await paymentModuleService.createPaymentCollections([
  {
    region_id: "reg_123",
    currency_code: "usd",
    amount: 3000,
  },
  {
    region_id: "reg_321",
    currency_code: "eur",
    amount: 2000,
  },
])

Parameters

dataCreatePaymentCollectionDTO[]Required

The payment collections to create.

sharedContextContext

A context used to share resources, such as transaction manager, between the application and the module.

Returns

PromisePromise<PaymentCollectionDTO[]>Required

The created payment collections.

createPaymentCollections(data, sharedContext?): Promise<PaymentCollectionDTO>

This method creates a payment collection.

Example

const paymentCollection =
  await paymentModuleService.createPaymentCollections({
    region_id: "reg_123",
    currency_code: "usd",
    amount: 3000,
  })

Parameters

dataCreatePaymentCollectionDTORequired

The payment collection to create.

sharedContextContext

A context used to share resources, such as transaction manager, between the application and the module.

Returns

PromisePromise<PaymentCollectionDTO>Required

The created payment collection.