API Reference
Complete reference for the FlowAlp Pay REST API: authentication, Gateway, Paylink, Transaction, Subscription, Payout and payment method endpoints, with request and response examples.
API Reference
Merchant API overview
FlowAlp Pay Merchant API overview: base URL and versions, authentication, request format, main resources, errors and rate limits.
API Reference
API versions and changelog
How FlowAlp Pay API versioning works: supported versions v1.14 to v1.16, pinning a version, upgrade guidance and per-version changelog.
API Reference
Merchant API authentication
Authenticate FlowAlp Pay Merchant API requests with the x-api-key header or the ApiSignature HMAC-SHA256 parameter, with code examples.
API Reference
Request format
FlowAlp Pay Merchant API request format: URL structure, JSON and form-urlencoded bodies, HTTP verbs, amounts in minor units, examples.
API Reference
Merchant API errors
HTTP status codes of the FlowAlp Pay Merchant API, the JSON error response shape, and practical retry guidance with exponential backoff.
API Reference
Merchant API rate limits
FlowAlp Pay Merchant API rate limits: 600 requests per 5 minutes, 405/403 signals under load, and a retry strategy with backoff.
API Reference
SignatureCheck: verify API credentials
Validate your FlowAlp Pay API credentials and signature calculation with the SignatureCheck endpoint — curl and PHP examples included.
API Reference
Create a Gateway
Create a hosted FlowAlp Pay checkout with POST /Gateway/. Full parameter table, curl and PHP SDK examples, response fields and error codes.
API Reference
Retrieve a Gateway
Retrieve a FlowAlp Pay Gateway by ID to check its payment status (waiting, confirmed, authorized, reserved). curl and PHP SDK examples.
API Reference
Delete a Gateway
Delete a FlowAlp Pay Gateway by ID with the Merchant API: DELETE /Gateway/{id}/ request, curl and PHP SDK examples, response and errors.
API Reference
Create a Paylink
Create a FlowAlp Pay Paylink with POST /Invoice/: a hosted payment link to share by email or QR code. Parameters, examples and errors.
API Reference
Retrieve and list Paylinks
Retrieve a FlowAlp Pay Paylink by ID with GET /Invoice/{id}/ and verify its payment. curl and PHP SDK examples, response fields, errors.
API Reference
Update and delete a Paylink
Delete a FlowAlp Pay Paylink with DELETE /Invoice/{id}/ and learn how to replace one when parameters change. curl and PHP SDK examples.
API Reference
List and retrieve Transactions
List and filter FlowAlp Pay transactions or retrieve a single one by ID, with all transaction status values explained for the Merchant API.
API Reference
Charge, capture, refund and cancel Transactions
Charge tokenized payments, capture reservations, refund fully or partially and cancel waiting transactions with the FlowAlp Pay API.
API Reference
Subscriptions API
Create, retrieve, update and cancel FlowAlp Pay subscriptions via API, with recurring billing intervals, periods and VAT parameters.
API Reference
Payouts API
List FlowAlp Pay payouts and retrieve a single payout with its transactions, fees and bank reference to reconcile your settlements.
API Reference
Payment providers and method identifiers
Query the payment providers configured for your FlowAlp Pay account and look up all payment method identifiers such as TWINT or Visa.