API Reference

Every endpoint below is relative to https://api.tidepay.cc/v1 and authenticates with an X-API-Key header — see Authentication.

Currencies

The chain + token catalog offers and payments are built against.

GET/currenciesList currencies

Offers

What a merchant sells, and on what terms — the single sellable resource. An offer carries its own pricing options and its own checkout URL.

GET/offersList offers POST/offersCreate an offer GET/offers/{offerId}Get an offer PATCH/offers/{offerId}Update an offer DELETE/offers/{offerId}Delete an offer POST/offers/{offerId}/pricingAdd a pricing option DELETE/offers/{offerId}/pricing/{priceId}Retire a pricing option

A merchant's registered payout wallet per token — once set for a tokenKey, it's used as the settlement destination for any offer involving that token, in place of that request's own merchantDestinationWallet.

GET/walletsList wallets POST/walletsRegister or update a wallet DELETE/wallets/{walletId}Delete a wallet

Customers

The payer — the wallet (and later, other payment credentials) that funds a subscription.

GET/customersList customers POST/customersCreate a customer GET/customers/{customerId}Get a customer PATCH/customers/{customerId}Update a customer DELETE/customers/{customerId}Delete a customer

Subscriptions

A customer's recurring relationship with an offer.

GET/subscriptionsList subscriptions POST/subscriptionsCreate a subscription GET/subscriptions/{subscriptionId}Get subscription status PATCH/subscriptions/{subscriptionId}Update a subscription POST/subscriptions/{subscriptionId}/cancelCancel a subscription POST/subscriptions/{subscriptionId}/resumeResume a subscription POST/subscriptions/{subscriptionId}/migrateMigrate to a different pricing option POST/subscriptions/{subscriptionId}/retryRetry subscription invoice cycle

Payments

Every transaction that actually happened — direct one-off pulls, one-time offer checkouts, and recurring billing cycles alike. source distinguishes them; there is no separate invoices resource.

GET/paymentsList payments POST/paymentsCreate a one-off payment GET/payments/{paymentId}Get a payment POST/payments/{paymentId}/cancelCancel a payment

Webhooks

Your delivery endpoint and the signing secret used to verify deliveries. Both are scoped to the environment of the API key you authenticate with — see the Webhooks guide.

GET/webhooks/endpointGet webhook endpoint PATCH/webhooks/endpointSet webhook endpoint GET/webhooks/secretGet signing secret status POST/webhooks/secret/rotateRotate signing secret

Sandbox

Test-mode-only tools for developing an integration.

POST/sandbox/advanceAdvance a sandbox subscription's test clock POST/sandbox/chargeForce-run a sandbox invoice cycle