Create a financial report

post

https://api.stage.payouts.com/report/create

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

currencies

array of strings

required

Currencies to be included in the report. This filter is required for ACCOUNT_STATEMENT_REPORT and is supported as an optional filter for BALANCE_ACTIVITY_REPORT. Other report types do not support this filter.

currencies*

fileFormat

string

enum

required

File format of financial report to create. Supported formats for Balance Activity Reports: CSV, EXCEL, PDF. Supported formats for Settlement and Transaction Reconciliation Reports: CSV, EXCEL. Supported formats for Online Payment Transaction Reports: EXCEL. Supported formats for Account Statement Reports: PDF

Allowed:

fileName

string

File name of the report. If left empty, a file name will be automatic generated following {REPORT_TYPE}_{DATE}

reportVersion

string

Version of the report. If left empty, defaults to 1.1.0 for the BALANCE_ACTIVITY_REPORT and TRANSACTION_RECON_REPORT, and to 1.0.0 for other report types.

transactionTypes

array of strings

Transaction types to be included in the report. Will include all transaction types if left empty. Supported Balance Activity Transaction Types: ADJUSTMENT, CARD, CHARGE, CONVERSION, DEPOSIT, DIRECT_DEBIT, FEE, PAYIN, PAYOUT, TRANSFER Supported Transaction Reconciliation Report Transaction Types: ADJUSTMENT, CARD, CONVERSION, DEPOSIT, FEE, PAYMENT, PAYOUT. Please leave blank when type is ONLINE_PAYMENTS_TRANSACTION_REPORT

transactionTypes

type

string

enum

required

Type of financial report to create. Currently ACCOUNT_STATEMENT_REPORT, BALANCE_ACTIVITY_REPORT, TRANSACTION_RECON_REPORT, ONLINE_PAYMENTS_TRANSACTION_REPORT are supported.

Allowed:

toDate

string

required

End date of the report.

fromDate

string

required

Start date of the report (inclusive)

timeZone

string

Defaults to Asia/Jerusalem

Timezone of the user requesting the report

Responses

201Financial report successfully created

401A response indicating that the provided bearer token is invalid or has already expired