DigiCarl Pay

Quickstart API reference

Loading the API reference

Getting started

Quickstart
Authentication
Errors
Rate limits
Idempotency

Payments

GETList payment intents
POSTCreate a payment intent
GETRetrieve a payment intent

Payouts

GETList payouts
POSTPrepare a payout
GETRetrieve a payout with its attempts and provider references

Refunds

GETList refunds
POSTPrepare a refund
GETRetrieve a refund

Webhooks

GETList webhook delivery attempts
GETGet the current webhook endpoint
POSTRegister the webhook endpoint
Signed events
Event types

Webhooks

Get the current webhook endpoint

GET/v1/webhook_endpoints

Responses

200Zero or one current endpoint
400Invalid request
401Missing, invalid or revoked API key
429More than 100 requests in this minute for this keyRetry-After
500Internal error

Error bodies and every code are listed under Errors; limits under Rate limits and Idempotency.

Request

curl http://localhost:3000/api/v1/webhook_endpoints \
  -H "Authorization: Bearer $DCP_KEY"

Response

{
  "object": "list",
  "data": [
    {
      "id": "we_01JB8Q4Z2N5V7K3M9P6R0T1W8X",
      "object": "webhook_endpoint",
      "url": "https://example.co.ke/webhooks/digicarl",
      "livemode": false,
      "status": "active",
      "secret_last4": "secret last4",
      "created_at": "2026-10-22T09:30:00.000Z"
    }
  ]
}

Try it

Sandbox key

Paste a sandbox key to send real sandbox requests.