Merchant
Retrieve details about a specific merchant or a collection of merchants.
Αccess merchant details such as name, contact information and associated payment methods. It enables seamless integration with merchant systems, facilitating the retrieval and management of merchant-specific data. It provides a straightforward way to access merchant information for various use cases.
The Merchant endpoint allows you to 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 customer's basket meets the necessary criteria for BNPL financing.
You can retrieve information such as the merchant's name, contact details, location and other relevant details. This can be useful for displaying merchant information in a user interface, generating reports or conducting analysis.
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 BNPL financing, which provides customers with the option to pay for their purchases in installments.
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.
- Name
paymentDay
- Type
- string<date-time>
- Description
The day of the month on which the installment payment is due.
- Name
paymentAmount
- Type
- double
- Description
The amount of the payment for which the BNPL eligibility is being checked.
- Name
originalDueDate
- Type
- string<date-time>
- Description
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
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": "string",
"paymentAmount": 0,
"originalDueDate": "string"
}
]
}
Responses
Status | Meaning | Description |
---|---|---|
200 | OK | Returns check of basket eligibility for Buy Now Pay Later. |
400 | Bad Request | basketValue cannot be less than zero. / X-Application-ID not found or basketValue less than zero. / Basket's merchant was not found. |
500 | Internal Error | Internal server error. |