API reference

Loading the interactive reference…

Endpoint index

Setup

Store enablement, keys and webhook URL.

• POST/v1/setup Enable your store

Cards

Card sessions to save or update cards. Called from your server with the secret key.

• POST/v1/card_sessions Authorise a card capture, or a saved card update, for a customer
• GET/v1/card_sessions/{id} Retrieve a card session

Payments

Payment intents. Called from your server with the secret key.

• POST/v1/payment_intents Create a payment intent
• GET/v1/payment_intents/{id} Retrieve a payment intent
• POST/v1/payment_intents/{id}/cancel Cancel a payment intent

Refunds

Full refunds of paid payment intents. Called from your server with the secret key.

• POST/v1/refunds Refund a payment intent
• GET/v1/refunds/{id} Retrieve a refund

Events

Reading events and their delivery state, resending them and sending a test webhook.

• GET/v1/events List events
• GET/v1/events/{id} Retrieve an event
• POST/v1/events/{id}/resend Resend an event
• POST/v1/webhooks/test Send a test event

Service status

Health probes of the service. No authentication required.

• GET/health Readiness probe
• GET/health/live Liveness probe

Webhook events

• card.created
• card.updated
• webhook.test
• payment_intent.succeeded
• payment_intent.payment_failed
• payment_intent.canceled
• refund.succeeded
• refund.failed