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 Deals

STAGING Gateway
https://gateway-staging.instacash.hu
STAGING Gateway
https://gateway-staging.instacash.hu
GET
https://gateway-staging.instacash.hu
/bnpl/external/deal
Get listing data on all deals 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/deal?financier' \
--header 'X-Api-Key: <api-key>'
Response Response Example
200 - Example 1
[
    {
        "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"
        }
    }
]
Previous
Get data of specific Purchase
Next
Get data of Deal
Built with