retrievePaymentCollection - Payment Module Reference

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

This method retrieves a payment collection by its ID.

Example

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

const paymentCollection =
  await paymentModuleService.retrievePaymentCollection(
    "pay_col_123"
  )

To specify relations that should be retrieved:

const paymentCollection =
  await paymentModuleService.retrievePaymentCollection(
    "pay_col_123",
    {
      relations: ["payment_sessions"],
    }
  )

Parameters

paymentCollectionIdstringRequired

The payment collection's ID.

configFindConfig<PaymentCollectionDTO>

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.

sharedContextContext

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

Returns

PromisePromise<PaymentCollectionDTO>Required

The retrieved payment collection.