Changelog
The API's versions and every change under them, and the SDKs' releases.
On this page
An API version is a date, and 2026-11-01 is the only one. Every event names the version its body
follows, in api_version.
- A new version comes only with a breaking change: removing or renaming an operation, a field or
an event type, a new required field, changing a field's type or meaning, or refusing a request
that was valid.
/v1never breaks in place. - Compatible changes land in place, dated below under the version they extend: new operations, new optional fields in requests, new fields in responses, new event types, new values of an enum, new error codes, and new networks and assets. Accept what you don't know, as the SDKs do.
API versions#
Version 2026-11-01
Added
Subscriptions
Plans priced in a currency or in one asset, with free trials; subscriptions billed by an invoice each period, paid by ordinary payments that carry their invoice and subscription, with reminders, a grace period and dunning; the subscriber's page; the subscription.* and invoice.* events; the sandbox's controls to move a subscription along its schedule and to pay an invoice. New errors: plan_archived, subscription_canceled, invoice_not_payable, subscription_limit and emails_unavailable.
Added
The first version of the API
Payments priced in an asset or in USD or EUR, followed from waiting to finished, with underpayments, overpayments and late payments; payment links with fixed and open prices, donations and branding; rates, estimates and minimums; balances, payout destinations, payouts, batches and forwarding; refunds; the sandbox's controls; webhooks for payments, payouts, refunds, destinations and batches, signed and retried. Every POST takes an idempotency key, lists page by ID, amounts are decimal strings, and errors are problem details with a stable code.
39 operations
- getStatus
- listAssets
- createPayment
- getPayment
- listPayments
- listRates
- getEstimate
- getMinAmount
- createPaymentLink
- getPaymentLink
- updatePaymentLink
- listPaymentLinks
- createLogo
- listBalances
- createPayoutDestination
- getPayoutDestination
- listPayoutDestinations
- disablePayoutDestination
- createPayout
- getPayout
- listPayouts
- cancelPayout
- createPayoutBatch
- getPayoutBatch
- listPayoutBatches
- getForwarding
- setForwarding
- createRefund
- getRefund
- listRefunds
- cancelRefund
- simulatePayment
- simulatePayout
- activatePayoutDestination
- paymentEvent
- payoutEvent
- refundEvent
- destinationEvent
- batchEvent
The SDKs#
Each SDK follows semantic versioning, names the API version it was made for, and keeps its own changelog beside its code.
| SDK | Version | Released | For the API's version |
|---|---|---|---|
| TypeScript | 0.1.0 | not yet published | 2026-11-01 |
| Python | 0.1.0 | not yet published | 2026-11-01 |
| PHP | 0.1.0 | not yet published | 2026-11-01 |