---
displayed_sidebar: servicesSidebar
---

import ParameterTypes from "@site/src/components/ParameterTypes"

# SystemPaymentProviderService

## Constructors

### constructor

**new SystemPaymentProviderService**(`_`)

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "_",
    "type": "`any`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

## Properties

<ParameterTypes parameters={[
  {
    "name": "__configModule__",
    "type": "Record<`string`, `unknown`\\>",
    "description": "",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "__container__",
    "type": "`any`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "__moduleDeclaration__",
    "type": "Record<`string`, `unknown`\\>",
    "description": "",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "manager_",
    "type": "`EntityManager`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "transactionManager_",
    "type": "`undefined` \\| `EntityManager`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "identifier",
    "type": "`string`",
    "description": "",
    "optional": false,
    "defaultValue": "\"system\"",
    "expandable": false,
    "children": []
  }
]} />

## Accessors

### activeManager\_

`Protected` `get` **activeManager_**(): `EntityManager`

#### Returns

`EntityManager`

<ParameterTypes parameters={[
  {
    "name": "EntityManager",
    "type": "`EntityManager`",
    "optional": false,
    "defaultValue": "",
    "description": "",
    "expandable": false,
    "children": []
  }
]} />

## 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.

<ParameterTypes parameters={[
  {
    "name": "TResult",
    "type": "`object`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "TError",
    "type": "`object`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "work",
    "type": "(`transactionManager`: `EntityManager`) => `Promise`<`TResult`\\>",
    "description": "the transactional work to be done",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "isolationOrErrorHandler",
    "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>",
    "description": "the isolation level to be used for the work.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "maybeErrorHandlerOrDontFail",
    "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>",
    "description": "Potential error handler",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

`Promise`<`TResult`\>

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "`Promise`<`TResult`\\>",
    "optional": false,
    "defaultValue": "",
    "description": "the result of the transactional work",
    "expandable": false,
    "children": []
  }
]} />

___

### authorizePayment

**authorizePayment**(`_`): `Promise`<Record<`string`, `unknown`\>\>

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "_",
    "type": "`any`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

`Promise`<Record<`string`, `unknown`\>\>

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "`Promise`<Record<`string`, `unknown`\\>\\>",
    "optional": false,
    "defaultValue": "",
    "description": "",
    "expandable": false,
    "children": []
  }
]} />

___

### cancelPayment

**cancelPayment**(`_`): `Promise`<Record<`string`, `unknown`\>\>

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "_",
    "type": "`any`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

`Promise`<Record<`string`, `unknown`\>\>

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "`Promise`<Record<`string`, `unknown`\\>\\>",
    "optional": false,
    "defaultValue": "",
    "description": "",
    "expandable": false,
    "children": []
  }
]} />

___

### capturePayment

**capturePayment**(`_`): `Promise`<Record<`string`, `unknown`\>\>

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "_",
    "type": "`any`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

`Promise`<Record<`string`, `unknown`\>\>

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "`Promise`<Record<`string`, `unknown`\\>\\>",
    "optional": false,
    "defaultValue": "",
    "description": "",
    "expandable": false,
    "children": []
  }
]} />

___

### createPayment

**createPayment**(`_`): `Promise`<Record<`string`, `unknown`\>\>

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "_",
    "type": "`any`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

`Promise`<Record<`string`, `unknown`\>\>

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "`Promise`<Record<`string`, `unknown`\\>\\>",
    "optional": false,
    "defaultValue": "",
    "description": "",
    "expandable": false,
    "children": []
  }
]} />

___

### deletePayment

**deletePayment**(`_`): `Promise`<Record<`string`, `unknown`\>\>

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "_",
    "type": "`any`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

`Promise`<Record<`string`, `unknown`\>\>

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "`Promise`<Record<`string`, `unknown`\\>\\>",
    "optional": false,
    "defaultValue": "",
    "description": "",
    "expandable": false,
    "children": []
  }
]} />

___

### getPaymentData

**getPaymentData**(`_`): `Promise`<Record<`string`, `unknown`\>\>

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "_",
    "type": "`any`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

`Promise`<Record<`string`, `unknown`\>\>

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "`Promise`<Record<`string`, `unknown`\\>\\>",
    "optional": false,
    "defaultValue": "",
    "description": "",
    "expandable": false,
    "children": []
  }
]} />

___

### getStatus

**getStatus**(`_`): `Promise`<`string`\>

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "_",
    "type": "`any`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

`Promise`<`string`\>

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "`Promise`<`string`\\>",
    "optional": false,
    "defaultValue": "",
    "description": "",
    "expandable": false,
    "children": []
  }
]} />

___

### refundPayment

**refundPayment**(`_`): `Promise`<Record<`string`, `unknown`\>\>

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "_",
    "type": "`any`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

`Promise`<Record<`string`, `unknown`\>\>

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "`Promise`<Record<`string`, `unknown`\\>\\>",
    "optional": false,
    "defaultValue": "",
    "description": "",
    "expandable": false,
    "children": []
  }
]} />

___

### shouldRetryTransaction\_

`Protected` **shouldRetryTransaction_**(`err`): `boolean`

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "err",
    "type": "Record<`string`, `unknown`\\> \\| { `code`: `string`  }",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

`boolean`

<ParameterTypes parameters={[
  {
    "name": "boolean",
    "type": "`boolean`",
    "optional": true,
    "defaultValue": "",
    "description": "",
    "expandable": false,
    "children": []
  }
]} />

___

### updatePayment

**updatePayment**(`_`): `Promise`<Record<`string`, `unknown`\>\>

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "_",
    "type": "`any`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

`Promise`<Record<`string`, `unknown`\>\>

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "`Promise`<Record<`string`, `unknown`\\>\\>",
    "optional": false,
    "defaultValue": "",
    "description": "",
    "expandable": false,
    "children": []
  }
]} />

___

### updatePaymentData

**updatePaymentData**(`_`): `Promise`<Record<`string`, `unknown`\>\>

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "_",
    "type": "`any`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

`Promise`<Record<`string`, `unknown`\>\>

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "`Promise`<Record<`string`, `unknown`\\>\\>",
    "optional": false,
    "defaultValue": "",
    "description": "",
    "expandable": false,
    "children": []
  }
]} />

___

### withTransaction

**withTransaction**(`transactionManager?`): [`SystemPaymentProviderService`](SystemPaymentProviderService.mdx)

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "transactionManager",
    "type": "`EntityManager`",
    "description": "",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

[`SystemPaymentProviderService`](SystemPaymentProviderService.mdx)

<ParameterTypes parameters={[
  {
    "name": "SystemProviderService",
    "type": "[`SystemPaymentProviderService`](SystemPaymentProviderService.mdx)",
    "optional": false,
    "defaultValue": "",
    "description": "",
    "expandable": false,
    "children": []
  }
]} />