Sign in

v2

latestOpenAPI 3.1.02026-07-264249163.7 KB
Reports

Settlement Summaries

Get a summarized list of settlement payouts.

get/v2/settlements/summaries

Query parameters

start-datestring yyyy-mm-dd required

The UTC start date for the report. Must be in yyyy-mm-dd format.

end-datestring yyyy-mm-dd

The UTC end date for the report. Must be in yyyy-mm-dd format. If omitted, will default to the current date.

offsetinteger

Number of records to skip. Each response returns up to 30 records, so use 0 for the first 30, 30 for the next 30, and so on. Defaults to 0.

currency-codestring

The ISO-4217 currency code selected by users at checkout. If omitted, will default to USD.

Response

Successful Operation

uuidstring

The unique identifier for the settlement

payout_currencystring

The ISO-4217 currency code of the payout sent to the destination bank account

settlement_currencystring

The ISO-4217 currency code of the amount to be settled

payout_datestring date-time

The UTC date and time of the payout

final_payout_amountnumber float

The final amount sent in the currency of the destination bank account

net_settlement_amountnumber float

The net amount (after forex fees) to be settled

forex_feesnumber float

Foreign exchange fees associated with this settlement payout

statusstring

The current status of the payout