API Reference

The HedgePayments API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes and authentication.

Base URL

All API requests should be made to:

https://api.hedgepayments.com/v1

For sandbox/testing:

https://api-sandbox.hedgepayments.com/v1

Authentication

All API requests require authentication via Bearer token:

curl https://api.hedgepayments.com/v1/users \
  -H "Authorization: Bearer YOUR_API_KEY"

See the Authentication Guide for details on obtaining and managing API keys.

Products

The HedgePayments API is organized by product:

SideBet API

Round-ups as a service

CoverPay API

BNPL payment processing

Bankroll API

Payment method & wallet

SideBet Endpoints

Endpoint	Description
`POST /sidebet/users/{id}/roundups/enable`	Enable round-ups for a user
`GET /sidebet/users/{id}/roundups/settings`	Get round-up settings
`PUT /sidebet/users/{id}/roundups/settings`	Update round-up settings
`GET /sidebet/users/{id}/roundups/pending`	Get pending round-ups
`POST /sidebet/users/{id}/roundups/transfer`	Trigger manual transfer

CoverPay Endpoints

Endpoint	Description
`POST /coverpay/prequalify`	Pre-qualify user for BNPL
`POST /coverpay/payments`	Create a CoverPay payment
`GET /coverpay/payments/{id}`	Get payment details
`GET /coverpay/payments`	List all payments
`POST /coverpay/payments/{id}/cancel`	Cancel a payment

Bankroll Endpoints

Endpoint	Description
`POST /bankroll/payments/check-eligibility`	Check if user can pay
`POST /bankroll/payments`	Process a payment
`GET /bankroll/users/{id}/balance`	Get user balance
`POST /bankroll/users/{id}/cards`	Create virtual card
`POST /bankroll/p2p/send`	Send P2P payment

Common Endpoints

These endpoints work across all products:

Endpoint	Description
`POST /users`	Create a user
`GET /users/{id}`	Get user details
`POST /wallets`	Create a wallet
`GET /wallets/{id}`	Get wallet details
`POST /webhooks`	Register webhook

Response Format

All responses are JSON with a consistent structure: Success Response:

{
  "success": true,
  "data": {
    // Response data here
  },
  "meta": {
    "requestId": "req_abc123",
    "timestamp": "2024-01-15T10:30:00Z"
  }
}

Error Response:

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_BALANCE",
    "message": "User does not have sufficient balance",
    "details": {
      "required": 50.00,
      "available": 25.00
    }
  },
  "meta": {
    "requestId": "req_abc123",
    "timestamp": "2024-01-15T10:30:00Z"
  }
}

HTTP Status Codes

Code	Description
`200`	Success
`201`	Created
`400`	Bad Request — Invalid parameters
`401`	Unauthorized — Invalid API key
`403`	Forbidden — Insufficient permissions
`404`	Not Found — Resource doesn’t exist
`409`	Conflict — Duplicate request
`422`	Unprocessable — Business logic error
`429`	Rate Limited — Too many requests
`500`	Server Error — Something went wrong

Rate Limits

Tier	Requests/minute	Requests/day
Sandbox	100	10,000
Production	1,000	100,000
Enterprise	Custom	Custom

Idempotency

For POST requests, you can include an Idempotency-Key header to safely retry requests:

curl -X POST https://api.hedgepayments.com/v1/bankroll/payments \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Idempotency-Key: unique-request-id-123" \
  -d '{"amount": 50.00, "userId": "user-123"}'

Webhooks

HedgePayments sends webhooks for important events. See the Webhooks Guide for setup instructions. Common Events:

sidebet.roundup.processed
sidebet.transfer.completed
coverpay.payment.created
coverpay.payment.completed
coverpay.payment.failed
bankroll.payment.completed
bankroll.p2p.sent
bankroll.card.created

SDKs

npm install @hedgepayments/sdk

pip install hedgepayments

gem install hedgepayments

go get github.com/hedgepayments/hedgepayments-go

API Reference

SideBet API

CoverPay API

Bankroll API

Wallets & Users

API Overview

API Reference

Base URL

Authentication

Products

SideBet API

CoverPay API

Bankroll API

SideBet Endpoints

CoverPay Endpoints

Bankroll Endpoints

Common Endpoints

Response Format

HTTP Status Codes

Rate Limits

Idempotency

Webhooks

SDKs

​API Reference

​Base URL

​Authentication

​Products

SideBet API

CoverPay API

Bankroll API

​SideBet Endpoints

​CoverPay Endpoints

​Bankroll Endpoints

​Common Endpoints

​Response Format

​HTTP Status Codes

​Rate Limits

​Idempotency

​Webhooks

​SDKs

API Reference

Base URL

Authentication

Products

SideBet Endpoints

CoverPay Endpoints

Bankroll Endpoints

Common Endpoints

Response Format

HTTP Status Codes

Rate Limits

Idempotency

Webhooks

SDKs