> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mastermindcms.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PaymentProviderServiceImpl

> Calling public service methods through the REST API: paymentProviderServiceImpl

<ResponseField name="beanId" type="string">
  The Spring bean identifier containing the service being called.

  paymentProviderServiceImpl
</ResponseField>

<ResponseField name="scope" type="string" default="PROTOTYPE">
  Bean scope. Use PROTOTYPE for service calls.
</ResponseField>

<ResponseField name="functionName" type="string">
  The public service method name shown in the signature below.
</ResponseField>

<ResponseField name="args" type="object[]">
  The method argument array. Each argument is passed as an object with index 0, 1, and so on; the value must match the Java parameter type.
</ResponseField>

## Headers

```http theme={null}
POST /api/v1/bean/request
Content-Type: application/json
Lang-Context: en
Site-Context: my-site
Authorization: Bearer <token>
```

Send `Lang-Context` and `Site-Context` with every request. For protected methods, send the JWT in the `Authorization` header as `Bearer <token>`.

**Access:** ADMIN. **Bearer Token:** required.

* GUEST — unauthenticated users; only whitelist services are available.
* USER — authentication is required; methods with USER checks are available.
* ADMIN — full access to public methods of all services.
* If a method checks a role internally, GUEST may receive null.

## Methods

<ResponseField name="isActive" type="boolean">
  | Argument | Type | Description                            |
  | -------- | ---- | -------------------------------------- |
  | —        | —    | This method does not accept arguments. |

  ### isActive

  ```json theme={null}
  {
    "beanId": "paymentProviderServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "isActive",
    "args": []
  }
  ```
</ResponseField>

<ResponseField name="createInvoice" type="String">
  | Argument  | Type     | Description                 |
  | --------- | -------- | --------------------------- |
  | `orderId` | `String` | Passed through `args[0].0`. |

  ### createInvoice

  ```json theme={null}
  {
    "beanId": "paymentProviderServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "createInvoice",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="cancelPayment" type="String">
  | Argument    | Type     | Description                 |
  | ----------- | -------- | --------------------------- |
  | `paymentId` | `String` | Passed through `args[0].0`. |

  ### cancelPayment

  ```json theme={null}
  {
    "beanId": "paymentProviderServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "cancelPayment",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="refundPayment" type="String">
  | Argument    | Type     | Description                 |
  | ----------- | -------- | --------------------------- |
  | `paymentId` | `String` | Passed through `args[0].0`. |

  ### refundPayment

  ```json theme={null}
  {
    "beanId": "paymentProviderServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "refundPayment",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="changePaymentMethod" type="boolean">
  | Argument          | Type     | Description                 |
  | ----------------- | -------- | --------------------------- |
  | `paymentId`       | `String` | Passed through `args[0].0`. |
  | `paymentMethodId` | `String` | Passed through `args[1].1`. |

  ### changePaymentMethod

  ```json theme={null}
  {
    "beanId": "paymentProviderServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "changePaymentMethod",
    "args": [
      {
        "0": null,
        "1": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="get3DSecureLink" type="String">
  | Argument    | Type     | Description                 |
  | ----------- | -------- | --------------------------- |
  | `paymentId` | `String` | Passed through `args[0].0`. |

  ### get3DSecureLink

  ```json theme={null}
  {
    "beanId": "paymentProviderServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "get3DSecureLink",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="checkConnectAccountStatus" type="String">
  | Argument | Type | Description                            |
  | -------- | ---- | -------------------------------------- |
  | —        | —    | This method does not accept arguments. |

  ### checkConnectAccountStatus

  ```json theme={null}
  {
    "beanId": "paymentProviderServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "checkConnectAccountStatus",
    "args": []
  }
  ```
</ResponseField>

<ResponseField name="calculateTotalPrice" type="Map<String,Object>">
  | Argument  | Type     | Description                 |
  | --------- | -------- | --------------------------- |
  | `orderId` | `String` | Passed through `args[0].0`. |

  ### calculateTotalPrice

  ```json theme={null}
  {
    "beanId": "paymentProviderServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "calculateTotalPrice",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="calculateTaxAmountPrice" type="Map<String,Object>">
  | Argument  | Type     | Description                 |
  | --------- | -------- | --------------------------- |
  | `orderId` | `String` | Passed through `args[0].0`. |

  ### calculateTaxAmountPrice

  ```json theme={null}
  {
    "beanId": "paymentProviderServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "calculateTaxAmountPrice",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="calculateItemsTotalBruttoAmount" type="Map<String,Object>">
  | Argument  | Type     | Description                 |
  | --------- | -------- | --------------------------- |
  | `orderId` | `String` | Passed through `args[0].0`. |

  ### calculateItemsTotalBruttoAmount

  ```json theme={null}
  {
    "beanId": "paymentProviderServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "calculateItemsTotalBruttoAmount",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="calculateServiceFeeBruttoAmount" type="Map<String,Object>">
  | Argument  | Type     | Description                 |
  | --------- | -------- | --------------------------- |
  | `orderId` | `String` | Passed through `args[0].0`. |

  ### calculateServiceFeeBruttoAmount

  ```json theme={null}
  {
    "beanId": "paymentProviderServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "calculateServiceFeeBruttoAmount",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>

<ResponseField name="calculatePayoutAmount" type="Map<String,Object>">
  | Argument  | Type     | Description                 |
  | --------- | -------- | --------------------------- |
  | `orderId` | `String` | Passed through `args[0].0`. |

  ### calculatePayoutAmount

  ```json theme={null}
  {
    "beanId": "paymentProviderServiceImpl",
    "scope": "PROTOTYPE",
    "functionName": "calculatePayoutAmount",
    "args": [
      {
        "0": null
      }
    ]
  }
  ```
</ResponseField>