---
title: "Payment Summary Response"
url: "https://developer.retailexpress.com.au/apis/public-api-0/versions/d2454f6f-56f1-4fd6-9cd1-82871d94bd1c/schemas/PaymentSummaryResponse"
---

> Full API specification: https://developer.retailexpress.com.au/apis/public-api-0/versions/d2454f6f-56f1-4fd6-9cd1-82871d94bd1c.md

# Payment Summary Response

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: PublicApi
  version: 0.1.0
servers:
  - url: https://api.retailexpress.com.au/{basePath}
    variables:
      basePath:
        default: v1
components:
  schemas:
    PaymentSummary:
      title: Payment Summary
      type: object
      properties:
        store_id:
          title: Store ID
          type: string
          description: The ID of the store within this system
        reference:
          title: Reference
          type: string
          description: the reference for the payment
        date:
          title: Date
          type: string
          description: The date of the summary
          format: date
        amount:
          title: Amount
          type: number
          description: The amount of the payment
        payment_method_id:
          title: Payment Method ID
          type: string
          description: The ID of the payment method within this system
        id:
          title: ID
          type: string
          description: The ID of the record
        transaction_type:
          title: Transaction Type
          type: string
          description: The ID of the transaction type within this system
        payment_date:
          title: Payment Date
          type: string
          description: The payment date of the payment
          format: date
      description: A summary of payments
    PageNumber:
      title: Page Number
      type: integer
      description: The current page number
    TotalRecords:
      title: Total Record Count
      type: integer
      description: The total number of records in your query
    TotalPages:
      title: Total Page Count
      type: integer
      description: The total number of pages in your query
    PageSize:
      title: Page Size
      type: integer
      description: The maximum number of records in a single page
    PaymentSummaryResponse:
      title: Payment Summary Response
      type: object
      properties:
        summary_lines:
          type: array
          description: A list of payments summaries
          items:
            $ref: "#/components/schemas/PaymentSummary"
        page_number:
          $ref: "#/components/schemas/PageNumber"
        total_records:
          $ref: "#/components/schemas/TotalRecords"
        total_pages:
          $ref: "#/components/schemas/TotalPages"
        page_size:
          $ref: "#/components/schemas/PageSize"
```