Skip to content
Ridley Docs

Overview

Ridley API Documentation 1.0.0

Section titled “Ridley API Documentation 1.0.0”

Ridley provides a simple REST API for creating payment sessions and tracking payment statuses. Authenticate using your secret key (sk_live_* or sk_test_*) as a Bearer token.

Information

  • OpenAPI version: 3.0.3

Operations

Section titled “ Operations ”
POST
/v1/sessions
GET
/v1/sessions/{sessionId}
GET
/v1/payments
GET
/v1/payments/{reference}
POST
/v1/payments/{reference}/capture
POST
/v1/payments/{reference}/void
GET
/v1/payments/{reference}/refunds
POST
/v1/payments/{reference}/refunds
GET
/v1/recurring-payments
POST
/v1/recurring-payments
GET
/v1/recurring-payments/{reference}
DELETE
/v1/recurring-payments/{reference}
PATCH
/v1/recurring-payments/{reference}
POST
/v1/recurring-payments/{reference}/pause
POST
/v1/recurring-payments/{reference}/resume
POST
/v1/recurring-payments/{reference}/payment-method-session
GET
/v1/me
POST
/v1/charges
GET
/v1/invoices
POST
/v1/invoices
GET
/v1/invoices/{id}
PATCH
/v1/invoices/{id}
POST
/v1/invoices/{id}/send
GET
/v1/payment-links
POST
/v1/payment-links
GET
/v1/payment-links/{id}
PATCH
/v1/payment-links/{id}
GET
/v1/tax
POST
/v1/tax/calculate

Authentication

Section titled “ Authentication ”

default

Section titled “default”

Use your source secret key as the Bearer token. Keys are prefixed with sk_live_ (production) or sk_test_ (sandbox). You can also send the key via the X-API-Key header.

Security scheme type: http