Record a payout
POST
Mark rewards as paid after you send the money yourself. Referral API never moves funds.
apiKeyheader
AuthorizationBearer <token>Use a secret key such as sk_test_... in test mode or sk_live_... in production.
Idempotency-Key?stringA unique key that makes retries safe. Keys expire after 24 hours.
Format
uuidapplication/json- body
reward_ids*array<string>method*stringValue in
"bank_transfer""paypal""account_credit""gift_card""other"reference?stringYour transfer or transaction ID.
The payout was recorded.
application/json- response
id*stringreward_ids*array<string>total*integercurrency*stringmethod*stringreference?string|nullcreated_at*stringFormat
date-timecurl -X POST 'https://api.referralapi.example/v1/payouts' \ -H 'Content-Type: application/json' \ -d '{ "reward_ids": [ "rwd_5Gh8kLq1" ], "method": "bank_transfer"}'Example Response201
{ "id": "po_2Df6hJk8", "reward_ids": [ "string" ], "total": 0, "currency": "string", "method": "string", "reference": "string", "created_at": "2019-08-24T14:15:22Z"}