Skip to main content
GET
Get a payout

Authorizations

Authorization
string
header
required

Partner-level JWT token (unscoped). Token payload includes partner_id. Business access is validated via partner ownership. Format: Bearer <your-jwt-token>

Use this for: Multi-business operations where the business_id is specified in the URL and partner has access to multiple businesses.

Path Parameters

business_id
string<uuid>
required

Business UUID (unique identifier for the business)

payout_id
string<uuid>
required

Payout UUID

Response

Full payout serializer for detail views and create responses Includes all computed fields and expanded payment/refund arrays

id
string<uuid>
required
read-only
business_id
string<uuid>
required
read-only
processor
enum<string>
required
  • stripe - Stripe
  • paypal - PayPal
  • square - Square
  • adyen - Adyen
  • worldpay - Worldpay
  • sage_pay - Sage Pay
  • klarna - Klarna
  • other - Other
Available options:
stripe,
paypal,
square,
adyen,
worldpay,
sage_pay,
klarna,
other,
processor_payout_id
string
required
Maximum string length: 255
paid_out_amount_cents
integer<int64>
required

Net payout amount in cents (can be negative)

Required range: -9223372036854776000 <= x <= 9223372036854776000
net_amount_cents
integer
required
read-only

Net amount: paid_out_amount - fee

imported_at
string<date-time>
required
read-only
payment_count
integer
required
read-only

Number of payments in this payout

refund_payment_count
integer
required
read-only

Number of refund payments in this payout

gross_payments_amount_cents
integer
required
read-only

Total amount of invoice payments before refunds

total_refunds_amount_cents
integer
required
read-only

Total amount of refund payments in cents

expected_net_amount_cents
integer
required
read-only

Expected net: payments - refunds - additional_refunds - fees

amount_variance_cents
integer
required
read-only

Difference between reported and expected net (for debugging)

payments
any[]
required
read-only

Expanded payment details

refund_payments
any[]
required
read-only

Expanded refund payment details

reconciliation_status
enum<string>
required
read-only

Reconciliation state

  • unreconciled - Unreconciled
  • partially_reconciled - Partially Reconciled
  • fully_reconciled - Fully Reconciled
Available options:
unreconciled,
partially_reconciled,
fully_reconciled
settlement_file_id
string<uuid> | null
required
read-only

Settlement file UUID if attached

created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
external_id
string
Maximum string length: 255
fee_cents
integer<int64>
Required range: 0 <= x <= 9223372036854776000
additional_refunds_amount_cents
integer<int64>

Additional refunds not tied to specific RefundPayment records

Required range: 0 <= x <= 9223372036854776000
currency
enum<string>
  • EUR - Euro
  • GBP - British Pound
  • USD - US Dollar
  • SEK - Swedish Krona
  • NOK - Norwegian Krone
  • DKK - Danish Krone
  • ISK - Icelandic Króna
  • MYR - Malaysian Ringgit
  • SGD - Singapore Dollar
Available options:
EUR,
GBP,
USD,
SEK,
NOK,
DKK,
ISK,
MYR,
SGD
status
enum<string>
  • pending - Pending
  • processing - Processing
  • paid - Paid
  • failed - Failed
  • cancelled - Cancelled
Available options:
pending,
processing,
paid,
failed,
cancelled
completed_at
string<date-time> | null
reference_number
string
Maximum string length: 100
memo
string
metadata
any