StripeServiceImpl

string

Идентификатор Spring bean, который содержит вызываемый сервис.stripeServiceImpl

string

по умолчанию:"PROTOTYPE"

Область действия bean. Для вызовов сервисов используется PROTOTYPE.

string

Имя публичного метода сервиса, указанное в сигнатуре ниже.

object[]

Массив аргументов метода. Каждый аргумент передаётся объектом с индексом 0, 1 и т. д.; значение должно соответствовать Java-типу параметра.

Headers

POST /api/v1/bean/request
Content-Type: application/json
Lang-Context: ru
Site-Context: my-site
Authorization: Bearer <token>

Заголовки Lang-Context и Site-Context необходимо передавать в каждом запросе. Для защищённых методов передавайте JWT в заголовке Authorization в формате Bearer <token>. Доступ: GUEST* / USER или ADMIN. Bearer Token: условно для USER/ADMIN.

GUEST — без логина; доступен только whitelist.
USER — требуется авторизация; доступны методы с проверкой USER.
ADMIN — полный доступ к public-методам всех сервисов.
Если метод проверяет роль внутри логики, GUEST может получить null.

Методы

void

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

init

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "init",
  "args": []
}

boolean

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

isStripeKeysDefined

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "isStripeKeysDefined",
  "args": []
}

String

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

getCurrency

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getCurrency",
  "args": []
}

String

Аргумент	Тип	Описание
`paymentRequestAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

createIntent

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "createIntent",
  "args": [
    {
      "0": null
    }
  ]
}

Map<String,Object>

Аргумент	Тип	Описание
`paymentIntentId`	`String`	Передаётся через `args[0].0`.

retrieveIntent

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "retrieveIntent",
  "args": [
    {
      "0": null
    }
  ]
}

String

Аргумент	Тип	Описание
`paymentIntentId`	`String`	Передаётся через `args[0].0`.

cancelIntent

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "cancelIntent",
  "args": [
    {
      "0": null
    }
  ]
}

String

Аргумент	Тип	Описание
`paymentIntentId`	`String`	Передаётся через `args[0].0`.

refundIntent

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "refundIntent",
  "args": [
    {
      "0": null
    }
  ]
}

PaymentStatus

Аргумент	Тип	Описание
`paymentIntentId`	`String`	Передаётся через `args[0].0`.

chargeIntent

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "chargeIntent",
  "args": [
    {
      "0": null
    }
  ]
}

String

Аргумент	Тип	Описание
`paymentIntentId`	`String`	Передаётся через `args[0].0`.

obtain3DSecureLink

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "obtain3DSecureLink",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
`paymentIntentId`	`String`	Передаётся через `args[0].0`.
`paymentMethodId`	`String`	Передаётся через `args[1].1`.

changePaymentMethod

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "changePaymentMethod",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

String

Аргумент	Тип	Описание
`chargeRequestAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

chargeSepa

Пример JSON объекта запроса:

{
    "orderId":  null,
    "paymentMethodId":  null,
    "productId":  null,
    "description":  null,
    "amount":  0,
    "currencyCode":  null,
    "iban":  null,
    "email":  null,
    "name":  null,
    "userName":  null,
    "tariff":  null,
    "number":  null,
    "exp":  null,
    "cvc":  null
}

Request:

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "chargeSepa",
  "args": [
    {
      "0": null
    }
  ]
}

String

Аргумент	Тип	Описание
`chargeRequestAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

chargeCreditCard

Пример JSON объекта запроса:

{
    "orderId":  null,
    "paymentMethodId":  null,
    "productId":  null,
    "description":  null,
    "amount":  0,
    "currencyCode":  null,
    "iban":  null,
    "email":  null,
    "name":  null,
    "userName":  null,
    "tariff":  null,
    "number":  null,
    "exp":  null,
    "cvc":  null
}

Request:

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "chargeCreditCard",
  "args": [
    {
      "0": null
    }
  ]
}

void

Аргумент	Тип	Описание
`chargeRequestAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

chargeTariffSepa

Пример JSON объекта запроса:

{
    "orderId":  null,
    "paymentMethodId":  null,
    "productId":  null,
    "description":  null,
    "amount":  0,
    "currencyCode":  null,
    "iban":  null,
    "email":  null,
    "name":  null,
    "userName":  null,
    "tariff":  null,
    "number":  null,
    "exp":  null,
    "cvc":  null
}

Request:

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "chargeTariffSepa",
  "args": [
    {
      "0": null
    }
  ]
}

void

Аргумент	Тип	Описание
`chargeRequestAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

chargeTariffCreditCard

Пример JSON объекта запроса:

{
    "orderId":  null,
    "paymentMethodId":  null,
    "productId":  null,
    "description":  null,
    "amount":  0,
    "currencyCode":  null,
    "iban":  null,
    "email":  null,
    "name":  null,
    "userName":  null,
    "tariff":  null,
    "number":  null,
    "exp":  null,
    "cvc":  null
}

Request:

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "chargeTariffCreditCard",
  "args": [
    {
      "0": null
    }
  ]
}

String

Аргумент	Тип	Описание
`sellerId`	`String`	Передаётся через `args[0].0`.

cancelSubscriptionAfterActivePeriod

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "cancelSubscriptionAfterActivePeriod",
  "args": [
    {
      "0": null
    }
  ]
}

String

Аргумент	Тип	Описание
`sellerId`	`String`	Передаётся через `args[0].0`.

cancelSubscriptionImmediately

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "cancelSubscriptionImmediately",
  "args": [
    {
      "0": null
    }
  ]
}

Map<String, Object>

Аргумент	Тип	Описание
`createdDate`	`String`	Передаётся через `args[0].0`.
`pattern`	`String`	Передаётся через `args[1].1`.

getContractEndDate

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getContractEndDate",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

Map<String, Object>

Аргумент	Тип	Описание
`created`	`String`	Передаётся через `args[0].0`.
`pattern`	`String`	Передаётся через `args[1].1`.

getContractEndDateFromTimestamp

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getContractEndDateFromTimestamp",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
`tariff`	`String`	Передаётся через `args[0].0`.

isTariffEquals

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "isTariffEquals",
  "args": [
    {
      "0": null
    }
  ]
}

Map<String, String>

Аргумент	Тип	Описание
`tariff`	`String`	Передаётся через `args[0].0`.

getAmountByTariff

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getAmountByTariff",
  "args": [
    {
      "0": null
    }
  ]
}

Map<String,Object>

Аргумент	Тип	Описание
`orderId`	`String`	Передаётся через `args[0].0`.

createInvoice

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "createInvoice",
  "args": [
    {
      "0": null
    }
  ]
}

List<Invoice>

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

getInvoices

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getInvoices",
  "args": []
}

List<Product>

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

getProducts

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getProducts",
  "args": []
}

String

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

createCustomer

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "createCustomer",
  "args": []
}

void

Аргумент	Тип	Описание
`sellerId`	`String`	Передаётся через `args[0].0`.

deleteCustomer

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "deleteCustomer",
  "args": [
    {
      "0": null
    }
  ]
}

void

Аргумент	Тип	Описание
`paymentMethodId`	`String`	Передаётся через `args[0].0`.

removePaymentMethod

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removePaymentMethod",
  "args": [
    {
      "0": null
    }
  ]
}

List<PaymentMethod>

Аргумент	Тип	Описание
`type`	`String`	Передаётся через `args[0].0`.

getPaymentMethods

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getPaymentMethods",
  "args": [
    {
      "0": null
    }
  ]
}

Map<String, Object>

Аргумент	Тип	Описание
`paymentMethodId`	`String`	Передаётся через `args[0].0`.

getPaymentMethod

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getPaymentMethod",
  "args": [
    {
      "0": null
    }
  ]
}

Map<String,Object>

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

getSubscription

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getSubscription",
  "args": []
}

Map<String, Object>

Аргумент	Тип	Описание
`amount`	`String`	Передаётся через `args[0].0`.
`countryIsoCode`	`String`	Передаётся через `args[1].1`.

calculateTaxRate

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "calculateTaxRate",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

Map<String, TaxRate>

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

obtainAllTaxRates

{
  "beanId": "stripeServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "obtainAllTaxRates",
  "args": []
}

Клиенты для интеграции

Клиенты

Сервисы

REST API

Headers

Методы

init

isStripeKeysDefined

getCurrency

createIntent

retrieveIntent

cancelIntent

refundIntent

chargeIntent

obtain3DSecureLink

changePaymentMethod

chargeSepa

chargeCreditCard

chargeTariffSepa

chargeTariffCreditCard

cancelSubscriptionAfterActivePeriod

cancelSubscriptionImmediately

getContractEndDate

getContractEndDateFromTimestamp

isTariffEquals

getAmountByTariff

createInvoice

getInvoices

getProducts

createCustomer

deleteCustomer

removePaymentMethod

getPaymentMethods

getPaymentMethod

getSubscription

calculateTaxRate

obtainAllTaxRates

​Headers

​Методы

​init

​isStripeKeysDefined

​getCurrency

​createIntent

​retrieveIntent

​cancelIntent

​refundIntent

​chargeIntent

​obtain3DSecureLink

​changePaymentMethod

​chargeSepa

​chargeCreditCard

​chargeTariffSepa

​chargeTariffCreditCard

​cancelSubscriptionAfterActivePeriod

​cancelSubscriptionImmediately

​getContractEndDate

​getContractEndDateFromTimestamp

​isTariffEquals

​getAmountByTariff

​createInvoice

​getInvoices

​getProducts

​createCustomer

​deleteCustomer

​removePaymentMethod

​getPaymentMethods

​getPaymentMethod

​getSubscription

​calculateTaxRate

​obtainAllTaxRates

Headers

Методы

init

isStripeKeysDefined

getCurrency

createIntent

retrieveIntent

cancelIntent

refundIntent

chargeIntent

obtain3DSecureLink

changePaymentMethod

chargeSepa

chargeCreditCard

chargeTariffSepa

chargeTariffCreditCard

cancelSubscriptionAfterActivePeriod

cancelSubscriptionImmediately

getContractEndDate

getContractEndDateFromTimestamp

isTariffEquals

getAmountByTariff

createInvoice

getInvoices

getProducts

createCustomer

deleteCustomer

removePaymentMethod

getPaymentMethods

getPaymentMethod

getSubscription

calculateTaxRate

obtainAllTaxRates