---
title: "Get invoice payment by ID"
method: GET
path: "/v3/customers/{id}/invoices/{invoiceId}/payments/{paymentId}"
tags: ["Customers"]
---

# Get invoice payment by ID

`GET /v3/customers/{id}/invoices/{invoiceId}/payments/{paymentId}`

## Request

- Base URL: `https://integrators.prod.api.tabsplatform.com`
- URL: `https://integrators.prod.api.tabsplatform.com/v3/customers/{id}/invoices/{invoiceId}/payments/{paymentId}`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/tabsplatform/apis/tabs-external-api/docs/v3/customers/:id/invoices/:invoiceId/payments/:paymentId/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `id` string, required
- `invoiceId` string, required
- `paymentId` string, required

## Response `200`

The payment

- object
  - `payload` object, required: Response payload, will be empty when success is false
    - `id` string, required: Unique identifier of the payment
    - `invoiceId` string, required: List of invoices associated with this payment
    - `total` number, required: Total amount of the payment
    - `stripeId` string: Stripe payment ID if payment was processed through Stripe
    - `receivedAt` string, date-time, required: Date when payment was received
    - `status` 'OPEN' | 'COMPLETED' | 'EXPIRED' | 'FAILED' | 'CANCELED' | 'UNCOLLECTIBLE', required: Current status of the payment
    - `type` 'MANUAL' | 'STRIPE' | 'RECONCILIATION' | 'REFUND' | 'CREDIT_MEMO_FROM_ERP', required: Type of payment
    - `reference` string: Payment reference number
    - `method` 'CREDIT_CARD' | 'ACH_DEBIT' | 'ACH_CREDIT' | 'CHECK' | 'LINK', required: Payment method used
    - `externalIds` IntegrationsExternalId[], required: List of external system identifiers
      - `type` 'QUICKBOOKS' | 'NETSUITE' | 'RILLET' | 'SAGE_INTACCT' | 'SALESFORCE' | 'HUBSPOT' | 'AVALARA' | 'ANROK' | 'STRIPE', required
      - `id` string, required: External identifier value
  - `success` boolean, required: Boolean with true=success, false=failure
  - `message` string, required: Plain-text description of the result
  - `error` IntegratorsApiError, required
    - `code` number, required: API response code
    - `message` string, required: API response message
    - `details` object: Additional details about the error

## Other responses

- `404`: Payment not found

---

[API](https://skmtc.dev/tabsplatform/apis/tabs-external-api.md) - [All operations](https://skmtc.dev/tabsplatform/apis/tabs-external-api/llms.txt) - [OpenAPI document](https://skmtc.dev/tabsplatform/apis/tabs-external-api/revisions/7e8885517814?raw)