---
title: "POST /find_payment_methods"
method: POST
path: "/find_payment_methods"
tags: ["Payment Methods"]
---

# POST /find_payment_methods

`POST /find_payment_methods`

To find a payment methods associated with a specific order, use one of the following values to search:<ul><li><code>pnm_order_identifier</code></li><li><code>site_order_identifier</code></li></ul></br>To find all payment methods for a specific customer, use one of the following values:<ul><li><code>pnm_customer_identifier</code></li><li><code>site_customer_identifier</code></li></ul></br>You can also use the <code>site_creator_identifier</code> parameter to search for payment methods.

## Request body

- union — Find payment methods associated with order identifiers, customer identifiers, or site creator identifiers.
  - 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, required — 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.
    - `site_creator_identifier` string — A unique string used to identify the creator of the order.
    - `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.
    - `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, required — 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.
    - `site_creator_identifier` string — A unique string used to identify the creator of the order.
    - `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_order_identifier` string, required — An arbitrary string that the client uses to refer to an 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, required — 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.
    - `site_creator_identifier` string — A unique string used to identify the creator of the order.
    - `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.
    - `pnm_customer_identifier` string, required — A unique PNM-defined ID for the consumer.
  - 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, required — 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.
    - `site_creator_identifier` string — A unique string used to identify the creator of the order.
    - `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_customer_identifier` string, required — A unique, client-defined ID for the consumer.

## Response `201`

Payment Method Found

- Accounts — The Accounts object lists the customer's payment account(s) that were created for this order.
  - `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.

---

[API](https://skmtc.net/paynearme/apis/paynearme-api-v3-0.md) · [All operations](https://skmtc.net/paynearme/apis/paynearme-api-v3-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/paynearme/paynearme-api-v3-0/revisions/44cba4f8b80f/schema)