Payment Channel API

API Docs (Production)

important

For full OpenAPI reference and live testing, see https://api.blikk.tech/paymentchannel/docs.

Service Purpose

The Payment Channel API is designed for merchant backends to transfer funds from a merchant's bank account to a creditor's bank account.

Contact

For implementation help or questions, contact hello@blikk.tech

Key APIs / Endpoints

• POST /payment: Create payment
• GET /payment/{paymentId}: Get payment status
• GET /docs: API docs UI
• GET /openapi.json: OpenAPI schema

Status Lifecycle

Status	Meaning
DRAFT	Created but not yet initialized
PENDING	Initialized and currently processing
SCA_REQUIRED	User must complete SCA at redirectUrl
SUCCESS	Completed successfully
CANCELLED	Cancelled before completion
REJECTED	Rejected by bank/provider
ERROR	Failed due to a processing error

Terminal statuses: SUCCESS, CANCELLED, REJECTED, ERROR.

Getting Started

1. Obtain API key from Blikk
2. Use HTTPS endpoints
3. Include Api-Key header in every request

Authentication

All endpoints require an API key tied to a payment channel:

Api-Key: your-api-key-here

Error Cases

Status	Typical Cause
400 Bad Request	Validation error, missing required field, or invalid payment-channel account configuration.
401 Unauthorized	Missing or invalid Api-Key.
403 Forbidden	Payment exists but belongs to a different payment channel.
404 Not Found	Payment is not a PaymentChannel payment type.
500 Internal Server Error	Unexpected server-side failure.

Implementation Tips

• Treat Api-Key as mandatory on every call.
• Prefer using creditor.iban when available.
• Do not send debtorBban if the channel is known to have a configured account.
• After receiving id, poll GET /payment/{id} until terminal state.

Security Notes

Keep credentials server-side only. Do not embed API keys in frontend code, mobile binaries, logs, screenshots, or support tickets.