api

Finance Terms Simulation (Switzerland Only)

An endpoint to give the finance terms for a given credit request.

Note: This endpoint requires a PUBLIC API Key as the bearer token. Do not use a Merchant API Token generated in the usual way.

post/api/checkout/v1/external/credit-finance-terms/

Request

Base URL
https://sbx-origination.heidipay.io
Auth
HTTP bearer
TypeScript
https://skmtc.dev/heylight/apis/heidipay-checkout-api/docs/api/checkout/v1/external/credit-finance-terms/post.ts
A function with typed inputs. Its response is checked against the schema.

list_priceunknown

amountstring required

Amount to be financed (excluding residual value).

currencystring required

ISO 4217 Currency code of the amount to be financed.

termsinteger[] required

A list of terms to retrieve credit finance terms for.

allowed_termsinteger[]

A list of terms to retrieve credit finance terms for.

skustring

Optional. The SKU of the product

additional_dataobject

Optional. Additional data

No recorded changes to this operation across all 2 revisions of this API.