Skip to main content

API Reference Overview

Complete reference for the Pelago REST API.

Base URL​

EnvironmentURL
Productionhttps://api.pelago.tech/v1
Sandboxhttps://api.sandbox.pelago.tech/v1

Authentication​

curl https://api.pelago.tech/v1/payments \
  -H "Authorization: Bearer pk_live_xxxxx" \
  -H "X-Api-Secret: sk_live_xxxxx"

Response Format​

All responses are JSON:

{
  "id": "pay_abc123",
  "object": "payment",
  "status": "completed",
  ...
}

Pagination​

{
  "object": "list",
  "data": [...],
  "hasMore": true,
  "totalCount": 100
}

Errors​

{
  "error": {
    "type": "invalid_request_error",
    "code": "missing_parameter",
    "message": "The 'amount' parameter is required"
  }
}

Endpoints​

Payments​

MethodEndpointDescription
POST/paymentsCreate payment
GET/payments/:idGet payment
GET/paymentsList payments
POST/payments/:id/cancelCancel payment

Refunds​

MethodEndpointDescription
POST/refundsCreate refund
GET/refunds/:idGet refund
GET/refundsList refunds

Settlements​

MethodEndpointDescription
GET/settlementsList settlements
GET/settlements/:idGet settlement

Webhooks​

MethodEndpointDescription
POST/webhooksCreate webhook
GET/webhooksList webhooks
DELETE/webhooks/:idDelete webhook

Rate Limits​

PlanLimit
Sandbox100/min
Starter500/min
Business2000/min

See REST API Reference for detailed documentation.