Skip to content
Coritan Docs

Track your payouts

See what your next payout holds and where it goes, then what Coritan paid you for each period, less the platform cut, wholesale hosting and usage.

View as Markdown

A payout is the money Coritan sends your organization for what its payment gateways collected from your customers. The Payouts page of Billing starts with the Next payout, what the payout would hold if it were made today and where it goes, then lists each payout with its period, what was collected, the platform cut, the wholesale hosting, the usage at wholesale and what was paid out. To see the next payout month by month, open Platform cut.

A store that sells goods through Commerce is paid out separately, from its own balance: Get store payouts and tax reports covers those payouts.

  • You need the owner, admin or billing role.
  • Every billing mode is settled. With Own gateway, your PayNow store pays you directly, so Coritan has nothing to pay out, and the platform cut, wholesale hosting and usage on that money are invoiced to you instead.

At the start of each month, Coritan settles each active organization, one calendar month (UTC) at a time. The window starts where your last payout ended, so a month that produced no payout carries into the next one.

  1. It adds up your hosting money for the month: charges and wallet top-ups, less refunds and chargebacks, through Coritan's gateways and through your own PayNow store.

  2. It takes the platform cut on that money, at the month's rate. The rate is set by the month's whole revenue, store sales and hosting together:

    Month's revenue (USD) Rate
    Under 2,000 3.5%
    2,000 to under 10,000 2%
    10,000 or more 1%

    A month whose hosting money is negative, because refunds outweighed charges, pays no cut, and the difference comes off the next month's.

  3. It takes the wholesale price of the hosting your customers' invoices paid for in the window. On the Usage billing basis that no longer includes compute plans, which are charged by use instead.

  4. It takes your Usage at wholesale: the compute your customers' servers used in the window, charged as it ran, whether or not the customer has paid. A refund, a chargeback or a free order does not change it.

  5. If an earlier payout left an invoice unpaid, what is left of the money pays it down, oldest first. The row reads Earlier shortfall.

  6. What is left of the money Coritan's gateways collected is your payout.

When that money does not cover the cut, the wholesale hosting and the usage, because your customers paid your own PayNow store or their use cost more than they paid, Coritan invoices the difference to your Coritan account (the owner's, when you are not the owner), due in 14 days. The invoice has a line for each month's cut, wholesale and Usage at wholesale. If it goes unpaid past its payment reminders, new orders on your storefront pause until it is paid. See what your customers' use costs you says what that means. The payout row then shows nothing paid out and the amount invoiced to the owner. When refunds leave Coritan's own collections below zero, nothing is invoiced, and the window carries into the next month.

Organizations Coritan runs pay no platform cut, no wholesale and no usage charge.

These are not money in, so they count for nothing:

  • invoices you or your staff marked paid,
  • invoices paid from customer credit.

In the dashboard, open the organization, then Billing, then Payouts. The Next payout card at the top shows what the payout for the window since your last one would hold if it were made today:

  • Collected, Platform cut, Wholesale and Usage at wholesale, as the payout would take them, and Earlier shortfall when it pays down an earlier invoice. Organizations Coritan runs have no cut, wholesale or usage lines. Usage at wholesale shows on the Usage billing basis, and on the Plans basis once usage has been charged.
  • Card fees: None deducted. The gateways' fees are listed on your statements, for your records.
  • Paid out, and Invoiced to the owner when the money collected does not cover the charges.
  • Paid to: where the payout goes, the method with the account masked, such as PayPal, c•••@example.com. Coritan sets it; Ask support to change it opens a support ticket. Until Coritan has a PayPal address or a Stripe account for your organization, it reads Not set and Coritan pays by hand: Ask support to set it. With Own gateway there is no payout, and no Paid to line.

The figures are in US dollars, converted from the currencies your customers paid in.

  1. In the dashboard, open the organization, then Billing, then Payouts.
  2. Each row shows the Period, the Status with the date it was paid or is scheduled, what was Collected, the Platform cut with the rate it was taken at, such as at 3.5%, the Wholesale hosting, the Usage at wholesale (a column of its own while you pay by usage), what was Paid out and the Method. A payout from before Coritan settled month by month shows the rate its cut came to, such as at 10%. A payout that left a difference to invoice shows it under Paid out. The list shows 50 payouts a page, newest first, with the pager under it for the rest; while they all fit on one page, select a column heading to sort them.
  3. Select a payout to open it in a drawer on the right of the screen. It repeats the figures, adds when it was Scheduled and Paid on, and lists the Months settled, each with its Revenue, Rate, Cut, Wholesale and Usage at wholesale. When the money collected did not cover the charges, it says what was invoiced to the owner, and the owner can open that invoice from it.
Status Meaning
pending Created and waiting to be sent.
processing Being sent.
completed Sent. The row shows the date it was paid.
failed Could not be sent. Contact support.

The Method is PayPal, Stripe Connect or Manual transfer, which means Coritan sends the money by hand. Coritan sets the method for your organization; ask support to change it, as Paid to on the Next payout offers.

No payouts yet
No month has closed with money owed to you, or your billing mode is Own gateway and nothing was left to invoice.
A payout is smaller than your sales
The platform cut, wholesale hosting and usage at wholesale came off it, the sales include invoices marked paid, paid from credit or taken by your PayNow store, or refunds and chargebacks came off it. A statement for the same period breaks the figures down.
A payout paid nothing and says an amount was invoiced to the owner
Coritan's gateways collected less than the cut, the wholesale hosting and the usage, so the difference was invoiced to the owner's Coritan account. Pay it from billing.
Paid to reads Not set
Coritan has no PayPal address or Stripe account to send your payouts to, so it pays them by hand. Select Ask support to set it and say where the payouts should go.

List payouts, newest first. limit sets how many (20 by default, at most 200) and offset how many to skip. The answer is a list; with with_total=true it is {items, total, limit, offset}, where total counts every page together.

Shell
curl "https://api.coritan.com/api/v1/orgs/acme/payouts?limit=12&with_total=true" \
  -H "Authorization: Bearer $CORITAN_TOKEN"

Each payout has amount (what Coritan's gateways collected), currency, platform_fee and platform_cut_amount (the cut), wholesale_total, usage_total (the compute your customers used, at wholesale) and earlier_shortfall (what it paid of earlier unpaid invoices), net_amount (what is sent), shortfall and shortfall_invoice_id (the difference invoiced to the owner, when there was one), months (per month: month, label, volume_usd, rate_percent, hosting_money, own_store_money, cut, wholesale and usage), status, payout_method, period_start, period_end, scheduled_at and completed_at. Your webhooks receive payout.created with payout_id, period_start and period_end when a payout is created.

The Next payout and where it goes come from GET /api/v1/orgs/acme/billing/cut: settlement holds the figures, and payout the method, whether a destination is set and needed, and the destination with the account masked, or null when Coritan pays by hand. No organization route changes where payouts go.

API operations on this page

MethodPathWhat it does
GET/api/v1/orgs/{org_slug}/payoutsThe organization's hosting payouts, newest first
GET/api/v1/orgs/{org_slug}/billing/cutGet platform cut