Merchant portal

Documentation

Guides and references for the direct merchant API: Open Banking collection to the platform collection account, status webhooks, and security practices.

Getting started

Merchant collection overview

Prerequisites, API keys, Pay Direct flow, and platform-managed creditor account.

Create a payment request

POST /api/v1/payments/merchant/requests, JSON body, and checkout_url to the StixBNK-hosted page (/checkout/payment/ or /checkout/sandbox/).

Product guides

Outbound webhooks

Event open_banking.collection.updated, headers, HMAC-SHA256 signature, and data fields.

User return after payment

success_url / failure_url redirects and query parameters appended to the URL.

Errors & constraints

kyb_not_approved, duplicate_reference, forbidden fields, and platform IBAN configuration.