---
title: "Get a payment"
method: GET
path: "/payments/{id}"
tags: ["Payments"]
---

# Get a payment

`GET /payments/{id}`

Retrieve a payment by ID.

The response includes all invoice applications and credit applications.

## Path parameters

- `id` string, required

## Query parameters

- `by` 'id' | 'key'

## Response `200`

Payment retrieved successfully

- Payment
  - `id` string, uuid, required
  - `key` string, nullable — Human-readable payment key
  - `customer` CustomerReference — Enhanced reference to a customer resource (returned in responses). Includes full customer details in addition to id/key. Note: Does NOT include nested references (paymentTerm, contacts, etc.) to prevent recursion. Maximum nesting depth: 1 level.
    - `id` string, uuid, required — Customer UUID
    - `key` string, nullable — Client-defined reference ID if set
    - `name` string, required — Customer company name
    - `friendlyId` string, required — Human-readable customer identifier
    - `status` 'PROSPECT' | 'ACTIVE' | 'INACTIVE' | 'CHURNED', required — Customer status
    - `phoneNumber` string, nullable — Primary phone number
    - `website` string, nullable — Customer website URL
    - `createdAt` string, date-time, required — When the customer was created
    - `updatedAt` string, date-time, required — When the customer was last updated
    - `deletedAt` string, date-time, nullable — When the customer was soft deleted (null if active)
  - `paymentDate` string, date, required — Date payment was received
  - `paymentMethodType` 'ACH_WIRE' | 'ZELLE' | 'VENMO' | 'CHECK' | 'EFT_DIRECT_DEPOSIT' | 'E_TRANSFER' | 'CREDIT_CARD' — Payment method type. - `ACH_WIRE`: ACH or wire transfer - `ZELLE`: Zelle payment - `VENMO`: Venmo payment - `CHECK`: Paper check - `EFT_DIRECT_DEPOSIT`: EFT direct deposit - `E_TRANSFER`: Electronic transfer - `CREDIT_CARD`: Credit card payment
  - `reference` string, nullable — Check number, transaction ID, etc.
  - `notes` string, nullable — Payment notes
  - `currency` string, nullable — Currency code
  - `totalAmount` number, required — Total payment amount
  - `applications` PaymentApplication[] — Invoices this payment is applied to
    - `id` string, uuid, required
    - `invoiceId` string, uuid, required
    - `invoiceFriendlyId` string, nullable
    - `invoiceAmount` number, nullable — Total invoice amount
    - `invoiceOpenBalance` number, nullable — Invoice balance before this payment
    - `amount` number, required — Amount applied to this invoice
  - `creditApplications` PaymentCreditApplication[] — Credits applied in this payment
    - `id` string, uuid
    - `creditMemoId` string, uuid
    - `creditMemoReference` string, nullable
    - `amount` number — Credit amount applied in this payment
  - `overpaymentAmount` number, nullable — Amount in excess of invoice totals
  - `overpaymentCreditMemoId` string, uuid, nullable — Credit memo created from overpayment
  - `shipmentIds` string[] — Related shipment IDs
  - `shipmentKeys` string[] — Related shipment friendly IDs
  - `qboId` string, nullable — QuickBooks Online payment ID
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, nullable

## Other responses

- `401` — Unauthorized - invalid or missing access token
- `404` — Resource not found

---

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