# Settlement Report Retrieval

## Parameters

### report_date
- **Type:** date  
- **Required:** Yes  
- **Description:** Date of the settlement report to retrieve. Not available in sandbox.

### ending_before
- **Type:** string  
- **Description:** A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item.

### page_size
- **Type:** integer  
- **Constraints:** 1 to 500, Defaults to 50  
- **Description:** Number of records per page.

### starting_after
- **Type:** string  
- **Description:** A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item.

## Response

### 200 OK
- **Type:** object  
#### Fields:
- **data:** array of objects (required)
    - **account_token:** uuid | null (required)  
      - Globally unique identifier denoting the account that the associated transaction occurred on.
    - **card_program_token:** uuid | null (required)  
      - Globally unique identifier denoting the card program that the associated transaction occurred on.
    - **card_token:** uuid | null (required)  
      - Globally unique identifier denoting the card that the associated transaction occurred on.
    - **created:** date-time (required)  
      - Date and time when the transaction first occurred. UTC time zone.
    - **currency:** string (required)
      - Length between 3 and 3, Three-character alphabetic ISO 4217 code.
    - **disputes_gross_amount:** integer (required)  
      - The total gross amount of disputes settlements.
    - **event_tokens:** array of strings (required)
      - Array of globally unique identifiers for the financial events that comprise this settlement. Use these tokens to access detailed event-level information.
    - **fee_description:** string  
      - Network's description of a fee, only present on records with type `FEE`.
    - **institution:** string (required)
      - The most granular ID the network settles with (e.g., ICA for Mastercard, FTSRE for Visa).
    - **interchange_fee_extended_precision:** integer (required)
      - The total amount of interchange in six-digit extended precision.
    - **interchange_gross_amount:** integer (required)
      - The total amount of interchange.
    - **network:** string (enum) (required)
      - Card network where the transaction took place: `AMEX`, `INTERLINK`, `MAESTRO`, `MASTERCARD`, `UNKNOWN`, `VISA`
    - **other_fees_details:** object (required)
      - The total gross amount of other fees by type.
    - **other_fees_gross_amount:** integer (required)
      - Total amount of gross other fees outside of interchange.
    - **report_date:** string (required)
      - Date of when the report was first generated.
    - **settlement_date:** string (required)
      - Date of when money movement is triggered for the transaction.
    - **token:** uuid (required)
      - Globally unique identifier denoting the Settlement Detail.
    - **transaction_token:** uuid | null (required)
      - Globally unique identifier denoting the associated transaction.
    - **transactions_gross_amount:** integer (required)
      - The total amount of settlement impacting transactions (excluding interchange, fees, and disputes).
    - **type:** string (enum) (required)
      - The type of settlement record: `ADJUSTMENT`, `ARBITRATION`, `CHARGEBACK`, `CLEARING`, `COLLABORATION`, `FEE`, `FINANCIAL`, `NON_FINANCIAL`, `PREARBITRATION`, `REPRESENTMENT`
    - **updated:** date-time (required)
      - Date and time when the transaction first occurred. UTC time zone.
- **has_more:** boolean (required)
  - More data exists.

### Error Codes

#### 400
- A parameter in the query given in the request does not match the valid queries for the endpoint.

#### 401
- User has not been authenticated  
- Invalid or missing API key  
- API key is not active  
- Could not find API key  
- Please provide API key in Authorization header  
- Please provide API key in the form Authorization: [api-key]  
- Insufficient privileges. Issuing API key required  
- Insufficient privileges to create virtual cards.

#### 422
- Unprocessable entity.

#### 429
- Client has exceeded the number of allowed requests in a given time period.

## Example Request
```shell
curl --request GET \
     --url 'https://sandbox.lithic.com/v1/reports/settlement/details/report_date?page_size=50' \
     --header 'accept: application/json'
```

## Example Response
```json
{
  "data": [
    {
      "account_token": "6c25d6a4-4ff3-46f0-8f9b-f2cbb7e20e09",
      "card_program_token": "62135b36-324f-443a-a630-bab38fe86868",
      "card_token": "047298ea-5789-46e4-95fa-154aeeab6af3",
      "created": "2023-06-17T13:00:29.979106",
      "currency": "USD",
      "disputes_gross_amount": 0,
      "event_tokens": [
        "8fce9192-41ff-4a7a-8359-bd33b3e0a7c9"
      ],
      "institution": "00001",
      "interchange_fee_extended_precision": -70000,
      "interchange_gross_amount": -7,
      "network": "VISA",
      "other_fees_details": {},
      "other_fees_gross_amount": 0,
      "report_date": "2023-06-16",
      "settlement_date": "2023-06-16",
      "token": "e34a817f-119d-4976-9fb3-8b020b8bbec3",
      "transaction_token": "0e98152b-3753-4a17-bfe2-c6f575c83b85",
      "transactions_gross_amount": 1900,
      "type": "CLEARING",
      "updated": "2023-06-17T13:00:29.979106"
    }
  ],
  "has_more": false
}
```