Skip to main content
GET
/
v2
/
settlements
/
summaries
Settlement Summaries
curl --request GET \
  --url https://sandbox.gateway.sezzle.com/v2/settlements/summaries \
  --header 'Authorization: <api-key>'
[
  {
    "uuid": "b7916fbe-f30a-4435-b411-124634287a8ca",
    "payout_currency": "USD",
    "payout_date": "2019-12-09T15:52:33Z",
    "net_settlement_amount": 93.7,
    "forex_fees": 0,
    "status": "Complete"
  },
  {
    "uuid": "c51343hba-d54b-5641-e341-15235523b3at",
    "payout_currency": "CAD",
    "payout_date": "2019-12-10T15:52:33Z",
    "net_settlement_amount": 234.71,
    "forex_fees": 4.69,
    "status": "Complete"
  }
]
If your store accepts multiple currencies, you will need to request settlement summaries for each supported currency. If currency code is not provided in the request, the default currency will be USD.

Authorizations

​
Authorization
string
header
required

The authentication token generated from providing API Keys to Sezzle Gateway

Query Parameters

​
start-date
string<yyyy-mm-dd>
required

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

​
end-date
string<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.

​
offset
string<int32>

The offset for the report. Limit is 20.

​
currency-code
string

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

Response

Successful Operation

​
uuid
string

The unique identifier for the settlement

​
payout_currency
string

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

​
settlement_currency
string

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

​
payout_date
string<date-time>

The UTC date and time of the payout

​
final_payout_amount
float

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

​
net_settlement_amount
float

The net amount (after forex fees) to be settled

​
forex_fees
float

Foreign exchange fees associated with this settlement payout

​
status
string

The current status of the payout