Other providers with the Payments API

Send a payment

1. Get your API key

   Open Website settings › Setup, go to Connect payments and choose Other / API. Copy the API key (it starts with rf_) and store it in your server's environment, for example as REVFARO_API_KEY.

2. Pass the visitor through your checkout

   When the buyer starts a checkout, read their rf_vid cookie on your server (or with window.revfaro.attribution() in the browser) and keep it with the order, for example in your provider's metadata.

3. Report the payment from your server

   When your provider confirms the payment (usually in its webhook), send it to Revfaro:

   TerminalCopy

   curl -X POST https://revfaro.com/api/v1/payments \
     -H "Authorization: Bearer $REVFARO_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "transaction_id": "txn_123",
       "amount": 29.99,
       "currency": "USD",
       "visitor_id": "<the buyer's rf_vid cookie>",
       "email": "[email protected]"
     }'

   The answer tells you whether the payment was credited to a visit:

   JSONCopy

   { "ok": true, "attributed": true, "visitor_id": "6f1c3a52-…" }

Fields

Refunds and renewals

To record a refund, send the original transaction_id with "refunded": true and the total refunded so far, as a positive amount in the original currency. Repeated or out-of-order reports keep the largest total, capped at the original payment. The refund inherits that payment's visitor and visit. If it arrives first, it waits for the payment ("pending": true in the response). It is stored as a negative amount, so revenue stays net:

curl -X POST https://revfaro.com/api/v1/payments \
  -H "Authorization: Bearer $REVFARO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"transaction_id":"txn_123","amount":29.99,"refunded":true}'

For renewals, send "renewal": true and the same customer_id as the first payment. The renewal is credited to the visitor who first subscribed and doesn't count as a new customer.

Requirements and errors

• The workspace's plan must include API access and Revenue attribution, and be active. Otherwise the API answers 403 (feature not in your plan) or 402 (plan inactive).
• A missing or wrong API key answers 401. Rotate in the Other / API tab replaces the key; the old one stops working immediately.
• timestamp also accepts an offset written as +0200 or +02, no offset (read as UTC), a space instead of the T, or a date alone (midnight UTC). Anything else, a date before 2000 or a time more than a day ahead answers 400 with the code invalid_timestamp.
• Call the API from your server only. It sends no CORS headers, so browsers can't call it, and your API key must never appear in a web page.
• Invalid amounts, currency codes, IDs or text answer 400. transaction_id is limited to 200 bytes.
• Payments don't count toward your monthly events.

Server-side goals work the same way with POST /api/v1/goals; see Track goals. The full reference, with a form to try each request, is at /api/docs. See also API reference.