Fetch a payout report for date

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Payout Reports

Payout reports contain information about your purchases, refunds, and disputes for a given date.

Response Object

The table below outlines the fields that are returned by the /payouts namespace. Expect an array of objects with these fields if you have payouts to multiple accounts on the same day.

FieldTypeDescription
payout_dateString / Date YYYY-MM-DDThe date of the payout.
payoutsArrayAn array of payouts.
method
  • VISA/MASTERCARD
  • UPI
  • AMEX
  • BECS
This represents the method associated with the payout.
funding_accountObjectThis stores the account number and bsb.
bsbString / “NNN-NNN”The bsb of the funding account object.
account_numberStringThe account number of the funding account object.
referenceString / “FZ-YYYYMMDD-<string>”The reference displayed on the merchant’s bank statement.
amountFloatThe total payout disbursed that day. Can be a negative value denoting a claw back (direct debit).
detailObjectContains the breakdown of the figures that determine the payout figure.
gross_processing_amountFloatThe total gross value of your purchases minus refunds and chargebacks.
transaction_countIntegerThe count of all transactions processed for the day.
processing_fees_amountFloatThe total of all charges withheld. This excludes dispute charges.
dispute_charges_amountFloatThe total chargeback fees incurred (and deducted).
disputes_countIntegerThe count of all disputes processed for the day.
Path Params
date
required
Defaults to 2022-01-01
Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json