upsertPaymentCollections - Payment Module Reference

This documentation provides a reference to the upsertPaymentCollections 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.

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

This method updates or creates payment collections if they don't exist.

Example#

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

Parameters#

dataUpsertPaymentCollectionDTO[]

The attributes in the payment collections to be created or updated. If the object includes the id field, then the payment collection is updated. Otherise, it's created.

sharedContextContextOptional

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

Returns#

PromisePromise<PaymentCollectionDTO[]>

The created or updated payment collections.

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

This method updates or creates a payment collection if it doesn't exist.

Example#

Code
1const paymentCollection =2  await paymentModuleService.upsertPaymentCollections({3    id: "pay_col_123",4  })

Parameters#

dataUpsertPaymentCollectionDTO

The attributes in the payment collection to be created or updated. If the id field is included, the payment collection is updated. Otherwise, it's created.

sharedContextContextOptional

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

Returns#

PromisePromise<PaymentCollectionDTO>

The created or updated payment collection.

Was this page helpful?