---
title: "Settlement Report"
method: GET
path: "/reports/settlement"
tags: ["Reports"]
---

# Settlement Report

`GET /reports/settlement`

This report provides credit card settlement and fee information. It is helpful to understand the credit date, amount, and fees of each settlement. You can retrieve settlement data with up to a three-month range.

Note:

* Our system calculates settlement using Pacific Time (PT) with midnight cut off.

## Query parameters

- `start_date` string, date, required
- `end_date` string, date, required

## Response `200`

A settlement object.

- CardSettlementReport
  - `data` CardSettlementRecord[]
    - `merchant_id` number — The id of the merchant for this settlement.
    - `transactions_date` string, date — The day (PT) the transactions settled.
    - `currency` string — The currency abbreviation for this settlement.
    - `settlement_net_amount` number, double — Shows the total net amount of the settlement.
    - `settlement_state` 'Scheduled' | 'Generating' | 'In Process' | 'Approved' | 'Declined' | 'Transferred' | 'On Hold' | 'Accumulating' | 'Perform Settlement' | 'Under Minimum Threshold' | 'Pending Account Verification' — State of the settlement.
    - `settlement_date` string, date — The day (PT) the funds are expected to be processed by the bank and settled. If there is no date scheduled yet then it will return "0001-01-01"
    - `approved_transaction_count` number — Total count of approved transactions
    - `declined_transaction_count` number — Total count of declined transactions
    - `sale_amount_total` number, double — Total amount of sales in dollars and cents
    - `returned_amount_total` number, double — Total amount of returns in dollars and cents
    - `chargebacks_count` number — Total count of chargebacks
    - `chargebacks_amount_total` number, double — Total amount of chargebacks in dollars and cents
    - `card_transaction_approved_rate` number, double — Rate for approved transactions
    - `card_transaction_declined_rate` number, double — Rate for declined transactions
    - `card_discount_rate` number, double — Card discount rate
    - `gst_tax_rate` number, double — GST rate applied to fees
    - `approved_transaction_fee_total` number, double — Total fees for approved transactions
    - `declined_transaction_fee_total` number, double — Total fees for declined transactions
    - `discount_rate_fee_total` number, double — Total of the per-transaction fees that is charged based upon the total amount of the transaction size.
    - `chargeback_fee_total` number, double — Chargeback fees are applied against transactions that were contested by a credit card owner.
    - `gst_tax_fee_total` number, double — The total GST applied to transaction fees. GST is only added to chargeback fees.
    - `reserves_held` number, double — The amount currently held in a Bambora reserve account.
    - `reserves_released` number, double — Amount released from the reserve account during the current statement period.
    - `reserves_forward` number, double — Total amount that Bambora held in a reserve account as of the previous statement period.

## Other responses

- `400` — Bad Request
- `401` — Authentication Failure
- `403` — Authorization Failure
- `405` — Invalid Request Method
- `500` — Internal Server Error

---

[API](https://skmtc.net/worldline-solutions/apis/worldline-payment-apis.md) · [All operations](https://skmtc.net/worldline-solutions/apis/worldline-payment-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/worldline-solutions/worldline-payment-apis/revisions/d661d9e357a1/schema)