--- title: Qualify a Specific Finance Offer slug: api-documentation/qualify-a-specific-finance-offer docTags: createdAt: 2026-08-27T16:56:05.859Z --- { "id": "-L8PGMRXmancfcnmRHFfd", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.upstartcommerce.com/v1/finance-offers/{offerId}/qualified", "servers": [ { "url": "https://api.upstartcommerce.com/v1/finance-offers/{offerId}/qualified" } ], "name": "Qualify a Specific Finance Offer", "description": "

This endpoint will qualify a specific finance offer based on the credit card queried.

\n

Authorized permissions:

\n", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "offerId", "type": "string", "description": "The offer id used for lookups.", "format": "uuid" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "required", "name": "x-upstart-tenant", "type": "string", "description": "Tenant identifier associated with the site this call is for." } ], "queryParameters": [ { "kind": "required", "name": "currency", "type": "string", "example": "USD", "description": "

The 3-character ISO code. Must be one of the supported currencies (currently only USD is supported).

", "pattern": "^[A-Z]{3}" }, { "kind": "required", "name": "card-number", "type": "string", "example": "432984343222", "description": "The card number of the credit card to be qualified." }, { "kind": "required", "name": "purchase-amount", "type": "number", "example": 1499.99, "description": "

The finance-request amount.

", "format": "float", "minimum": 0 }, { "kind": "optional", "name": "timezoneId", "type": "string", "example": "America/Denver", "description": "

Timezone id (tz database). If not specified - tenant's default timezone is used.

" }, { "kind": "optional", "name": "productIds", "type": "array", "description": "

Optional list of catalog product ids present in the cart. When supplied and the offer has\nproduct associations, the offer is returned only if at least one of the supplied productIds\nmatches an association. When the offer has no product associations it is always returned\n(general offer). When omitted or empty, no product filtering is applied (legacy behaviour).

", "schema": [], "itemType": "string", "customType": "string[]" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "AnonymousAuth", "name": "AnonymousAuth", "kind": "optional", "type": "http", "description": "This is the most basic authentication. The minimum requirement for access is a token representing the user as an anonymous client.", "scheme": "bearer" }, { "id": "LoggedIn", "name": "LoggedIn", "kind": "optional", "type": "http", "description": "The presence of this token indicates that the user is a known consumer that has previously logged into the platform.", "scheme": "bearer" }, { "id": "NoChannelPortalAccess", "name": "NoChannelPortalAccess", "kind": "optional", "type": "http", "description": "

This authentication is required for clients to interact with any of the management APIs. Similar to 'LoggedIn', it indicates that the user has actually logged into the system, but in this case with a management role.

", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "

Success-qualified finance offer returned.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "QualifiedFinanceOffers", "schema": [], "modelRef": "#/components/schemas/QualifiedFinanceOffers", "complexItems": [ { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "", "default": "QualifiedSynchronyFinanceOffer" }, { "name": "id", "kind": "required", "type": "string", "description": "", "format": "uuid" }, { "name": "siteIds", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "provider", "kind": "required", "type": "string", "description": "", "modelRef": "#/components/schemas/Provider", "customType": "Provider", "schema": [] }, { "name": "providerFinanceOfferId", "kind": "required", "type": "string", "description": "", "modelRef": "#/components/schemas/ProviderFinanceOfferId", "customType": "ProviderFinanceOfferId", "schema": [] }, { "name": "tiers", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/Tier", "customType": "Tier[]", "schema": [] }, { "name": "sortOrder", "kind": "required", "type": "integer", "description": "The order in which the offer appears.", "format": "int32" }, { "name": "name", "kind": "required", "type": "string", "description": "Name of the finance offer." }, { "name": "description", "kind": "required", "type": "string", "description": "Description of the finance offer." }, { "name": "minimumPurchaseAmount", "kind": "required", "type": "number", "description": "Minimum purchase amount for the finance offer.", "format": "double" }, { "name": "currency", "kind": "required", "type": "string", "description": "", "example": "USD" }, { "name": "downPayment", "kind": "optional", "type": "object", "description": "

If required, this would be the amount for a down-payment that is necessary to take advantage of this finance offer.\nThis can be represented in one of a couple of forms:

\n
    \n
  • AbsoluteDownPayment - a fixed amount.
    • \n
  • RelativeDownPayment - a percentage amount based on the ENTIRE order value (taxes, shipping, and product).
    • \n
  • DeliveryAndTaxes - this indicates that the consumer needs to pay for taxes and delivery fees as a down payment.
    • \n
", "modelRef": "#/components/schemas/DownPayment", "customType": "DownPayment", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "AbsoluteDownPayment", "description": "", "modelRef": "#/components/schemas/AbsoluteDownPayment", "schema": [ { "name": "amount", "kind": "required", "type": "number", "description": "", "example": 500 } ] }, { "name": "RelativeDownPayment", "description": "", "modelRef": "#/components/schemas/RelativeDownPayment", "schema": [ { "name": "percent", "kind": "required", "type": "number", "description": "", "example": 0.2, "format": "double", "minimum": 0, "maximum": 1 } ] }, { "name": "DeliveryAndTaxes", "description": "", "modelRef": "#/components/schemas/DeliveryAndTaxes", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "", "default": "DeliveryAndTaxes" } ] } ] }, { "name": "termsAndConditions", "kind": "optional", "type": "string", "description": "Terms and conditions for the finance offer." }, { "name": "promotionalPeriodMonths", "kind": "required", "type": "integer", "description": "Promotional period in months.", "format": "int32" }, { "name": "financeOfferType", "kind": "required", "type": "string", "description": "", "modelRef": "#/components/schemas/FinanceOfferType", "customType": "FinanceOfferType", "schema": [] }, { "name": "productBasedOffer", "kind": "optional", "type": "boolean", "description": "

True when this offer is included in the response because of a product association\n(i.e. it is a product-specific offer that matched at least one of the supplied productIds).\nFalse for general offers and for any response produced when productIds was not supplied.

", "default": false } ], "modelRef": "#/components/schemas/QualifiedSynchronyFinanceOffer", "customType": "QualifiedSynchronyFinanceOffer" }, { "name": "object", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "", "default": "QualifiedFortivaFinanceOffer" }, { "name": "siteIds", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "provider", "kind": "required", "type": "string", "description": "", "modelRef": "#/components/schemas/Provider", "customType": "Provider", "schema": [] }, { "name": "providerFinanceOfferId", "kind": "required", "type": "string", "description": "", "modelRef": "#/components/schemas/ProviderFinanceOfferId", "customType": "ProviderFinanceOfferId", "schema": [] }, { "name": "sortOrder", "kind": "required", "type": "integer", "description": "The order in which the offer appears.", "format": "int32" }, { "name": "minimumPurchaseAmount", "kind": "required", "type": "number", "description": "Minimum purchase amount for the finance offer.", "format": "double" }, { "name": "currency", "kind": "required", "type": "string", "description": "", "example": "USD" }, { "name": "downPayment", "kind": "optional", "type": "object", "nullable": true, "description": "

If required, this would be the amount for a down-payment that is necessary to take advantage of this finance offer.\nThis can be represented in one of a couple of forms:

\n
    \n
  • AbsoluteDownPayment - a fixed amount.
    • \n
  • RelativeDownPayment - a percentage amount based on the ENTIRE order value (taxes, shipping, and product).
    • \n
  • DeliveryAndTaxes - this indicates that the consumer needs to pay for taxes and delivery fees as a down payment.
    • \n
", "modelRef": "#/components/schemas/DownPayment", "customType": "DownPayment", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "AbsoluteDownPayment", "description": "", "modelRef": "#/components/schemas/AbsoluteDownPayment", "schema": [ { "name": "amount", "kind": "required", "type": "number", "description": "", "example": 500 } ] }, { "name": "RelativeDownPayment", "description": "", "modelRef": "#/components/schemas/RelativeDownPayment", "schema": [ { "name": "percent", "kind": "required", "type": "number", "description": "", "example": 0.2, "format": "double", "minimum": 0, "maximum": 1 } ] }, { "name": "DeliveryAndTaxes", "description": "", "modelRef": "#/components/schemas/DeliveryAndTaxes", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "", "default": "DeliveryAndTaxes" } ] } ] }, { "name": "promotionalPeriodMonths", "kind": "required", "type": "integer", "description": "Promotional period in months.", "format": "int32" }, { "name": "financeOfferType", "kind": "required", "type": "string", "description": "", "modelRef": "#/components/schemas/FinanceOfferType", "customType": "FinanceOfferType", "schema": [] }, { "name": "productBasedOffer", "kind": "optional", "type": "boolean", "description": "

True when this offer is included in the response because of a product association.\nAlways false for Fortiva in this phase (Fortiva offers are not product-specific).

", "default": false } ], "modelRef": "#/components/schemas/QualifiedFortivaFinanceOffer", "customType": "QualifiedFortivaFinanceOffer" } ], "complexType": "oneOf", "isExpanded": true } ] }, { "statusCode": "400", "description": "The request contained information that the server was unable to process. Appropriate errors are provided in the response body.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ValidationErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "optional", "type": "object", "description": "", "complexType": "oneOf", "complexItems": [], "schema": [] } ], "modelRef": "#/components/schemas/ValidationErrorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "404", "description": "The requested resource was not found in the NoChannel system.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "lyX_6pK964z19bA7-j12H", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://api.upstartcommerce.com/v1/finance-offers/{offerId}/qualified?currency=USD&card-number=432984343222&purchase-amount=1499.99' \\\n --header 'accept: application/json' \\\n --header 'x-upstart-tenant: string'" }, { "id": "zBnaUJAQ8P4aXDEzN5bsW", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-upstart-tenant\", \"string\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/v1/finance-offers/{offerId}/qualified?currency=USD&card-number=432984343222&purchase-amount=1499.99\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "h5x9r8oZV6mRojMyWPGbk", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/finance-offers/{offerId}/qualified?currency=USD&card-number=432984343222&purchase-amount=1499.99\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "KDiNGDLRpNXkz8-wj734q", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/finance-offers/{offerId}/qualified?currency=USD&card-number=432984343222&purchase-amount=1499.99\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "lyX_6pK964z19bA7-j12H" }, "results": { "languages": [ { "id": "234KZZIDmul0JCEH5C_UV", "language": "200", "code": "// Success-qualified finance offer returned.\n{}" }, { "id": "eIk-mPZ921exoXHLhSe3P", "language": "400", "code": "// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": {}\n}" }, { "id": "l148KOFRXb2C_xj9MnzD4", "language": "401", "code": "// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "jg9N9svmEx1CKEDan-gM7", "language": "404", "code": "// The requested resource was not found in the NoChannel system.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" } ], "selectedLanguageId": "234KZZIDmul0JCEH5C_UV" } }, "children": [ { "text": "" } ] }