Stripe Api Types

CreatePaymentIntentRequest

The request to create PaymentIntent.

Property Type Description

Property	Type	Description
`saveForFutureUse?`	`boolean`	If this PaymentIntent should be saved for future use, this value should be true. The customer should be authenticated to save the payment intent.
`savedPaymentUsage?`	`'off_session' \| 'on_session' \| undefined`	When a PaymentIntent’s payment method is stored for future use, this value declares if we intend to use the payment method on-session (i.e. as part of a customer interaction) or off-session (i.e. as part of a business-driven interaction).
`dynamicStatementDescriptor?`	`string`	For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.
`paymentTotal`	`{ / * The monetary amount. / amount: number / The currency. */ currency: string }`	The total amount to be used for the PaymentIntent.
`additionalAttributes?`	`Record<string, unknown>`	Any extra properties needed to define the PaymentIntent.

saveForFutureUse?

boolean

If this PaymentIntent should be saved for future use, this value should be true. The customer should be authenticated to save the payment intent.

savedPaymentUsage?

'off_session' | 'on_session' | undefined

When a PaymentIntent’s payment method is stored for future use, this value declares if we intend to use the payment method on-session (i.e. as part of a customer interaction) or off-session (i.e. as part of a business-driven interaction).

dynamicStatementDescriptor?

string

For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.

paymentTotal

{ / * The monetary amount. */ amount: number / * The currency. */ currency: string }

The total amount to be used for the PaymentIntent.

additionalAttributes?

Record<string, unknown>

Any extra properties needed to define the PaymentIntent.

PaymentIntentResponse

The DTO class that contains the properties from the PaymentIntent

Property Type Description

Property	Type	Description
`paymentIntentId`	`string`	The id of the PaymentIntent.
`clientSecret`	`string`	The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key.
`stripeCustomerId?`	`string`	The Stripe customer id.
`additionalAttributes?`	`Record<string, unknown>`	Any extra properties describing the PaymentIntent.

paymentIntentId

string

The id of the PaymentIntent.

clientSecret

string

The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key.

stripeCustomerId?

string

The Stripe customer id.

additionalAttributes?

Record<string, unknown>

Any extra properties describing the PaymentIntent.

SetupIntentRequest

The request to create SetupIntent.

Property Type Description

Property	Type	Description
`customerEmail?`	`string`	The BLC customer email.
`stripeCustomerId?`	`string`	The Stripe customer id.
`tenantId?`	`string`	The tenant id associated with the current request. Deprecated: this parameter is no longer used
`applicationId?`	`string`	The application id associated with the current request. Deprecated: this parameter is no longer used
`additionalFields?`	`Record<string, unknown>`	Any extra properties needed to define the SetupIntent.

customerEmail?

string

The BLC customer email.

stripeCustomerId?

string

The Stripe customer id.

tenantId?

string

The tenant id associated with the current request.

Deprecated: this parameter is no longer used

applicationId?

string

The application id associated with the current request.

Deprecated: this parameter is no longer used

additionalFields?

Record<string, unknown>

Any extra properties needed to define the SetupIntent.

SetupIntentResponse

The DTO class that contains the properties from the SetupIntent required to attach a payment method

Property Type Description

Property	Type	Description
`clientSecret`	`string`	The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.
`stripeCustomerId`	`string`	The Stripe customer id.

clientSecret

string

The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.

stripeCustomerId

string

The Stripe customer id.