asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
907f7f83d8fdc63154a8a8fee11eb902a16efdf5
medusa-store/docs/content/references/services/classes/PaymentProviderService.md
github-actions[bot] 6aee2e2265 chore(docs): Generated Services Reference (automated) (#2663) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2022-11-28 11:02:51 +02:00

764 lines
17 KiB
Markdown
Raw Blame History

# Class: PaymentProviderService
Helps retrieve payment providers
## Hierarchy
- `TransactionBaseService`
↳ **`PaymentProviderService`**
## Constructors
### constructor
• **new PaymentProviderService**(`container`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `container` | `InjectedDependencies` |
#### Overrides
TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/payment-provider.ts:57](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L57)
## Properties
### \_\_configModule\_\_
• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
### \_\_container\_\_
• `Protected` `Readonly` **\_\_container\_\_**: `any`
#### Inherited from
TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
### container\_
• `Protected` `Readonly` **container\_**: `InjectedDependencies`
#### Defined in
[packages/medusa/src/services/payment-provider.ts:47](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L47)
___
### featureFlagRouter\_
• `Protected` `Readonly` **featureFlagRouter\_**: `FlagRouter`
#### Defined in
[packages/medusa/src/services/payment-provider.ts:55](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L55)
___
### logger\_
• `Protected` `Readonly` **logger\_**: `Logger`
#### Defined in
[packages/medusa/src/services/payment-provider.ts:53](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L53)
___
### manager\_
• `Protected` **manager\_**: `EntityManager`
#### Overrides
TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/payment-provider.ts:45](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L45)
___
### paymentProviderRepository\_
• `Protected` `Readonly` **paymentProviderRepository\_**: typeof `PaymentProviderRepository`
#### Defined in
[packages/medusa/src/services/payment-provider.ts:50](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L50)
___
### paymentRepository\_
• `Protected` `Readonly` **paymentRepository\_**: typeof `PaymentRepository`
#### Defined in
[packages/medusa/src/services/payment-provider.ts:51](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L51)
___
### paymentSessionRepository\_
• `Protected` `Readonly` **paymentSessionRepository\_**: typeof `PaymentSessionRepository`
#### Defined in
[packages/medusa/src/services/payment-provider.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L48)
___
### refundRepository\_
• `Protected` `Readonly` **refundRepository\_**: typeof `RefundRepository`
#### Defined in
[packages/medusa/src/services/payment-provider.ts:52](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L52)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides
TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/payment-provider.ts:46](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L46)
## Methods
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
| :------ |
| `TResult` |
| `TError` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
___
### authorizePayment
▸ **authorizePayment**(`paymentSession`, `context`): `Promise`<`undefined` \| `PaymentSession`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `paymentSession` | `PaymentSession` |
| `context` | `Record`<`string`, `unknown`\> |
#### Returns
`Promise`<`undefined` \| `PaymentSession`\>
#### Defined in
[packages/medusa/src/services/payment-provider.ts:447](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L447)
___
### cancelPayment
▸ **cancelPayment**(`paymentObj`): `Promise`<`Payment`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `paymentObj` | `Partial`<`Payment`\> & { `id`: `string` } |
#### Returns
`Promise`<`Payment`\>
#### Defined in
[packages/medusa/src/services/payment-provider.ts:503](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L503)
___
### capturePayment
▸ **capturePayment**(`paymentObj`): `Promise`<`Payment`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `paymentObj` | `Partial`<`Payment`\> & { `id`: `string` } |
#### Returns
`Promise`<`Payment`\>
#### Defined in
[packages/medusa/src/services/payment-provider.ts:528](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L528)
___
### createPayment
▸ **createPayment**(`data`): `Promise`<`Payment`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `data` | `Object` |
| `data.amount` | `number` |
| `data.cart_id` | `string` |
| `data.currency_code` | `string` |
| `data.payment_session` | `PaymentSession` |
#### Returns
`Promise`<`Payment`\>
#### Defined in
[packages/medusa/src/services/payment-provider.ts:381](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L381)
___
### createPaymentNew
▸ **createPaymentNew**(`paymentInput`): `Promise`<`Payment`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `paymentInput` | `Omit`<`PaymentProviderDataInput`, ``"customer"``\> & { `payment_session`: `PaymentSession` } |
#### Returns
`Promise`<`Payment`\>
#### Defined in
[packages/medusa/src/services/payment-provider.ts:411](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L411)
___
### createSession
▸ **createSession**(`providerId`, `cart`): `Promise`<`PaymentSession`\>
Creates a payment session with the given provider.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `providerId` | `string` | the id of the provider to create payment with |
| `cart` | `Cart` | a cart object used to calculate the amount, etc. from |
#### Returns
`Promise`<`PaymentSession`\>
the payment session
#### Defined in
[packages/medusa/src/services/payment-provider.ts:172](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L172)
___
### createSessionNew
▸ **createSessionNew**(`sessionInput`): `Promise`<`PaymentSession`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `sessionInput` | `PaymentProviderDataInput` |
#### Returns
`Promise`<`PaymentSession`\>
#### Defined in
[packages/medusa/src/services/payment-provider.ts:195](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L195)
___
### deleteSession
▸ **deleteSession**(`paymentSession`): `Promise`<`undefined` \| `PaymentSession`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `paymentSession` | `PaymentSession` |
#### Returns
`Promise`<`undefined` \| `PaymentSession`\>
#### Defined in
[packages/medusa/src/services/payment-provider.ts:327](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L327)
___
### getStatus
▸ **getStatus**(`payment`): `Promise`<`PaymentSessionStatus`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `payment` | `Payment` |
#### Returns
`Promise`<`PaymentSessionStatus`\>
#### Defined in
[packages/medusa/src/services/payment-provider.ts:523](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L523)
___
### list
▸ **list**(): `Promise`<`PaymentProvider`[]\>
#### Returns
`Promise`<`PaymentProvider`[]\>
#### Defined in
[packages/medusa/src/services/payment-provider.ts:89](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L89)
___
### listPayments
▸ **listPayments**(`selector`, `config?`): `Promise`<`Payment`[]\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `selector` | `Selector`<`Payment`\> |
| `config` | `FindConfig`<`Payment`\> |
#### Returns
`Promise`<`Payment`[]\>
#### Defined in
[packages/medusa/src/services/payment-provider.ts:124](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L124)
___
### refreshSession
▸ **refreshSession**(`paymentSession`, `cart`): `Promise`<`PaymentSession`\>
Refreshes a payment session with the given provider.
This means, that we delete the current one and create a new.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `paymentSession` | `PaymentSession` | the payment session object to update |
| `cart` | `Cart` | a cart object used to calculate the amount, etc. from |
#### Returns
`Promise`<`PaymentSession`\>
the payment session
#### Defined in
[packages/medusa/src/services/payment-provider.ts:228](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L228)
___
### refreshSessionNew
▸ **refreshSessionNew**(`paymentSession`, `sessionInput`): `Promise`<`PaymentSession`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `paymentSession` | `PaymentSession` |
| `sessionInput` | `PaymentProviderDataInput` |
#### Returns
`Promise`<`PaymentSession`\>
#### Defined in
[packages/medusa/src/services/payment-provider.ts:260](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L260)
___
### refundFromPayment
▸ **refundFromPayment**(`payment`, `amount`, `reason`, `note?`): `Promise`<`Refund`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `payment` | `Payment` |
| `amount` | `number` |
| `reason` | `string` |
| `note?` | `string` |
#### Returns
`Promise`<`Refund`\>
#### Defined in
[packages/medusa/src/services/payment-provider.ts:632](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L632)
___
### refundPayment
▸ **refundPayment**(`payObjs`, `amount`, `reason`, `note?`): `Promise`<`Refund`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `payObjs` | `Payment`[] |
| `amount` | `number` |
| `reason` | `string` |
| `note?` | `string` |
#### Returns
`Promise`<`Refund`\>
#### Defined in
[packages/medusa/src/services/payment-provider.ts:548](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L548)
___
### registerInstalledProviders
▸ **registerInstalledProviders**(`providerIds`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `providerIds` | `string`[] |
#### Returns
`Promise`<`void`\>
#### Defined in
[packages/medusa/src/services/payment-provider.ts:70](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L70)
___
### retrievePayment
▸ **retrievePayment**(`id`, `relations?`): `Promise`<`Payment`\>
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `id` | `string` | `undefined` |
| `relations` | `string`[] | `[]` |
#### Returns
`Promise`<`Payment`\>
#### Defined in
[packages/medusa/src/services/payment-provider.ts:96](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L96)
___
### retrieveProvider
▸ **retrieveProvider**<`TProvider`\>(`providerId`): `TProvider` extends `AbstractPaymentService` ? `AbstractPaymentService` : `any`
Finds a provider given an id
#### Type parameters
| Name | Type |
| :------ | :------ |
| `TProvider` | extends `unknown` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `providerId` | `string` | the id of the provider to get |
#### Returns
`TProvider` extends `AbstractPaymentService` ? `AbstractPaymentService` : `any`
the payment provider
#### Defined in
[packages/medusa/src/services/payment-provider.ts:357](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L357)
___
### retrieveRefund
▸ **retrieveRefund**(`id`, `config?`): `Promise`<`Refund`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `config` | `FindConfig`<`Refund`\> |
#### Returns
`Promise`<`Refund`\>
#### Defined in
[packages/medusa/src/services/payment-provider.ts:672](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L672)
___
### retrieveSession
▸ **retrieveSession**(`id`, `relations?`): `Promise`<`PaymentSession`\>
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `id` | `string` | `undefined` |
| `relations` | `string`[] | `[]` |
#### Returns
`Promise`<`PaymentSession`\>
#### Defined in
[packages/medusa/src/services/payment-provider.ts:137](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L137)
___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
___
### updatePayment
▸ **updatePayment**(`paymentId`, `data`): `Promise`<`Payment`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `paymentId` | `string` |
| `data` | `Object` |
| `data.order_id?` | `string` |
| `data.swap_id?` | `string` |
#### Returns
`Promise`<`Payment`\>
#### Defined in
[packages/medusa/src/services/payment-provider.ts:435](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L435)
___
### updateSession
▸ **updateSession**(`paymentSession`, `cart`): `Promise`<`PaymentSession`\>
Updates an existing payment session.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `paymentSession` | `PaymentSession` | the payment session object to update |
| `cart` | `Cart` | the cart object to update for |
#### Returns
`Promise`<`PaymentSession`\>
the updated payment session
#### Defined in
[packages/medusa/src/services/payment-provider.ts:287](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L287)
___
### updateSessionData
▸ **updateSessionData**(`paymentSession`, `data`): `Promise`<`PaymentSession`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `paymentSession` | `PaymentSession` |
| `data` | `Record`<`string`, `unknown`\> |
#### Returns
`Promise`<`PaymentSession`\>
#### Defined in
[packages/medusa/src/services/payment-provider.ts:482](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L482)
___
### updateSessionNew
▸ **updateSessionNew**(`paymentSession`, `sessionInput`): `Promise`<`PaymentSession`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `paymentSession` | `PaymentSession` |
| `sessionInput` | `PaymentProviderDataInput` |
#### Returns
`Promise`<`PaymentSession`\>
#### Defined in
[packages/medusa/src/services/payment-provider.ts:305](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L305)
___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`PaymentProviderService`](PaymentProviderService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`PaymentProviderService`](PaymentProviderService.md)
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
Reference in New Issue View Git Blame Copy Permalink