InstaCash API
BNPL APIExamples
BNPL APIExamples
  1. Hook
  • Initialization
    • Queries the available offers for the merchant
      GET
    • Runs 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
  • One Click
    • /api/bnpl/external/one-click/calculation
      POST
    • /api/bnpl/external/one-click/approve
      POST
    • /api/bnpl/external/one-click/application
      POST
  • Hook
    • Called when a status update happens on a deal or application
  1. Hook

Called when a status update happens on a deal or application

Webhook
POST
configured-webhook-uri
THIS IS AN OUTGOING REQUEST NOT AN ENDPOINT
The entire url of this call can (must) be configured for each merchant,
no path or query is added, the "/configured-webhook-uri" will be replaced
Ideally, the url should be absolute, ex.: "https://www.mici-shop.hu/instacash/bnpl-hook"

Request

Body Params application/jsonRequired

Examples

Responses

🟢200OK
Responses are ignored
This response does not have a body.
🟠400Bad Request
🔴500Internal Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://your-api-server.com' \
--header 'Content-Type: application/json' \
--data-raw '{
    "application": {
        "offerId": "string",
        "id": "string",
        "publicId": "string",
        "dealId": 0,
        "purchaseId": 0,
        "financier": "string",
        "interest": 0,
        "thm": 0,
        "installments": 0,
        "status": "CREATED",
        "statusResult": "SUCCESS",
        "lastStatusChange": "2019-08-24T14:15:22Z"
    },
    "deal": {
        "id": "string",
        "applicationId": 0,
        "financier": "string",
        "purchaseId": 0,
        "downPayment": 0,
        "downPaymentValue": 0,
        "serviceFee": 0,
        "latenessThreshold": 0,
        "commission": 0,
        "status": "PREPARED",
        "lastStatusChange": "2019-08-24T14:15:22Z",
        "transactions": [
            {
                "seq": 0,
                "dueDate": "2019-08-24T14:15:22Z",
                "sum": 1,
                "fee": 0,
                "latenessFee": 0,
                "commission": 0,
                "isLate": false,
                "status": "DUE",
                "transactionUuid": "f5a0721f-e854-4a76-906e-a7c208fb2ac8",
                "attempts": [
                    {
                        "sum": 1,
                        "timestamp": "2019-08-24T14:15:22Z",
                        "result": "SUCCESS",
                        "finishedAt": "2019-08-24T14:15:22Z",
                        "statusUpdatedAt": "2019-08-24T14:15:22Z",
                        "resultReason": "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"
        }
    },
    "purchase": {
        "id": "string",
        "dealId": 0,
        "applicationId": 0,
        "orderId": "string",
        "checkoutId": "string",
        "totalAmount": 1,
        "prepaymentInvoiceId": "string",
        "finalInvoiceId": "string",
        "invoiceId": "string",
        "items": [
            {
                "identifier": "string",
                "externalId": "string",
                "name": "string",
                "price": 1,
                "quantity": 1,
                "thumbnail": "http://example.com"
            }
        ]
    }
}'
Previous
Hook
Built with