Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

createPaymentCollections - Payment Module Reference

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

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

This method creates payment collections.

Example#

Code
1const paymentCollections =2  await paymentModuleService.createPaymentCollections([3    {4      region_id: "reg_123",5      currency_code: "usd",6      amount: 3000,7    },8    {9      region_id: "reg_321",10      currency_code: "eur",11      amount: 2000,12    },13  ])

Parameters#

dataCreatePaymentCollectionDTO[]
The payment collections to create.
sharedContextContextOptional
A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<PaymentCollectionDTO[]>
The created payment collections.

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

This method creates a payment collection.

Example#

Code
1const paymentCollection =2  await paymentModuleService.createPaymentCollections({3    region_id: "reg_123",4    currency_code: "usd",5    amount: 3000,6  })

Parameters#

dataCreatePaymentCollectionDTO
The payment collection to create.
sharedContextContextOptional
A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<PaymentCollectionDTO>
The created payment collection.
Was this page helpful?