Components — Paayed

Sourcey supports rich components in plain markdown using :::directive syntax. No JSX imports needed. This page is a reference for whoever edits these docs — keep it, or trim it once the team is comfortable with the syntax.

Callouts

Note

API keys are scoped to environments. A sandbox key won't work against production endpoints and vice versa.

Warning

Never commit API keys to version control. Use environment variables or a secrets manager — leaked keys should be rotated immediately from the dashboard.

Tip

Use expand[] to pull in a named sub-object on a single request instead of a follow-up call — capped at three per request, one level deep.

Info

The Paayed Payments API follows OpenAPI 3.0 and every response uses application/json unless otherwise noted.

Custom Title

You can override the default callout title by adding text after the type.

Steps

Create a key

Open Developers → API keys and create a sandbox key.

Set your API key

Export PAAYED_SECRET_KEY in your shell or pass it to your HTTP client.

Make a request

Call any endpoint with an Idempotency-Key header on writes.

Tabs

curl 'https://gateway.paayed.com/v1/payments' \
  -H 'Authorization: Bearer pyd_secret_live_...'

const res = await fetch('https://gateway.paayed.com/v1/payments', {
  headers: { Authorization: 'Bearer pyd_secret_live_...' },
});

import requests
res = requests.get(
    'https://gateway.paayed.com/v1/payments',
    headers={'Authorization': 'Bearer pyd_secret_live_...'},
)

Code Group

const res = await fetch('https://gateway.paayed.com/v1/payments');
const data = await res.json();

import requests
res = requests.get('https://gateway.paayed.com/v1/payments')
data = res.json()

curl -s 'https://gateway.paayed.com/v1/payments' | jq

Cards

Authentication

Key types, scopes, and credential rotation without downtime.

Webhooks

Signed event delivery for payments, refunds and subscriptions.

API Reference

Every endpoint, every parameter, every schema.

Accordion

Which environments are available?

Sandbox and production, on the same account. Create either at any time — see Authentication.

Where do I find my request ID for support?

Every response carries a Paayed-Request-Id header, and every error body includes a request_id field. Quote it in any support conversation.