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 an application already exists for this cart

STAGING Gateway
https://gateway-staging.instacash.hu
STAGING Gateway
https://gateway-staging.instacash.hu
POST
https://gateway-staging.instacash.hu
/bnpl/external/prepared-application-check
Initialization
Takes the same body as Create a BNPL application, so the order button can send the very same request here first.
customerPhone or customerEmail is required
An open application of the customer at the merchant counts as existing when its total and items are the same (the order of the items does not matter)
If the status is EXISTS, the order button must send the customer to the returned application instead of creating a new one
Nothing is created in the backend as a result of this call

Request

Authorization
API Key
Add parameter in header
X-Api-Key
Example:
X-Api-Key: ********************
or
Body Params application/jsonRequired

Examples

Responses

🟢200OK
application/json
Bodyapplication/json

🟠400Invalid request
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://gateway-staging.instacash.hu/bnpl/external/prepared-application-check' \
--header 'X-Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "offerId": 0,
    "checkoutId": "string",
    "totalAmount": 1,
    "companyVatNumber": "string",
    "customerId": "string",
    "customerFirstName": "string",
    "customerLastName": "string",
    "customerEmail": "string",
    "customerPhone": "string",
    "financier": "string",
    "billingAddress": {
        "country": "st",
        "city": "string",
        "region": "st",
        "zip": "string",
        "street": "string",
        "street2": "string",
        "street3": "string"
    },
    "shippingAddress": {
        "country": "st",
        "city": "string",
        "region": "st",
        "zip": "string",
        "street": "string",
        "street2": "string",
        "street3": "string",
        "fullName": "string"
    },
    "orderId": "string",
    "prepaymentInvoiceId": "string",
    "finalInvoiceId": "string",
    "invoiceId": "string",
    "redirectUrl": "string",
    "failureRedirectUrl": "string",
    "shoppingMode": "IN_STORE",
    "paymentSessionId": "string",
    "shop": "string",
    "bookingStartDate": "string",
    "items": [
        {
            "identifier": "string",
            "externalId": "string",
            "name": "string",
            "price": 1,
            "quantity": 1,
            "thumbnail": "string",
            "description": "string"
        }
    ]
}'
Response Response Example
{
    "status": "EXISTS",
    "application": {
        "publicId": "string",
        "customerId": "string",
        "applicationId": 0,
        "dealId": 0,
        "purchaseId": 0,
        "created": "2019-08-24T14:15:22.123Z",
        "isPreScore": true,
        "shoppingMode": "IN_STORE",
        "status": "CREATED",
        "flowPosition": "string"
    }
}
Previous
Check whether BNPL can be offered to a customer
Next
Query the available offers for the merchant
Built with