updatePaymentCollections - Payment Module Reference

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

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

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

This method updates an existing payment collection.

Example#

Code
1const paymentCollection =2  await paymentModuleService.updatePaymentCollections(3    "pay_col_123",4    {5      amount: 3000,6    }7  )

Parameters#

paymentCollectionIdstring

The payment collection's ID.

dataPaymentCollectionUpdatableFields

The attributes to update in the payment collection.

sharedContextContextOptional

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

Returns#

PromisePromise<PaymentCollectionDTO>

The updated payment collection.

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

This method updates existing payment collections matching the specified filters.

Example#

Code
1const paymentCollections =2  await paymentModuleService.updatePaymentCollections(3    {4      id: ["pay_col_123", "pay_col_321"],5    },6    {7      currency_code: "usd",8    }9  )

Parameters#

selectorFilterablePaymentCollectionProps

The filters specifying which payment collections to update.

dataPaymentCollectionUpdatableFields

The attributes to update in the payment collections.

sharedContextContextOptional

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

Returns#

PromisePromise<PaymentCollectionDTO[]>

The updated payment collections.

Was this page helpful?