---
title: "POST /find_payment"
method: POST
path: "/find_payment"
tags: ["Payments"]
---

# POST /find_payment

`POST /find_payment`

## Request

- Base URL: `https://api.paynearme-sandbox.com/json-api`
- URL: `https://api.paynearme-sandbox.com/json-api/find_payment`
- Auth: one of:
  - OAuth 2
    - Client credentials
    - Token URL: `https://login.paynearme.com/oauth/token`
  - API key in query parameter `signature`

Use the <code>pnm_payment_identifier</code> to find a specific payment record.

## Request body

- FindPayment: Find a specified payment record.
  - `site_identifier` string, required: Identifies your client site.
  - `timestamp` string, required: The Unix Epoch time of the call
  - `version` string, required: The version of the API. This version must match the version associated with your API key pair.
  - `signature` string: The HMAC signature that is calculated by running your API Secret Key and the alphabetized, concatenated parameters of the request payload through the SHA256 message digest algorithm. **NOTE:** This field is required when authenticating with the HMAC signature method; it is not required when authenticating with OAuth 2.0.
  - `pnm_payment_identifier` string, required: The unique, PayNearMe-created identifier for this payment.

## Response `200`

Payment Found

- union
  - object
    - `status` 'ok', required
    - `payment` Payment: The Payments object lists every payment submitted for the order and includes the payment's settlement status in the Merchant Settlements object.
      - `payment_made` string, date-time: The date and time when the customer made the payment.
      - `payment_amount` number: The total amount of the payment including convenience fees.
      - `payment_currency` string: USD
      - `payment_status` 'approved' | 'authorized' | 'canceled' | 'refunded' | 'rejected' | 'waiting for review' | 'pending' | 'returned' | 'scheduled' | 'cancelled': The status of the payment.
      - `payment_type` 'ach' | 'ach_push' | 'cash' | 'cash_app' | 'credit' | 'debit' | 'paypal' | 'paypal-push' | 'pin4' | 'push-debit' | 'venmo' | 'venmo-push': The type of payment method used for the transaction. Payment methods prefixed or suffixed with <code>push</code> are for disbursement transactions.
      - `payment_account` string: A short description of the payment method.
      - `payment_method_identifier` string: A unique ID for the payment method.
      - `net_payment_amount` number: The payment amount that is settled to the consumer after all client, retailer (if applicable), and PayNearMe fees have been taken out.
      - `net_payment_currency` string: USD
      - `payment_processing_fee` number: The fee amount charged for processing the transaction.
      - `payment_processing_fee_currency` string: USD
      - `pnm_processing_fee` number: The fee amount that PayNearMe charges for processing the transaction.
      - `pnm_processing_fee_currency` string: USD
      - `settled_to_site` string: If set to <code>true</code>, the payment has been settled to the client's account.
      - `date_settled_to_merchant` string, date: The date in <i>YYYY-MM-DD</i> format when the payment was settled to the client.
      - `pnm_payment_identifier` string: A unique string identifier for the payment.
      - `retailer_identifier` string: A unique PayNearMe-assigned ID for a retailer.
      - `pricing_schedule_name` string: Specifies the name of the pricing schedule (e.g.,<code>agent</code>, <code>agent_recurring</code>, <code>consumer</code>, <code>consumer_recurring</code>,<code>consumer_ivr</code>). Supported values can include site-configured pricing schedules.
      - `site_channel` 'agent' | 'agent_waived' | 'consumer' | 'consumer_ivr' | 'kiosk' | 'agent_recurring' | 'consumer_recurring': The payment channel where this payment was created.
      - `payment_receipt_text` string: Custom text that can be returned in the authorization callback response. Up to 75 lines of 40 character each can be included.
      - `merchant_settlements` MerchantSettlements: The Merchant Settlements object indicates where and for how much a payment was settled.
        - `settlement_method_identifier` string: A unique, PayNearMe-provided ID for the settlement.
        - `settlement_type` 'net_payment' | 'gross_payment': Indicates whether the settlment is a <code>net_payment</code> or a <code>gross_payment</code>.
        - `settlement_amount` number: The amount to be settled
        - `settlement_currency` string: USD
      - `refund` Refund: The Refund object indicates the status of the payment refund.
        - `refund_status` 'started' | 'completed': The status of the refund. Supported options include <code>started</code> and <code>completed</code>.
        - `refund_amount` string: The amount to be refunded.
        - `refund_currency` string: USD
        - `unsettle_to_merchant_amount` string: The amount that will be unsettled from the client account (i.e., the payment amount less the convenience fee)
        - `unsettle_to_merchant_currency` string: USD
        - `unsettled_from_collector_amount` string: The amount that will be unsettled from the collector (if applicable).
  - ErrorEnvelope: Returned with HTTP 200 for every failure except a rejected OAuth 2.0 access token, which returns HTTP 401 with the same shape. Every response carries a status; on failure it is "error" and the errors array describes what went wrong.
    - `status` 'error', required
    - `errors` ErrorDetail[], required: One entry per failure.
      - `description` string, required: Human-readable description of the failure.
      - `message` string: Parameter-validation detail (APPS-17178).
      - `receipt` string: Receipt text, where the failure relates to a payment.
      - `format` string: Expected format, for parameter-validation failures.
      - `example` string: Example of a well-formed value.
      - `details` object: Processor response details (APPS-18223).

## Other responses

- `401`: OAuth 2.0 requests only. The `Authorization` header has no Bearer token, the access token is invalid, expired, or issued for a different site, or the `site_identifier` does not match any site. The response does not say which. If the request is rejected before it reaches PayNearMe, the body may not be JSON, so detect this error by the HTTP status. HMAC-signed requests never receive this status.

## Changes

- **2026-11-03** `907541f733a3`: 1 breaking, 4 info
  - removed the success response with the status `201`
  - api operation id `find_payment` was added
  - the request property `signature` became optional
  - added the non-success response with the status `401`
  - …1 more

[Operation history](https://skmtc.dev/paynearme/apis/paynearme-api-v3-0/changes/find_payment/post.md)

---

[API](https://skmtc.dev/paynearme/apis/paynearme-api-v3-0.md) - [All operations](https://skmtc.dev/paynearme/apis/paynearme-api-v3-0/llms.txt) - [OpenAPI document](https://skmtc.dev/paynearme/apis/paynearme-api-v3-0/revisions/907541f733a3?raw)
