---
title: "POST /get_fees"
method: POST
path: "/get_fees"
tags: ["Orders"]
---

# POST /get_fees

`POST /get_fees`

## Request

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

Retrieves the convenience fees associated with a <code>pnm_order_identifier</code> or a <code>site_order_identifier</code>. Results can be filtered by <code>payment_amount</code>, <code>payment_method_identifier</code>, <code>payment_type</code>, and <code>site_channel</code>.

## Request body

- union: Generate a listing of convenience fees for each payment method that this order supports.
  - object
    - `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.
    - `site_channel` 'agent' | 'agent_waived' | 'consumer' | 'consumer_ivr' | 'kiosk' | 'agent_recurring' | 'consumer_recurring', required: The payment channel where this payment will be created for this order.
    - `payment_amount` number: The payment amount for the order.
    - `payment_type` 'cash' | 'credit' | 'debit' | 'push_debit' | 'ach' | 'ach_push' | 'paypal' | 'paypal_push' | 'venmo_push' | 'cash_app': The type of payment method.
    - `payment_method_identifier` string: A unique, string ID that identifies a specific payment method.
    - `pnm_order_identifier` string, required: The unique, PayNearMe-defined identifier for this order
  - object
    - `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.
    - `site_channel` 'agent' | 'agent_waived' | 'consumer' | 'consumer_ivr' | 'kiosk' | 'agent_recurring' | 'consumer_recurring', required: The payment channel where this payment will be created for this order.
    - `payment_amount` number: The payment amount for the order.
    - `payment_type` 'cash' | 'credit' | 'debit' | 'push_debit' | 'ach' | 'ach_push' | 'paypal' | 'paypal_push' | 'venmo_push' | 'cash_app': The type of payment method.
    - `payment_method_identifier` string: A unique, string ID that identifies a specific payment method.
    - `site_order_identifier` string, required: An arbitrary string that the client uses to refer to an order

## Response `200`

Successful Operation

- union
  - object
    - `status` 'ok', required
    - `payment_methods` PaymentMethods[]
      - `type` 'ach' | 'ach_push' | 'apple_pay_credit' | 'apple_pay_debit' | 'cash_app' | 'credit' | 'debit' | 'gpay' | 'paypal' | 'paypal_push' | 'push_debit' | 'venmo' | 'venmo_push': The types of payment methods that can be used for this order. Payment methods prefixed or suffixed with <code>push</code> only display for disbursement orders.
      - `consumer_fee_amount` number: The default convenience fee amount that's paid to PayNearme for each transaction.
      - `consumer_fee_currency` string: USD
      - `merchant_fee_amount` number: The default convenience fee amount paid to the client for each transaction.
      - `merchant_fee_currency` string: USD
      - `total_fee_amount` number: The total amount of the default convenience fee paid by the consumer for each transaction.
      - `total_fee_currency` string: USD
      - `fee_amount` number: The convenience fee required to use this payment method.
      - `fee_currency` string: USD
      - `accounts` Accounts[]
        - `payment_method_identifier` string: The unique identifier (i.e., token) for the payment method account.
        - `status` 'active' | 'inactive': The status of the payment method.
        - `name` string: The name of the account holder for the payment method.
        - `description` string: A short description of the payment method.
        - `account_type` 'Business Checking' | 'Business Savings' | 'Credit' | 'Debit' | 'Personal Checking' | 'Personal Savings' | 'PrePaid': The type of payment method account.
        - `pull-enabled` string: If set to <code>true</code>, this payment method can be used for payments.
        - `push_enabled` string: If set to <code>true</code>, this payment method can be used for disbursements.
        - `number` string: The last four digits of the account number for credit, debit, and ACH payment methods.
        - `fee_amount` number: The convenience fee amount for this payment method.
        - `fee_currency` string: USD
        - `expiration_date` string: The expiration month and year in <i>MM/YYYY</i> format for credit and debit card payment methods.
        - `card_brand` string: The brand of the card for credit and debit card payment methods.
        - `pay_pal_account_id` string: The PayPal Account ID of the client.
        - `pay_pal_account_email` string: The email used with this PayPal account.
  - 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`: 3 breaking, 10 warning, 4 info
  - the request property `timestamp` became required
  - added `#/components/schemas/ErrorEnvelope, subschema #1` to the response body `oneOf` list for the response status `200`
  - the response's body type changed from `object` to no type for status `200`
  - removed the optional property `accounts` from the response with the `200` status
  - …13 more

[Operation history](https://skmtc.dev/paynearme/apis/paynearme-api-v3-0/changes/get_fees/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)
