updatePaymentCollections - Payment Module Reference

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

updatePaymentCollections(paymentCollectionId, data, sharedContext?): Promise<PaymentCollectionDTO>

This method updates an existing payment collection.

Example

const paymentCollection =
  await paymentModuleService.updatePaymentCollections(
    "pay_col_123",
    {
      amount: 3000,
    }
  )

Parameters

paymentCollectionIdstringRequired

The payment collection's ID.

dataPaymentCollectionUpdatableFieldsRequired

The attributes to update in the payment collection.

sharedContextContext

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

Returns

PromisePromise<PaymentCollectionDTO>Required

The updated payment collection.

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

This method updates existing payment collections matching the specified filters.

Example

const paymentCollections =
  await paymentModuleService.updatePaymentCollections(
    {
      id: ["pay_col_123", "pay_col_321"],
    },
    {
      currency_code: "usd",
    }
  )

Parameters

selectorFilterablePaymentCollectionPropsRequired

The filters specifying which payment collections to update.

dataPaymentCollectionUpdatableFieldsRequired

The attributes to update in the payment collections.

sharedContextContext

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

Returns

PromisePromise<PaymentCollectionDTO[]>Required

The updated payment collections.