Broadleaf Microservices
  • v1.0.0-latest-prod

Api Types

AmazonPaymentServicesInstallmentResponse

Installment response from Broadleaf Microservices Amazon Payment Endpoint.

Property Type Description

dateRecorded

string

The timestamp when this response was created.

failureType

string

The failure type of this response, if any.

gatewayResponseCode

string

The response code from the gateway.

message

string

The message for this response.

response

AmazonPaymentServicesInstallments

The response from the gateway.

successful

boolean

Whether or not this response was successful.

AmazonPaymentServicesInstallments

Installment response params from Amazon Payment Services.

Property Type Description

access_code

string

The access code for the merchant account.

amount?

string

The order amount to lookup qualifying installment plans.

currency?

string

The currency for the installment plans.

installment_detail?

InstallmentDetail

The details for the installment plans.

language

string

The language for the installment request.

merchant_identifier

string

The merchant identifier for the merchant account.

query_command

string

The query command for the request, e.g. "GET_INSTALLMENTS_PLANS".

response_code

string

The response code for the request.

response_message

string

The response message for the request.

signature

string

The response signature for the request.

status

string

The status code of the request.

AmazonPaymentServicesInstallmentsRequest

Request to fetch Installments from the Microservice APS endpoint.

Property Type Description

amount

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

language

string

InstallmentDetail

The installment details.

Property Type Description

issuer_detail

Array<IssuerDetail>

A list of issuing banks.

IssuerDetail

The issuer details.

Property Type Description

banking_system?

string

The banking system for the issuer.

bins?

Array<{ / * The bin number of the issuer. */ bin?: string

/ * The card brand for this bin. */ card_brand_code?: string

/ * The country code for this bin. */ country_code?: string

/ * The currency code for this bin. */ currency_code?: string }>

The bin details available for the issuer.

confirmation_message_ar?

string

The confirmation message in arabic.

confirmation_message_en?

string

The confirmation message in english.

country_code?

string

The country code of the issuer.

disclaimer_message_ar?

string

The disclaimer message in arabic.

disclaimer_message_en?

string

The disclaimer message in english.

formula?

string

The formula used in determining the installment value.

issuer_code

string

The issuer code for the bank.

issuer_logo_ar?

string

The issuer logo in arabic.

issuer_logo_en?

string

The issuer logo in english.

issuer_name_ar?

string

The issuer name in arabic.

issuer_name_en?

string

The issuer name in english.

plan_details

Array<PlanDetail>

The list of available plans offered by this issuer.

processing_fees_message_ar?

string

The processing fee message in arabic.

processing_fees_message_en?

string

The processing fee message in english.

terms_and_condition_ar?

string

The terms and conditions in arabic.

terms_and_condition_en?

string

The terms and conditions in english.

PlanDetail

The details of the installment plan.

Property Type Description

amountPerMonth?

string

The amount due per month for this installment plan.

currency_code?

string

The currency for this installment plan.

fee_display_value?

number

The display value for fee amount of this installment plan.

fees_amount?

number

The fee for this installment plan.

fees_type?

string

The fee type for this installment plan.

maximum_amount?

number

The maximum amount to qualify for this installment plan.

minimum_amount?

number

The minimum amount to qualify for this installment plan.

number_of_installment

number

The number of installments for this installment plan.

plan_code

string

The plan code for this installment plan.

plan_merchant_type?

string

The plan merchant type for this installment plan.

plan_type?

string

The plan type for this installment plan.

processing_fees_amount?

number

The processing fee for this installment plan.

processing_fees_type?

string

The processing fee type for this installment plan.

rate_type?

string

The rate type for this installment plan.

SetupIntentRequest

The request to create SetupIntent.

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.

applicationId?

string

The application id associated with the current request.

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

clientSecret

string

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

stripeCustomerId

string

The Stripe customer id.