Merchant

Check the eligibility of a basket for Buy Now Pay Later (BNPL) financing options.

This functionality is specific to merchants and helps determine whether a basket meets the necessary criteria for Pay Later financing.

GET/merchant/checkbasketeligibilityforbnpl

Check basket eligibility

Check the eligibility of a basket, based on the merchant ID and basket value. Determine whether a specific basket is eligible for Pay Later financing, and with details on monthly installment payment amounts and due dates.

Make sure you have the required permissions and authentication credentials to access this endpoint.

Query parameters

  • Name
    api-version
    Type
    string
    Description

    The requested API version. The parameter is optional. Default value: 1.0.

  • Name
    basketValue
    Type
    double
    Description

    The total value or amount of the basket or items being purchased.

Headers

  • Name
    X-Application-ID
    Type
    string
    Description

    The ID of the application making the request. This header parameter is required for authentication and identification purposes.

  • Name
    Ocp-Apim-Subscription-Key
    Type
    string
    Description

    A unique identifier related to the registered merchant in the snappi API environment, available within the application's details.

Response attributes

  • Name
    isBNPLEligible
    Type
    boolean
    Description

    A boolean value indicating whether the merchant is eligible for the Buy Now Pay Later (BNPL) service.

  • Name
    listOfMonthlyInstallments
    Type
    array
    Description

    An array or list of monthly installments for the BNPL service, indicating the amount due each month, including:

    • paymentDay (date-time) - The day of the month on which the installment payment is due.
    • paymentAmount (double) - The amount of the payment for which the BNPL eligibility is being checked.
    • originalDueDate (date-time) - The original due date of the payment for which the BNPL eligibility is being checked.
  • Name
    message
    Type
    string
    Description

    A detailed message or explanation related to the response or any encountered errors.

  • Name
    errors
    Type
    array
    Description

    An array of error objects that provide details about any errors encountered during the API request.

  • Name
    field
    Type
    string
    Description

    The field associated with the error.

  • Name
    type
    Type
    string
    Description

    The type or category of the response or error, providing additional classification or information.

  • Name
    title
    Type
    string
    Description

    The title of the response, providing a brief overview or summary of the response.

  • Name
    status
    Type
    integer
    Description

    The status of the API request, indicating whether it was successful or encountered any errors.

  • Name
    detail
    Type
    array
    Description

    Additional details or information related to the response, providing more context or explanations.

  • Name
    instance
    Type
    string
    Description

    The specific instance or occurrence of the response or error message.

Request

GET
/merchant/checkbasketeligibilityforbnpl
curl -X GET /merchant/checkbasketeligibilityforbnpl \
-H 'Accept: application/json' \
-H 'X-Application-ID: string' \
-H 'Ocp-Apim-Subscription-Key: string'

Response examples

{
"isBNPLEligible": true,
"listOfMonthlyInstallments": [
{
  "paymentDay": "",
  "paymentAmount": 0,
  "originalDueDate": ""
}
]
}

Responses

StatusDescriptionNotes
200OKReturns check of basket eligibility for Pay Later.
400Bad RequestbasketValue cannot be less than zero. / X-Application-ID not found or basketValue less than zero. / Basket's merchant was not found.
500Internal ErrorInternal server error.