Create an affiliate payout
Create a payout and reserve its eligible referrals together.
Create a record for the affiliate's eligible commissions. This does not send money; your store arranges the payment separately.
Send a unique Idempotency-Key header. Replaying the same key for the same affiliate returns the original payout. Reusing it for another affiliate is rejected.
Provide your SellApp API key as a bearer token.
In: header
Path Parameters
The affiliate path parameter.
Header Parameters
A caller-generated key, unique per store and affiliate payout operation.
length <= 100Store slug. Required for OAuth access tokens. API keys may omit it to use their current store, or the first accessible store when no current store is selected.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://sell.app/api/v2/affiliates/0/payouts" \ -H "Idempotency-Key: string" \ -H "X-STORE: launch-lab"{
"data": {
"id": 91,
"affiliate_id": 88,
"affiliate_email": "alex@example.com",
"amount_usd_cents": 2000,
"status": "due",
"payout_method": "PAYPAL",
"payout_account": "a***@example.com",
"referrals_count": 10,
"created_at": "2026-09-01T12:00:00Z",
"updated_at": "2026-09-01T12:00:00Z"
}
}{
"data": {
"id": 91,
"affiliate_id": 88,
"affiliate_email": "alex@example.com",
"amount_usd_cents": 2000,
"status": "due",
"payout_method": "PAYPAL",
"payout_account": "a***@example.com",
"referrals_count": 10,
"created_at": "2026-09-01T12:00:00Z",
"updated_at": "2026-09-01T12:00:00Z"
}
}{
"type": "invalid_request_error",
"code": "bad_request",
"message": "The request could not be understood.",
"status": 400,
"param": null,
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#bad-request"
}{
"type": "authentication_error",
"code": "unauthenticated",
"message": "Unauthenticated.",
"status": 401,
"param": null,
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#unauthenticated"
}{
"type": "authorization_error",
"code": "forbidden",
"message": "This action is unauthorized.",
"status": 403,
"param": null,
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#forbidden"
}{
"type": "not_found_error",
"code": "resource_not_found",
"message": "Not Found.",
"status": 404,
"param": null,
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#resource-not-found"
}{
"type": "validation_error",
"code": "validation_failed",
"message": "The selected product variant id is invalid.",
"status": 422,
"param": "product_variant_id",
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#validation-failed",
"errors": {
"product_variant_id": [
"The selected product variant id is invalid."
]
}
}{
"type": "rate_limit_error",
"code": "rate_limit_exceeded",
"message": "Too Many Attempts.",
"status": 429,
"param": null,
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#rate-limit-exceeded"
}{
"type": "api_error",
"code": "api_error",
"message": "Server Error",
"status": 500,
"param": null,
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#api-error"
}