Skip to main content

Funding report

POST 
/v1/reports/funding_report

Returns funding report using the specified criteria.

Request​

Body

    date_settlement_from daterequired

    Requested settlement date period start. May be in the future.

    date_settlement_to daterequired

    Requested settlement date period end. May be in the future. May not be before settlement date period start.

    currencies string[]

    Filter by funding (sell) currencies. All currencies if not present.

    Possible values: >= 3 characters and <= 3 characters

    Example: ["USD"]
    sources string[]

    Filter by payment partners that executed the trades. All if not present.

    Example: ["Corpay","CAB"]

Responses​

Your request has been successfully processed.

Schema

    date_settlement_to date

    Report settlement date period end.

    effective_date_settlement_from date

    Report settlement date period start. May be after date_settlement_from if the report is incomplete.

    incomplete boolean

    Report incomplete flag. Set to true if the range requested was too large, or if some error has occurred during the report generation.

    rows

    object[]

  • Array [

    • date_settlement date

    Date and time when this trade took place.

    sold_currency string

    The funding currency.

    Possible values: >= 3 characters and <= 3 characters

    Example: USD
    sold_amount double

    The amount of base currency bought or sold

    Example: 5000
    source string
    Example: CAB

  • ]

Loading...