Create and revoke Payment Links - SimplePay Docs

A Payment Link represents a shareable charge. Create it with a manual amount or a catalog line item.

Create a link

curl -sS -X POST "$SIMPLEPAY_API_BASE/v1/payment-links" \
  -H "Authorization: Bearer $SIMPLEPAY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: invoice_2026_0007_link_v1" \
  --data '{
    "manual_amount": 250000,
    "currency": "mxn",
    "recipient_email": "finance@example.com",
    "payment_method_types": ["card", "spei"],
    "metadata": {"invoice_id": "2026_0007"}
  }'

The response includes an authenticated id, a public_id, and the shareable url.

Manage the lifecycle

GET /v1/payment-links: list links for this merchant and environment
GET /v1/payment-links/{id}: retrieve one link by internal ID
POST /v1/payment-links/{id}/revoke: prevent new payments

Revoking a link does not alter historical payments or snapshots.

Last modified on August 22, 2026