StripeServiceImpl

string

The Spring bean identifier containing the service being called.stripeServiceImpl

string

default:"PROTOTYPE"

Bean scope. Use PROTOTYPE for service calls.

string

The public service method name shown in the signature below.

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.

Headers

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: conditional for USER/ADMIN.

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

void

Argument	Type	Description
—	—	This method does not accept arguments.

init

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

boolean

Argument	Type	Description
—	—	This method does not accept arguments.

isStripeKeysDefined

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

String

Argument	Type	Description
—	—	This method does not accept arguments.

getCurrency

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

String

Argument	Type	Description
`paymentRequestAsMap`	`LinkedHashMap<String, Object>`	Passed through `args[0].0`.

createIntent

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

Map<String,Object>

Argument	Type	Description
`paymentIntentId`	`String`	Passed through `args[0].0`.

retrieveIntent

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

String

Argument	Type	Description
`paymentIntentId`	`String`	Passed through `args[0].0`.

cancelIntent

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

String

Argument	Type	Description
`paymentIntentId`	`String`	Passed through `args[0].0`.

refundIntent

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

PaymentStatus

Argument	Type	Description
`paymentIntentId`	`String`	Passed through `args[0].0`.

chargeIntent

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

String

Argument	Type	Description
`paymentIntentId`	`String`	Passed through `args[0].0`.

obtain3DSecureLink

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

boolean

Argument	Type	Description
`paymentIntentId`	`String`	Passed through `args[0].0`.
`paymentMethodId`	`String`	Passed through `args[1].1`.

changePaymentMethod

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

String

Argument	Type	Description
`chargeRequestAsMap`	`LinkedHashMap<String, Object>`	Passed through `args[0].0`.

chargeSepa

Example JSON request object:

{
    "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

Argument	Type	Description
`chargeRequestAsMap`	`LinkedHashMap<String, Object>`	Passed through `args[0].0`.

chargeCreditCard

Example JSON request object:

{
    "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

Argument	Type	Description
`chargeRequestAsMap`	`LinkedHashMap<String, Object>`	Passed through `args[0].0`.

chargeTariffSepa

Example JSON request object:

{
    "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

Argument	Type	Description
`chargeRequestAsMap`	`LinkedHashMap<String, Object>`	Passed through `args[0].0`.

chargeTariffCreditCard

Example JSON request object:

{
    "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

Argument	Type	Description
`sellerId`	`String`	Passed through `args[0].0`.

cancelSubscriptionAfterActivePeriod

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

String

Argument	Type	Description
`sellerId`	`String`	Passed through `args[0].0`.

cancelSubscriptionImmediately

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

Map<String, Object>

Argument	Type	Description
`createdDate`	`String`	Passed through `args[0].0`.
`pattern`	`String`	Passed through `args[1].1`.

getContractEndDate

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

Map<String, Object>

Argument	Type	Description
`created`	`String`	Passed through `args[0].0`.
`pattern`	`String`	Passed through `args[1].1`.

getContractEndDateFromTimestamp

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

boolean

Argument	Type	Description
`tariff`	`String`	Passed through `args[0].0`.

isTariffEquals

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

Map<String, String>

Argument	Type	Description
`tariff`	`String`	Passed through `args[0].0`.

getAmountByTariff

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

Map<String,Object>

Argument	Type	Description
`orderId`	`String`	Passed through `args[0].0`.

createInvoice

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

List<Invoice>

Argument	Type	Description
—	—	This method does not accept arguments.

getInvoices

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

List<Product>

Argument	Type	Description
—	—	This method does not accept arguments.

getProducts

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

String

Argument	Type	Description
—	—	This method does not accept arguments.

createCustomer

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

void

Argument	Type	Description
`sellerId`	`String`	Passed through `args[0].0`.

deleteCustomer

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

void

Argument	Type	Description
`paymentMethodId`	`String`	Passed through `args[0].0`.

removePaymentMethod

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

List<PaymentMethod>

Argument	Type	Description
`type`	`String`	Passed through `args[0].0`.

getPaymentMethods

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

Map<String, Object>

Argument	Type	Description
`paymentMethodId`	`String`	Passed through `args[0].0`.

getPaymentMethod

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

Map<String,Object>

Argument	Type	Description
—	—	This method does not accept arguments.

getSubscription

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

Map<String, Object>

Argument	Type	Description
`amount`	`String`	Passed through `args[0].0`.
`countryIsoCode`	`String`	Passed through `args[1].1`.

calculateTaxRate

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

Map<String, TaxRate>

Argument	Type	Description
—	—	This method does not accept arguments.

obtainAllTaxRates

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

Client integration

Clients

Services

REST API

Headers

Methods

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

​Methods

​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

Methods

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