BNPL API
Redirect URLsFAQ
BNPL API
Redirect URLsFAQ
milpay doc
  1. BNPL API
  • 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. BNPL API

Initialization

Check whether BNPL can be offered to a customer
GET/bnpl/external/is-eligible
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 e...
Check whether an application already exists for this cart
POST/bnpl/external/prepared-application-check
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 re...
Query the available offers for the merchant
GET/bnpl/external/available-offers
Gets basic data on the offers available to use. Merchant is identified from the API Key
Run a calculation on a cart amount
GET/bnpl/external/calculation/{offerId}
This is a GET because nothing is created in the backend as a result of this call Returns the installment details
Create a BNPL application
POST/bnpl/external/application
This call will: Create a BnplApplication (in a temporary state) Create a BnplDeal and generate the Transactions Create a BnplPurchase, save the kosár...
Cancel an ongoing Application
DELETE/bnpl/external/application/{id}
Used to cancel an application
Next
Check whether BNPL can be offered to a customer
Built with