Base URL
Production
https://stixbnk.com
Authenticated requests: header X-API-Key: YOUR_API_KEY
Open banking routing + invoicing & payment links. Hosted checkout is always returned as checkout_url.
Collections
POST
/api/v1/payments/merchant/requests
Auth
Returns payment_request_id + checkout_url. Creditor IBAN is platform-managed.
Required (body)
| Field | Type | Description |
|---|---|---|
amount | number | Major units, > 0 |
currency | string | EUR or GBP |
market | string | ISO country for OB routing (e.g. FR). GBP requires GB |
reference | string | Globally unique business reference |
product_name | string | Line item label (max 255). Or product.product_name |
Optional (body)
| Field | Type | Description |
|---|---|---|
sandbox | boolean | true = local simulator; false/omit = live providers |
description | string | Human-readable description |
locale | string | Provider locale (e.g. fr_FR) |
language | string | Short code (en, fr) |
customer_email | string | Payer email |
customer_first_name | string | Payer first name |
customer_lastname | string | Payer last name |
store_name | string | Store / brand label |
success_url | url | Absolute success redirect (alias urlok) |
failure_url | url | Absolute failure redirect (alias urlko) |
Invoices
GET
/api/v1/invoices
Auth
Optional (query)
| Field | Type | Description |
|---|---|---|
status | string | Filter: draft, sent, paid, void, overdue, expired |
POST
/api/v1/invoices
Auth
Required (body)
| Field | Type | Description |
|---|---|---|
customer | object | name, email required |
line_items | array | [{description, quantity, unit_amount, tax_rate_percent}] |
Optional (body)
| Field | Type | Description |
|---|---|---|
currency | string | Default EUR |
market | string | Default FR |
due_at | string | Due date |
notes | string | Free text |
sandbox | boolean | Same semantics as collection |
issue | boolean | Create payment link immediately (alias send) |
GET
/api/v1/invoices/item.php
Auth
Required (query)
| Field | Type | Description |
|---|---|---|
id | integer | Invoice id |
Optional
None
POST
/api/v1/invoices/item.php
Auth
Required (query)
| Field | Type | Description |
|---|---|---|
id | integer | Invoice id |
Required (body)
| Field | Type | Description |
|---|---|---|
action | string | update, send, issue, email, or void |
Optional
Extra fields for action=update (customer, line_items, meta)
Webhooks
POST
your endpoint
Outbound
Configure in Merchant → Webhooks. Event open_banking.collection.updated. Header X-Webhook-Signature = hex HMAC-SHA256 of the raw body.
Envelope
| Field | Type | Description |
|---|---|---|
id | string | Event id |
type | string | open_banking.collection.updated |
created | integer | Unix timestamp |
data | object | Includes payment_request_id, reference, amount, currency, collection_status, sandbox, … |