createAccountHolder - Payment Module Reference

This documentation provides a reference to the createAccountHolder 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 creates(if supported by provider) the account holder in the payment provider.

Example#

Code
1const accountHolder =2  await paymentModuleService.createAccountHolder(3    {4      provider_id: "stripe",5      context: {6        customer: {7          id: "cus_123",8        },9      },10    }11  )12
13 remoteLink.create([{14   [Modules.CUSTOMER]: {15     customer_id: "cus_123",16   },17   [Modules.PAYMENT]: {18     account_holder_id: accountHolder.id,19   },20 }])

Parameters#

inputCreateAccountHolderDTO

The payment session to be created.

sharedContextContextOptional

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

Returns#

PromisePromise<AccountHolderDTO>

The account holder's details in the payment provider, typically just the ID.

Was this page helpful?