API Browser
Try it live!
 

Table of Contents

Getting started
Content-type
Accept language
Query parameters
WebHooks
App code blocks
App payment service provider
Resources
Error codes
Webhook Events
Static App code blocks
Interactive App code blocks
App PSP Transactions

API Documentation

Resources

Error codes

WebHook Events

Below are the available WebHook Events. A WebHook can only be created on one of these events. The Payload that is posted is described here.

Static code block placeholders

A static code block with display the code at the placeholder 'as is'. This snippet can contain HTML, CSS and/or JavaScript.

Interactive code block payloads

When an interactive code block posts a view the response is described in 'View'.

Interactive code block placeholders

The property payload depends on the placeholder from which it's posted. Below you can find the payloads corresponding with the placeholders.

App Payment Service Provider - Transaction

The transaction entity is used in all requests concerning a payment with an App Payment Service Provider. When a consumer chooses the App PSP and finalizes the order, the webshop will POST a transaction entity to the App PSP endpoint. As a response the webshop requires that same entity with extra corresponding info. The App PSP should return a status and possible a pay_url.

When the consumer returns back to the webshop or if the webhook_url is called, the webshop will GET a status request. As a response the webshop requires a transaction entity.