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

Application Statuses

StatusStatus (Webshop)Description
CREATEDOrder pendingThe customer placed the order and the installment payment application was created
INITIALOrder pendingThe customer started the installment payment process and is at the onboarding step
STARTEDOrder pendingThe customer started the installment payment process
EMAIL_CONFIRMOrder pendingWaiting for the customer to confirm their e-mail address
CANCELLEDOrder canceled / closedThe installment payment application was closed at the request of the customer or milpay
UNDER_REVIEWOrder pendingDuring scoring / manual override
APPROVEDOrder pendingThe installment payment application was approved during the credit assessment
HIGH_RISK_KYCOrder pendingAdditional identity verification (KYC) after the credit assessment, for high-risk carts
CONTRACT_CHECKOrder pendingThe customer is reviewing the installment payment contract
DOC_SIGN_STARTEDOrder pendingThe customer started the contract signing process
SIGNEDOrder pendingThe customer signed the contract
COMPANY_AUTHORIZEDOrder pendingB2B: verification of the company's authorized signatory
B2B_KYCOrder pendingB2B: identity verification (KYC)
B2B_EMAIL_CONFIRMOrder pendingB2B: waiting for the e-mail address confirmation
B2B_PSD2Order pendingB2B: bank account data (PSD2) sync
COMPLETEDOrder paid (first payment received)The installment payment application process was completed and the customer paid the initial payment. Only hand over / ship the goods when the deal status is INITIAL_PAYMENT_COMPLETED - always check the deal status, not only the application status.
DENIEDOrder canceled / closedThe installment payment application was rejected during the credit assessment
INTERRUPTEDOrder canceled / closedThe installment payment application was closed on the milpay side
SCORINGOrder pendingThe credit assessment is in progress
REJECT_FALLBACKOrder pendingThe original construction was not approved, a fallback application with a different construction was created and offered to the customer (see fallbackApplicationId / fallbackApplicationPublicId). The order continues on the fallback application.
Previous
Status Lists
Next
Deal Statuses
Built with