> ## Documentation Index
> Fetch the complete documentation index at: https://dev.schoolcues.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve a payment

> One payment, by ID. Needs an API key that can read payments (`payments:read`).



## OpenAPI

````yaml /reference/api.json get /api/school/v1/payments/{id}
openapi: 3.1.0
info:
  title: SchoolCues API
  version: '1'
  description: >-
    Read a school’s students, contacts, staff, classes and payments, and hear
    when they change. Generated from @schoolcues/contracts by `pnpm docs:api`;
    don't edit it by hand.
servers:
  - url: https://portal.schoolcues.com
    description: Production
security:
  - apiKey: []
tags:
  - name: Students
  - name: Contacts
  - name: Staff
  - name: Classes
  - name: Payments
  - name: Webhooks
paths:
  /api/school/v1/payments/{id}:
    get:
      tags:
        - Payments
      summary: Retrieve a payment
      description: >-
        One payment, by ID. Needs an API key that can read payments
        (`payments:read`).
      operationId: retrieve_payment
      parameters:
        - name: id
          in: path
          required: true
          description: The payment’s ID.
          schema:
            type: string
      responses:
        '200':
          description: The payment.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/SchoolApiPayment'
                required:
                  - data
        '401':
          description: >-
            The key or token is missing, revoked or expired. Ask the school for
            a new one.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The key can’t read this resource. Ask the school for a key that can.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: The resource or record doesn’t exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: >-
            SchoolCues couldn’t check the key just now. Retry after a short
            wait.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    SchoolApiPayment:
      type: object
      properties:
        id:
          type: string
          description: The record's ID.
        accountId:
          type: string
          description: The family account it was paid to.
        accountName:
          type: string
          description: The family account's name.
        payerName:
          type: string
          description: Who paid.
        amountCents:
          type: number
          description: The amount, in the currency's smallest unit, such as cents.
        currency:
          type: string
          description: The currency, as an ISO 4217 code such as `USD`.
        method:
          type: string
          description: How it was paid.
        purpose:
          type: string
          description: What it was for.
        receivedAt:
          type: string
          description: When it was received, in ISO 8601 (UTC).
        createdAt:
          type: string
          description: When the record was created, in ISO 8601 (UTC).
        updatedAt:
          type: string
          description: >-
            When the record last changed, in ISO 8601 (UTC). Lists are in this
            order, oldest first.
      required:
        - id
        - accountId
        - accountName
        - payerName
        - amountCents
        - currency
        - method
        - purpose
        - receivedAt
        - createdAt
        - updatedAt
      description: A receipt for money the school received. Needs `payments:read`.
    Error:
      type: object
      description: Why the request was refused.
      properties:
        statusCode:
          type: integer
          description: The HTTP status.
        statusMessage:
          type: string
          description: What went wrong, in words to show.
      required:
        - statusCode
        - statusMessage
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        One of the school’s API keys, from [Settings › Integrations ›
        API](https://portal.schoolcues.com/settings/integrations/api).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.