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

# POST /vet_payment_method

`POST /vet_payment_method`

## Request

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

Validates whether a consumer has entered a valid ABA/routing number or card number. Use this endpoint when you want to validate payment method information before collecting additional details (e.g., in an IVR flow).</br></br>ACH routing numbers are validated using a table lookup against the Federal Reserve's database of valid routing numbers. Credit and debit cards are validated using the Luhn checksum algorithm. Submit only one of <code>payment_method_ach_aba_pii</code> or <code>payment_method_card_number_pii</code> per request.

## Request body

- union: Validates an ABA/routing number or card number. Submit only one of <code>payment_method_ach_aba_pii</code> or <code>payment_method_card_number_pii</code> per request. ACH validation uses a table lookup against the Federal Reserve database. Card validation uses the Luhn checksum algorithm.
  - 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.
    - `payment_method_ach_aba_pii` string, required: The 9-digit ABA/routing number to validate.
  - 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.
    - `payment_method_card_number_pii` string, required: The credit or debit card number (PAN) to validate. Validation uses the Luhn checksum algorithm.

## Response `200`

Payment Method Valid

- union
  - VetPaymentMethodResponse
    - `status` 'ok': The status of the validation request.
  - 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`: 2 breaking, 2 warning, 5 info
  - added `#/components/schemas/vet_payment_method_response, #/components/schemas/ErrorEnvelope` 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 `errors` from the response with the `200` status
  - removed the optional property `status` from the response with the `200` status
  - …5 more

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