API changelog
What changed in the API and when, for those who have integrated with it.
Everything that changes the behaviour of the API for an integrator goes here: a new endpoint, a new field, a new error code or rule, a changed limit.
How to read the changelog
- Compatible changes are released without a version change: a new endpoint, a new optional request field, a new response field, a new error code or a new value of
details.rule. A client must skip unknown response fields and handle an unknown error code by its HTTP status. - Incompatible changes are not made in version
v1: a removed or renamed endpoint or field, a field that changed its meaning or type, a required field that did not exist before. Such a change is released as a new version next to the old one, and an entry about it appears here in advance.
Entries go from newest to oldest.
2026-11-17
Payment page, notifications, refunds and payouts.
GET /api/v1/payments?reference=…: a payment by order number. Withoutreferencethe path answers 501; a key is required here too.POST /api/v1/payments/:id/refunds,GET /api/v1/payments/:id/refundsandGET /api/v1/payments/:id/refunds/:refundId: refunds.- New payment fields
pageUrl(payment page) andrefundedMinor, and therequisitetype ofactionwith payment details;fieldsOnPagein the creation body. - Notifications
payment.updatedandrefund.updated, signed per Standard Webhooks. - When the installation has a payment page,
returnUrlis accepted only from the merchant's list of allowed origins (rulereturn_url_not_allowed). New payment creation rules:fields_on_page_conflict,pay_page_unavailable,fields_on_page_ttl_too_short. - Creating refunds and reading refunds have rate limits of their own.
- Creating a refund: API key, merchant and environment errors with a correct secret (401 and 403) take the retry key, like a 409 error (a revoked or expired API key only for a day after the key ended); everything that is not an answer is a 503
dependency_unavailablewith the rulestransaction_timeout,transaction_conflict,idempotency_unrecorded,keyring_unavailable,idempotency_key_unverifiable: Refunds. callbackUrlin the body of payment and refund creation: the notification address of that object instead of the environment address, like Corefy'scallback_url; returned on read. The notification address port (the environment address too) is only the default, 443, 8443, 80 or 8080. Refusal rulescallback_url_invalid,callback_url_scheme,callback_url_internal,callback_secret_missing: Address in the request.POST /api/v1/notifications/secret: issue the notification signing secret with an API key if there is none yet (otherwise 409notify_secret_exists).- Employees decide the outcome of a manual refund and of a refund whose outcome the provider has not named or named contradictorily:
SUCCEEDEDorFAILEDwith the reasonoperator_declined. A refund for which the provider returned a different amount staysPENDINGwithinReview: trueuntil it is corrected manually. After an employee decision on a refund through the API, a provider that can be asked for the refund status is asked again up to 90 days after creation and at least three days after the decision, and a disputed answer givesinReview: truewith the same status: Refunds. - The
REJECTEDpayment status: rejected on our side before reaching the provider, with no attempt. Reasonscustomer_blocked,firewall_blocked,rule_declined. POST /api/v1/payouts,GET /api/v1/payouts/:idandPOST /api/v1/payouts/:id/cancel: payouts in the test environment, reference. TheIdempotency-Keyheader is required, a refusal on the merits takes the key, and a 5xx response is not a refusal. Payouts are not sent yet: an approved payout staysCREATEDand can be cancelled. Live payouts are closed (rulelive_payouts_closed).error.messageis in English on every error. Codes, rules anddetailsare unchanged: Errors.- Payouts to an IBAN: the bank transfer service accepts
beneficiary.iban, the account country is the first two letters of the IBAN. A payout to a bank account blocked within the merchant is created rejected with the reasoncustomer_blocked. A well-formed IBAN of the wrong length for its country, in a payment or a payout, gets 422identifier_invalid. - The
payout.updatednotification about a payout, signed like the payment and refund notifications: Notifications. callbackUrlin the payout creation body: the address forpayout.updatednotifications of this payout instead of the environment address, as for payments and refunds (Address in the request); the create, read and cancel responses returncallbackUrl; a malformed address gets 400 with the rulecallback_url_invalid,callback_url_schemeorcallback_url_internal; without an environment secret 409callback_secret_missing, and the refusal takes the retry key.
2026-11-13
Payment intake.
POST /api/v1/payments: create a payment; a retry with theIdempotency-Keyheader is safe: Retrying a request.GET /api/v1/payments/:id: read a payment and learn its outcome: Accepting a payment.- The error codes
validation_failed,bad_amount,conflict,identifier_invalid,keyring_unavailableanddependency_unavailable: they are described in the reference under the creation endpoint. - Creating and reading payments have rate limits of their own: Limits.
- Live intake is closed; in the test environment test data sets the outcome.
GET /api/v1/payments, the payment list, stays reserved.
2026-11-12
The first release of the public API.
- Sign-in with an API key: Authentication.
GET /api/v1/me: key check.GET /api/v1/services: the services the merchant can accept a payment with in the key's environment.- The common error shape and the request rate limit.
- The paths
POST /api/v1/payments,GET /api/v1/payments/:idandGET /api/v1/paymentsare reserved.
Clarifications made the same day, before the first integrations:
- the key's label is removed from the
GET /api/v1/meresponse: it is an administrator's note, visible only in the console; - the
Basicscheme is accepted only with an empty password; - if a key has several reasons to be rejected, one is named, in this order: revocation, expiry, disabling.