Skip to content

Payment links

A payment link is a page anyone can open to pay you, by card or bank transfer. Share it on your website, in messages or as a QR code.

Terminal window
curl https://api.catholicpay.example/api/v1/merchant/payment-links \
-H "Authorization: Bearer $CATHOLICPAY_SECRET_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"title": "Building fund",
"description": "Support the new church hall",
"suggested_amounts": ["5000.00", "10000.00", "50000.00"],
"redirect_url": "https://parish.example.org/thank-you"
}'

The response has the link’s url and a qr_url. Leave amount out to let payers choose (with suggested_amounts as buttons), or set it for a fixed price. The money goes to wallet_id, or your main wallet. expires_at ends the link; allow_recurring lets payers set up regular giving through it.

Payment links are public, so they need a live key (422 LIVE_ONLY with a test key).

Payments through links appear in GET /merchant/web-payments, and each sends payment.succeeded. List your links with GET /merchant/payment-links.