retrievePaymentCollection - Payment Module Reference

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

This method retrieves a payment collection by its ID.

Example#

A simple example that retrieves a {type name} by its ID:

Code
1const paymentCollection =2  await paymentModuleService.retrievePaymentCollection(3    "pay_col_123"4  )

To specify relations that should be retrieved:

Code
1const paymentCollection =2  await paymentModuleService.retrievePaymentCollection(3    "pay_col_123",4    {5      relations: ["payment_sessions"],6    }7  )

Parameters#

paymentCollectionIdstring

The payment collection's ID.

configFindConfig<PaymentCollectionDTO>Optional

The configurations determining how the payment collection is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a payment collection.

sharedContextContextOptional

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

Returns#

PromisePromise<PaymentCollectionDTO>

The retrieved payment collection.

Was this page helpful?