API reference
Generated from the committed OpenAPI document for version 2026-09-01. Every field, enum and example below is what the server accepts.
checkout
payments
POSTCancel Payment
/api/v1/payments/{id}/cancelPOSTCancel Refund/api/v1/refunds/{id}/cancelPOSTCreate Payment/api/v1/paymentsGETGet Payment/api/v1/payments/{id}GETGet Refund/api/v1/refunds/{id}GETList Payments/api/v1/paymentsGETList Refunds/api/v1/refundsPOSTRequest Refund/api/v1/payments/{id}/refundsPOSTStart Attempt/api/v1/payments/{id}/attemptstestkit
POSTAdvance Clock
/api/v1/test/clock/advancePOSTCreate Webhook Sink/api/v1/test/webhooks/sinksDELETEDelete Webhook Sink/api/v1/test/webhooks/sinks/{id}GETGet Webhook Sink/api/v1/test/webhooks/sinks/{id}GETList Sink Deliveries/api/v1/test/webhooks/sinks/{id}/deliveriesGETList Testkit Actions/api/v1/test/actionsGETList Webhook Sinks/api/v1/test/webhooks/sinksPOSTPurge Test Data/api/v1/test/dataPOSTSeed Test Data/api/v1/test/seedPOSTSimulate Payment/api/v1/test/payments/{id}/simulatePOSTSimulate Payout/api/v1/test/payouts/{id}/simulatePOSTSimulate Refund/api/v1/test/refunds/{id}/simulatePOSTSimulate Settlement/api/v1/test/settlements/simulatePATCHUpdate Webhook Sink/api/v1/test/webhooks/sinks/{id}Schemas
AdvanceReport4 fieldListEnvelope_Payment3 fieldListEnvelope_PaymentLink3 fieldListEnvelope_Refund3 fieldListEnvelope_TestkitAction3 fieldListEnvelope_WebhookSink3 fieldListEnvelope_WebhookSinkDelivery3 fieldMoney2 fieldPayment20 fieldPaymentLink20 fieldProblem11 fieldRefund9 fieldResetReport10 fieldSeedReport7 fieldSimulateResult7 fieldTestkitAction14 fieldWebhookSink9 fieldWebhookSinkDelivery15 field