RefCampaignDocs
Référence APIPayouts

Mark a payout paid

Finalizes an APPROVED payout after external payment and reuses the shared payout-paid side effects.

POST
/api/v1/payouts/{id}/mark-paid

Finalizes an APPROVED payout after external payment and reuses the shared payout-paid side effects.

Authorization

bearerAuth
AuthorizationBearer <token>

API key issued from the merchant dashboard (prefix rc_live_ / rc_test_). Sent as Authorization: Bearer <token>. Used by the SDK and any direct server-to-server integration.

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://app.refcampaign.com/api/v1/payouts/string/mark-paid" \  -H "Content-Type: application/json" \  -d '{    "paymentDate": "string",    "paymentMethod": "string"  }'
Empty
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "details": null
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z",
    "requestId": "string"
  }
}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "details": null
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z",
    "requestId": "string"
  }
}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "details": null
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z",
    "requestId": "string"
  }
}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "details": null
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z",
    "requestId": "string"
  }
}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "details": null
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z",
    "requestId": "string"
  }
}

Reject a payout POST

Rejects a pending, invoice-uploaded, or approved payout that has not been claimed by PayPal processing.

Integration self-check GET

Validates the secret API key and returns enough account state to confirm the integration is wired correctly: merchant name, number of active campaigns, and Stripe Connect status (connected + mode). Used by the SDK to surface a clear "your integration works" signal.