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

Create a BNPL application

STAGING Gateway
https://gateway-staging.instacash.hu
STAGING Gateway
https://gateway-staging.instacash.hu
POST
https://gateway-staging.instacash.hu
/bnpl/external/application
This call will:
Create a BnplApplication (in a temporary state)
Create a BnplDeal and generate the Transactions
Create a BnplPurchase, save the kosártartalom
Return a public identifier, required for the first login

Request

Authorization
API Key
Add parameter in header
X-Api-Key
Example:
X-Api-Key: ********************
or
Body Params application/jsonRequired

Examples

Responses

🟢201Created
application/json
OK
Body

🟠400Bad Request
🔴500Internal Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://gateway-staging.instacash.hu/bnpl/external/application' \
--header 'X-Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "offerId": 0,
    "checkoutId": "string",
    "totalAmount": 1,
    "companyVatNumber": "string",
    "customerId": "string",
    "customerFirstName": "string",
    "customerLastName": "string",
    "customerEmail": "string",
    "customerPhone": "string",
    "financier": "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"
    },
    "orderId": "string",
    "prepaymentInvoiceId": "string",
    "finalInvoiceId": "string",
    "invoiceId": "string",
    "redirectUrl": "string",
    "shoppingMode": "IN_STORE",
    "items": [
        {
            "identifier": "string",
            "externalId": "string",
            "name": "string",
            "price": 1,
            "quantity": 1,
            "thumbnail": "string",
            "description": "string"
        }
    ]
}'
Response Response Example
201 - Example 1
{
    "publicId": "string",
    "customerId": "string",
    "applicationId": 0,
    "dealId": 0,
    "purchaseId": 0,
    "created": "2019-08-24T14:15:22Z",
    "isPreScore": true,
    "shoppingMode": "IN_STORE",
    "status": "string",
    "flowPosition": "string"
}
Previous
Runs a calculation on a cart amount
Next
Cancel an ongoing Application
Built with