Payout(s)

This action retrieves information about Payouts associated with your White Swan account. A payout can consist of several Commission Line Items and you can also capture downline payouts through the platform.

Payout data is only available on the Digital Agent Plan and Concierge Plan. This endpoint will not return data for accounts on the Innovator Plan.

API Method:

Fetch Payout(s)

POST https://app.whiteswan.io/api/1.1/wf/payouts

Returns information about payouts associated with your White Swan account.

Headers

Name

Type

Description

Authorization*

String

Bearer <YOUR API KEY>

Content-Type*

String

application/json

Accept*

String

application/json

user-agent*

String

Request Body

Name

Type

Description

JSON Body*

Object

Used to query for specific payout event, not required.

Sample Body Payload

{
  "direction": "Inbound Payout",
  "recipient_company_id": "1776772304993x692932671527100400",
  "recipient_company_external_id": "ext_company_12345",
  "recipient_user_email": "[email protected]",
  "recipient_user_external_id": "ext_user_67890",
  "payor_company_name": "John Hancock",
  "payor_company_id": "1776772304993x781245903456120555",
  "payor_company_external_id": "ext_payor_54321",
  "case_id": "1776772304993x781245903456120145",
  "commission_line_item_id": "1776772304993x781245903456120001",
  "page": 1,
  "start_date": "2026-01-01T00:00:00Z",
  "end_date": "2026-12-31T23:59:59Z"
}

Please note that the sample body payload above contains all possible parameters for your reference. In an actual call, you don't need to use all (or any) parameters.

Code Examples - Making the API Call:

curl -X POST "https://app.whiteswan.io/api/1.1/wf/payouts" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "direction": "Inbound Payout"
  }'

import requests

url = "https://app.whiteswan.io/api/1.1/wf/payouts"

headers = {
    "Authorization": "Bearer <YOUR_API_KEY>",
    "Content-Type": "application/json"
}

payload = {
    "direction": "Inbound Payout"
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

fetch("https://app.whiteswan.io/api/1.1/wf/payouts", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <YOUR_API_KEY>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    direction: "Inbound Payout"
  })
})
  .then(res => res.json())
  .then(data => console.log(data));

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{ \"direction\": \"Inbound Payout\" }");

Request request = new Request.Builder()
  .url("https://app.whiteswan.io/api/1.1/wf/payouts")
  .post(body)
  .addHeader("Authorization", "Bearer <YOUR_API_KEY>")
  .addHeader("Content-Type", "application/json")
  .build();

Response response = client.newCall(request).execute();
System.out.println(response.body().string());

<?php

$payload = [
    "direction" => "Inbound Payout"
];

$ch = curl_init("https://app.whiteswan.io/api/1.1/wf/payouts");

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <YOUR_API_KEY>",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));

$response = curl_exec($ch);
curl_close($ch);

echo $response;

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
)

func main() {
	url := "https://app.whiteswan.io/api/1.1/wf/payouts"

	payload := []byte(`{ "direction": "Inbound Payout" }`)

	req, err := http.NewRequest("POST", url, bytes.NewBuffer(payload))
	if err != nil {
		panic(err)
	}

	req.Header.Set("Authorization", "Bearer <YOUR_API_KEY>")
	req.Header.Set("Content-Type", "application/json")

	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
)

func main() {
	url := "https://app.whiteswan.io/api/1.1/wf/payouts"

	payload := []byte(`{ "direction": "Inbound Payout" }`)

	req, err := http.NewRequest("POST", url, bytes.NewBuffer(payload))
	if err != nil {
		panic(err)
	}

	req.Header.Set("Authorization", "Bearer <YOUR_API_KEY>")
	req.Header.Set("Content-Type", "application/json")

	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

Code examples are available in cURL, Python, Javascript, Java, PHP, Ruby, and Go, but can be constructed for other languages and tools. Some code examples include dependencies that may need to be installed in your codebase to ensure functionality. Remember to replace any values in the code that looks like <VALUE> and to adapt the parameter values passed.

Body Parameters Specification:

Field Label

Field Key

Field Type

Example Value

Description

Direction

direction

Multiple-Choice

Inbound Payout

Used to filter by either "Inbound Payout" or "Outbound Payout"

Recipient Company White Swan ID

recipient_company_id

Text

5278025803x2957025790

Used to filter for a specific company by White Swan ID.

Recipient Company External ID

recipient_company_external_id

Text

12345678

Used to filter for a specific company by an external ID - this must be created upon agency signup through the Onboard Agency API call.

Recipient User Email

recipient_user_email

Text

[email protected]

Used to filter by payout recipient email.

Recipient User External ID

recipient_user_external_id

Text

12345678

Used to filter by payout recipient external ID - this must be created upon agency signup through the Onboard Agency API call.

Payor Company Name

payor_company_name

Text

Backnine

Used to filter by payor company name.

Payor Company White Swan ID

payor_company_id

Text

5278025803x2957025790

Used to filter by payor company White Swan ID.

Payor Company External ID

payor_company_external_id

Text

1241241245

Used to filter by payor company external ID - this must be created upon agency signup through the Onboard Agency API call.

Plan Request ID

case_id

Text

5278025803x2957025790

Used to filter by a payout associated plan request ID.

Commission Line Item ID

commission_line_item_id

Text

5278025803x2957025790

Used to filter by a payout associated commission line item ID.

Start Date

start_date

Date/Time in ISO 8601

2026-12-31T23:59:59Z

Used to filter for payout events occurring after a certain date.

End Date

end_date

Date/Time in ISO 8601

2026-12-31T23:59:59Z

Used to filter for payout events occurring before a certain date.

Sample Return Payload

{
  "payouts": [
    {
      "payout_id": "1776772304993x900000000000000001",
      "payout_external_id": "ext_payout_001",
      "direction": "Inbound Payout",
      "source_system": "BackNine",
      "amount": 1250.75,
      "payment_date": "2026-04-18T10:15:00Z",
      "payment_method": "ACH",
      "status": "Completed",
      "status_note": "Funds settled successfully",
      "recipient": {
        "type": "Agency",
        "id": "1776772304993x692932671527100400",
        "name": "Acme Insurance Group",
        "email": "[email protected]",
        "phone": "+1-512-555-1000",
        "address": {
          "street_address": "123 Main St",
          "city": "Austin",
          "state": "TX",
          "zip": "78701",
          "country": "US",
          "address_type": "Business"
        }
      },
      "payor": {
        "id": "1776772304993x900000000000000010",
        "name": "John Hancock",
        "email": "[email protected]",
        "phone": "+1-800-555-2000",
        "address": {
          "street_address": "200 Berkeley St",
          "city": "Boston",
          "state": "MA",
          "zip": "02116",
          "country": "US",
          "address_type": "Headquarters"
        }
      },
      "linked_commission_line_item_ids": [
        "1776772304993x900000000000000100",
        "1776772304993x900000000000000101"
      ],
      "linked_case_ids": [
        "1776772304993x900000000000000200"
      ]
    }
  ],
  "page": 1,
  "page_size": 1,
  "total": 1,
  "has_next_page": false
}

Returned Parameters Specification:

Field Label

Field Key

Field Type

Example Value

Description

Payouts

payouts

Object Array

See specification below.

An array of payout objects.

-Payout ID

payout_id

Text

1670721321811x149164079586738180

The amount credited for the earnings event.

-Payout External ID

payout_external_id

Text

123512364

The name of the client associated with the earnings event (only for Closed Case Events).

-Payout Direction

direction

Multiple-Choice

Inbound Payout

The email address of the client associated with the earnings event (only for Closed Case Events).

-Payout Source System

source_system

Text

Backnine

The ID of the plan request associated with the earnings event.

-Payout Amount

amount

Number

Acme Inc

The name of the partner associated with the earnings event (only for Referred Partner Earning Events).

-Payout Date

payment_date

Date/Time in ISO 8601

https://s3.amazonaws.com/appforest_uf/f167656056312330177020/Crediting%20Invoice%20.docx

A link to the credit invoice for the earnings event (only for Paid Compensation Events)

-Payout Method

payment_method

Text

Axel Doe

The name of the account user associated with the earnings event.

-Payout Status

status

Text

Paid via ACH

The current status of the payout.

-Payout Note

status_note

Text

Updated to new checking account.

A note to the payout.

-Payout Recipient

recipient

Object

See below

The recipient of the payment.

--Payout Recipient Type

type

Multiple-Choice

Agent

Either Agent or Agency.

--Payout Recipient ID

Text

280512805x85025802580

The ID of the payout recipient.

--Payout Recipient Name

name

Text

John Doe

The name of the payout recipient.

--Payout Recipient Email

Text

[email protected]

The email of the payout recipient.

--Payout Recipient Phone

phone

Text

312-52-2158

The phone of the payout recipient.

--Payout Recipient Address

address

Object

See below

The address of the payout recipient.

---Payout Recipient Address Street

street_address

Text

12 Longstreet

The street address.

---Payout Recipient Address City

city

Text

Monkton

The city.

---Payout Recipient Address State

state

Text

The state.

---Payout Recipient Address Zip

zip

Text

28750

The zip.

---Payout Recipient Address Country

country

Text

United States

The country.

---Payout Recipient Address Type

address_type

Text

Business address

The address type.

-Payor

payor

Object

See below.

The payor of this Payout.

--Payor ID

Text

280512805x85025802580

The ID of the payor of this payout.

--Payor Name

name

Text

Backnine Insurance

The company name of the payor of this payout.

--Payor Email

Text

[email protected]

The email address of the payor of this payout.

--Payor Phone

phone

Text

312-52-2158

The phone number of the payor of this payout.

--Payor Address

address

Object

See below.

The address of the payor of this payout.

---Payor Address Street

street_address

Text

12 Longstreet

The street address.

---Payor Address City

city

Text

Monkton

The city.

---Payor Address State

state

Text

The state.

---Payor Address Zip

zip

Text

78231

The zip code.

---Payor Address Country

country

Text

United States

The country.

---Payor Address Type

address_type

Text

Business Address

The address type.

-Linked Commission Line Items IDs

linked_commission_line_item_its

Text Array

["218502580x28502580","1802582501x2580128"]

The IDs of the commission line items associated with this payout.

-Linked Plan Request IDs

linked_case_ids

Text Array

["218502580x28502580","1802582501x2580128"]

The IDs of the plan requests associated with this payout.

Page Number

page

Number

The currently viewed page of payouts. Use the payout parameter to change page.

Count Shown on Page

page_size

Number

The current number of payouts shown in the payout array.

Total Payout Count

total

Number

100

The total number of payouts available based on the query.

Next Page Available

has_next_page

Boolean

true

Whether another page of entries exists after the current page.

PreviousCommission Line Item(s)NextDownline(s)

Last updated 23 days ago

Was this helpful?

hashtagFetch Payout(s)

hashtagHeaders

hashtagRequest Body

Fetch Payout(s)

Headers

Request Body