Skip to main content
POST
/
create
cURL
curl --request POST \
  --url https://firstpromoter.com/api/v1/payouts/create \
  --header 'X-API-KEY: <api-key>'
{
  "id": 2710287,
  "status": "pending",
  "amount": 3000,
  "date_paid": null,
  "due_date": "2024-10-11T00:00:00.000Z",
  "unit": "cash",
  "created_at": "2024-09-12T14:02:53.135Z",
  "has_issues": false,
  "reward": null,
  "promoter": {
    "id": 8262622,
    "status": "active",
    "cust_id": "",
    "email": "[email protected]",
    "created_at": "2024-05-27T17:43:38.935Z",
    "temp_password": "xsKyiS",
    "default_promotion_id": 9441115,
    "pref": "w4wfj9q",
    "default_ref_id": "testxeak1xz1",
    "note": "This is a test promoter. You can use it to test the integration.",
    "w8_form_url": null,
    "w9_form_url": null,
    "parent_promoter_id": null,
    "earnings_balance": {
      "cash": 23000
    },
    "current_balance": {
      "cash": 23000
    },
    "paid_balance": null,
    "auth_token": "bFahsKx8v9_zL9sPTZCDH8JnQAbTeDpy"
  },
  "campaign": {
    "id": 15161,
    "name": "Test new campaign",
    "landing_url": "http://testmax.maxwelladapoe1.com/",
    "description": "",
    "private": false,
    "color": "#00bcd4",
    "default_webhook_url": "",
    "auto_approve_rewards": true,
    "auto_approve_promoters": true
  }
}

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
promoter_email
string<email>
required

required if promoter_id is null

Email of the promoter

​
promoter_id
string

required if promoter_email is null

Id of the promoter to assign the payout

​
status
enum<string>

The payout status

Available options:
pending,
processing,
completed
​
campaign_id
string

For what campaign to create the payout. If is null, we'll take the promoter's default

Response

Success response

​
id
integer
Example:

2710287

​
status
string
Example:

"pending"

​
amount
integer
Example:

3000

​
date_paid
string<date-time> | null
Example:

null

​
due_date
string<date-time>
Example:

"2024-10-11T00:00:00.000Z"

​
unit
string
Example:

"cash"

​
created_at
string<date-time>
Example:

"2024-09-12T14:02:53.135Z"

​
has_issues
boolean
Example:

false

​
reward
object
Example:

null

​
promoter
object
​
campaign
object