InstaCash API
BNPL APIExamples
BNPL APIExamples
  1. Querying
  • 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. Querying

Get a listing of all BNPL Purchases

STAGING Gateway
https://gateway-staging.instacash.hu
STAGING Gateway
https://gateway-staging.instacash.hu
GET
https://gateway-staging.instacash.hu
/bnpl/external/purchase
Get listing data on all purchases of the merchant

Request

Authorization
API Key
Add parameter in header
X-Api-Key
Example:
X-Api-Key: ********************
or
Query Params

Responses

🟢200OK
application/json
OK
Body

🔴500Internal Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://gateway-staging.instacash.hu/bnpl/external/purchase?financier' \
--header 'X-Api-Key: <api-key>'
Response Response Example
200 - Example 1
[
    {
        "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
Get the current status of a BNPL Application
Next
Get data of specific Purchase
Built with