Overview
Creative Payments takes bank and coin payments for you. Your server creates a payment with one API call, the buyer pays on a hosted checkout or with a method you offer yourself, and a signed webhook tells your server when the payment is paid, fails or expires.
On this page
Start here
- QuickstartAPI keys, your first test payment and your first webhook, step by step.
- Hosted checkoutOne call, one link: the buyer picks a method and pays on a hosted page.
- Direct payment APIShow the methods in your own picker and start the payment yourself.
- SubscriptionsCharge a buyer the same amount on a fixed schedule.
- WebhooksSigned events for payments, payouts and subscriptions.
- API referenceEvery endpoint and object, generated from the OpenAPI document.
How a payment works
- Your server creates a payment:
POST /v1/paymentswith the price, a description and areturn_url. - The buyer pays: on the
checkout_urlof the payment, or with a method you list and select through the direct API. - The payment moves to a final status, and your webhook endpoint receives a signed
payment.paid,payment.failedorpayment.expiredevent. - Your server reads the payment with
GET /v1/payments/{id}and acts on the status the API returns, for example by fulfilling the order.
Read Payment status for every status and what moves a payment between them.
Before you start
- Access is by request. Ask for access on the home page; an account exists only once the operator has created it.
- You work with two kinds of API key, test and live, which you create in your dashboard. See Authentication.
- You need a server that keeps the API key secret and an HTTPS endpoint that can receive webhooks. The API is not meant to be called from a browser.
Resources
- The OpenAPI 3.1 document of the API, served at
/api/v1/openapi.json. Use it to generate a client in your language. - The API reference, rendered from that same document.
- Go-live checklist: what to check before you switch to a live key.