BNPL API
Redirect URLsFAQ
BNPL API
Redirect URLsFAQ
milpay doc
  1. Initialization
  • Initialization
    • Check whether BNPL can be offered to a customer
      GET
    • Check whether an application already exists for this cart
      POST
    • Query the available offers for the merchant
      GET
    • Run a calculation on a cart amount
      GET
    • Create a BNPL application
      POST
    • Cancel an ongoing Application
      DELETE
  • Status Lists
    • Application Statuses
    • Deal Statuses
  • Querying
    • Returns offer data for a given offer ID
      GET
    • Get a listing of all BNPL Applications
      GET
    • Get the current status of a BNPL Application
      GET
    • Get a listing of all BNPL Purchases
      GET
    • Get data of specific Purchase
      GET
    • Get a listing of all BNPL Deals
      GET
    • Get data of Deal
      GET
    • Get customer limit value by customer email address
      POST
  • One Click
  • One Click V2 (BETA)
  • Hook
    • Called when a status update happens on a deal or application
  1. Initialization

Check whether BNPL can be offered to a customer

STAGING Gateway
https://gateway-staging.instacash.hu
STAGING Gateway
https://gateway-staging.instacash.hu
GET
https://gateway-staging.instacash.hu
/bnpl/external/is-eligible
Initialization
Called while the merchant lists its payment methods, to decide whether BNPL is shown to the customer.
The customer is identified by phone number or email address, at least one of them is required
Nothing is created in the backend as a result of this call
No reason is given when the customer is not eligible

Request

Authorization
API Key
Add parameter in header
X-Api-Key
Example:
X-Api-Key: ********************
or
Query Params

Responses

🟢200OK
application/json
Bodyapplication/json

🟠400Neither phone nor email was given
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://gateway-staging.instacash.hu/bnpl/external/is-eligible?phone=36301234567&email=email%40domain.com' \
--header 'X-Api-Key: <api-key>'
Response Response Example
{
    "eligible": true
}
Previous
Initialization
Next
Check whether an application already exists for this cart
Built with