API reference

Webhook event: payment.succeeded

The payment.succeeded webhook fires when a scheduled repayment settles. Its data.object is a payment. A typical handler will reconcile the payment and update the balance once the signature is verified. Because delivery is <a href="/reference/webhook-delivery-and-retries/">at-least-once</a>, process it <a href="/glossary/idempotency-explained/">idempotently</a> on the event id.

2 min read

paymentdata.object type
at-least-onceDelivery
evt_…Dedup on event id

When it fires

payment.succeeded is emitted when a scheduled repayment settles. It fires once per occurrence; a redelivery of the same occurrence carries the same event id.

If your endpoint does not return a 2xx within the timeout, delivery is retried on an exponential backoff schedule — see Webhook delivery and retries. Design your handler to be idempotent so a redelivered event is safe to process twice.

Example delivery

{
  "id": "evt_PAYM7X",
  "type": "payment.succeeded",
  "created": "2026-08-04T02:00:00Z",
  "livemode": true,
  "api_version": "2026-07-01",
  "data": {
    "object": {
      "id": "pay_7M3X1",
      "loan_id": "loan_2K9P4",
      "amount": 2200,
      "currency": "GBP",
      "status": "succeeded",
      "settled_at": "2026-08-04T02:00:00Z"
    }
  }
}

Handling it

A common handler will reconcile the payment and update the balance. Verify the signature first, acknowledge with 200 within 10 seconds, then do the work asynchronously. The underlying resource is the same shape the get loyalty tiers endpoint returns, so you can re-fetch current state if you need it.

Frequently asked questions

Can payment.succeeded arrive more than once?

Yes. At-least-once delivery means a redelivery is possible after a slow acknowledgement or a retry. Deduplicate on the event id — see idempotency.

Is data.object the live payment?

It is a snapshot taken when the event fired. If the payment may have changed since, re-fetch it from the API for the authoritative current state.

Funding for UK limited companies

Credicorp lends to your company, not to you personally — short-term working capital with no personal guarantee. See what your business could access.