---
title: "Get payment by external id"
method: GET
path: "/payments"
---

# Get payment by external id

`GET /payments`

## Request

- Base URL: `https://api.sandbox.cleeng.com/3.1`
- URL: `https://api.sandbox.cleeng.com/3.1/payments`
- Auth: API key in header `X-Publisher-Token`

## Query parameters

- `externalId` string, required

## Headers

- `Content-Type` string

## Response `200`

200

- object
  - `success` boolean
  - `payments` object[]
    - `id` integer
    - `orderId` integer
    - `status` string
    - `totalAmount` number
    - `currency` string
    - `customerId` integer
    - `paymentGateway` string
    - `paymentMethod` string
    - `externalPaymentId` string
    - `couponId` integer
    - `amount` number
    - `country` string
    - `offerType` string
    - `taxValue` number
    - `paymentMethodFee` number
    - `customerServiceFee` integer
    - `rejectedReason` unknown
    - `refundedReason` unknown
    - `paymentDetailsId` unknown
    - `paymentOperation` string
  - `message` string

---

[API](https://skmtc.dev/cleeng/apis/api-31.md) - [All operations](https://skmtc.dev/cleeng/apis/api-31/llms.txt) - [OpenAPI document](https://skmtc.dev/cleeng/apis/api-31/revisions/df55396cda4f?raw)