BNPL API
Redirect URLsFAQ
BNPL API
Redirect URLsFAQ
instacash doc
  1. Status Lists
  • 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
    • Calculation
      POST
    • Approve
      POST
    • Application
      POST
  • Hook
    • Called when a status update happens on a deal or application
  • One Click V2 (BETA)
  1. Status Lists

Deal Statuses

StatusStatus (Webshop)Description
PREPAREDOrder pendingThe customer placed the order and the installment payment application was created, but the initial payment has not yet been paid
READYOrder pendingThe first payment is ready to be paid (contracts signed and/or credit assessment passed)
CANCELLEDOrder canceled / closedThe installment payment deal was cancelled (by the webshop, the customer, milpay or because of inactivity)
CANCELLED_FALLBACKOrder pendingCancelled because a fallback application was created; the order continues on the fallback application
INITIAL_PAYMENT_COMPLETEDOrder ready for fulfillment / invoicingThe customer paid the initial payment. Only hand over / ship the goods in this deal status - do not rely on the application status alone.
ONGOINGOrder ready for fulfillment / invoicingThe customer paid the second installment; the deal remains in this status until the final installment is paid, delayed, or the deal is closed
ONGOING_DELAYEDOrder ready for fulfillment / invoicingThe customer is overdue on one of the installments; the deal remains in this status until the overdue amount is settled or the deal is closed
COMPLETEDOrder completed, can be closedThe customer paid all installments
INTERRUPTEDOrder canceled / closedThe deal was cancelled or refunded after the initial payment

Possible Status Changes#

Previous
Application Statuses
Next
Querying
Built with