---
title: "Get a payment"
method: GET
path: "/v1/payments/{paymentId}"
tags: ["PAYMENTS"]
---

# Get a payment

`GET /v1/payments/{paymentId}`

Get information about a payment by specifying its Clover payment UUID.

## Path parameters

- `paymentId` string, required

## Headers

- `User-Agent` string, required
- `X-Clover-Device-Id` string, required
- `X-POS-Id` string, required
- `X-Clover-Timeout` integer

## Response `200`

A valid PaymentResponse

- PaymentResponse
  - `payment` Payment
    - `additionalCharges` AdditionalChargeAmount[]
      - `amount` integer — Amount of the additional charge
      - `id` string — Additional charge id
      - `type` 'INTERAC' | 'CREDIT_SURCHARGE' | 'CONVENIENCE_FEE' | 'INTERAC_V2'
    - `amount` integer
    - `cardTransaction` CardTransaction
      - `cardholderName` string
      - `first6` string, ###### — The first 6 digits
      - `last4` string, #### — The last 4 digits
    - `cashbackAmount` integer — Amount given back in a cash back transaction
    - `createdTime` integer — Time payment was recorded on server
    - `dccInfo` DCCInfo
      - `baseAmount` integer
      - `baseCurrencyCode` string
      - `dccApplied` boolean
      - `dccEligible` boolean
      - `exchangeRate` number, double
      - `exchangeRateId` string
      - `exchangeRateSourceName` string
      - `exchangeRateSourceTimeStamp` string
      - `foreignAmount` integer
      - `foreignCurrencyCode` string
      - `inquiryRateId` integer
      - `marginRatePercentage` string
      - `rateRequestId` string
    - `device` Reference
      - `id` string — Unique identifier
    - `employee` Reference
      - `id` string — Unique identifier
    - `externalPaymentId` string — A unique id assigned by the POS to identify this transaction. Critical for reconciliation and recovery.
    - `externalReferenceId` string — The external reference id if associated with the payment
    - `id` string — Unique identifier
    - `modifiedTime` integer — Last modified time of the payment
    - `note` string
    - `offline` boolean
    - `order` Reference
      - `id` string — Unique identifier
    - `refunds` Refund[]
      - `additionalCharges` AdditionalChargeAmount[]
        - `amount` integer — Amount of the additional charge
        - `id` string — Additional charge id
        - `type` 'INTERAC' | 'CREDIT_SURCHARGE' | 'CONVENIENCE_FEE' | 'INTERAC_V2'
      - `amount` integer — Total amount refunded, including tax and tip
      - `cardTransaction` CardTransaction
        - `cardholderName` string
        - `first6` string, ###### — The first 6 digits
        - `last4` string, #### — The last 4 digits
      - `createdTime` integer — The time when the refund was recorded on the server
      - `device` Reference
        - `id` string — Unique identifier
      - `employee` Reference
        - `id` string — Unique identifier
      - `externalReferenceId` string — The external reference id if associated with the refund
      - `id` string — Unique identifier
      - `orderRef` Reference
        - `id` string — Unique identifier
      - `payment` Reference
        - `id` string — Unique identifier
      - `taxAmount` integer — Tax amount refunded
      - `tipAmount` integer — Tip amount refunded
      - `voidReason` 'USER_CANCEL' | 'TRANSPORT_ERROR' | 'REJECT_SIGNATURE' | 'REJECT_PARTIAL_AUTH' | 'NOT_APPROVED' | 'FAILED' | 'AUTH_CLOSED_NEW_CARD' | 'DEVELOPER_PAY_PARTIAL_AUTH' | 'REJECT_DUPLICATE' | 'REJECT_OFFLINE' | 'GIFTCARD_LOAD_FAILED' | 'USER_GIFTCARD_LOAD_CANCEL' | 'DEVELOPER_PAY_TIP_ADJUST_FAILED' | 'USER_CUSTOMER_CANCEL' | 'FRAUD'
      - `voided` boolean
    - `result` 'SUCCESS' | 'FAIL' | 'INITIATED' | 'VOIDED' | 'VOIDING' | 'VOID_FAILED' | 'AUTH' | 'AUTH_COMPLETED' | 'DISCOUNT'
    - `taxAmount` integer — Amount paid in tax
    - `tipAmount` integer — Amount paid in tips
    - `voidPaymentRef` Reference
      - `id` string — Unique identifier
    - `voidReason` 'USER_CANCEL' | 'TRANSPORT_ERROR' | 'REJECT_SIGNATURE' | 'REJECT_PARTIAL_AUTH' | 'NOT_APPROVED' | 'FAILED' | 'AUTH_CLOSED_NEW_CARD' | 'DEVELOPER_PAY_PARTIAL_AUTH' | 'REJECT_DUPLICATE' | 'REJECT_OFFLINE' | 'GIFTCARD_LOAD_FAILED' | 'USER_GIFTCARD_LOAD_CANCEL' | 'DEVELOPER_PAY_TIP_ADJUST_FAILED' | 'USER_CUSTOMER_CANCEL' | 'FRAUD'

## Other responses

- `209` — Operation was canceled.
- `400` — The request is invalid, and subsequent calls will continue to fail; do not repeat the call.
- `401` — An invalid bearer token has been provided. The call may be repeated if the provided bearer token is updated.
- `415` — The request is invalid, and contains request data in an unsupported format. This call may be repeated if the content is changed to a supported format.
- `500` — The request processing failed with an unknown error, and the processing state of the operation is indeterminate. Do not repeat the call without additional analysis.
- `501` — The device does not have the ability to respond to the requested operation; do not repeat the call.
- `503` — The device is not available because it is currently servicing another call. This can be repeated at a later time, or cancel may be called to end the current operation.
- `504` — The Device did not respond in a timely manner. This can be repeated at a later time.

---

[API](https://skmtc.net/clover/apis/platform-api.md) · [All operations](https://skmtc.net/clover/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/clover/platform-api/versions/08da265101a3/schema)