Sign in

v20

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-214885191.3 KB
Payment Intents

Process payment intent after client-side confirmation

Processes a payment intent that has been confirmed on the client side. Polls the database for payment intent status to become succeeded. Returns the current status of the payment intent; on success, the response is enriched with the Purchase row created by the webhook handler.

post/v1/sdk/payment-intents/{processorPaymentId}/process

Path parameters

processorPaymentIdstring required
Example:pi_1a2b3c4d5e6f7g8h

Payment processor ID returned from createPaymentIntent

Request body

customerRefstring required
planRefstring
productRefstring

Response

Payment intent status with optional purchase enrichment on success

OR
OR
OR
OR
OR
OR

Example response

{
  "purchase": {
    "amount": 9900,
    "cancellationReason": "Customer request",
    "cancelledAt": "2025-10-28T10:00:00Z",
    "currency": "GBP",
    "endDate": "2025-11-27T10:00:00Z",
    "exchangeRate": 1.32,
    "originalAmount": 7500,
    "planRef": "pln_abc123",
    "productName": "API Gateway Manager",
    "productRef": "prd_abc123",
    "reference": "pur_1A2B3C4D",
    "startDate": "2025-10-27T10:00:00Z",
    "status": "active"
  },
  "status": "succeeded",
  "type": "recurring"
}