Sign in

v1

latestOpenAPI 3.0.12026-07-264182324.3 KB
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.

post/find_payment_methods

Request body

OR
OR
OR

Example request

{
  "pnm_order_identifier": "84338052224"
}

Response

Payment Method Found

payment_method_identifierstring

The unique identifier (i.e., token) for the payment method account.

status'active' | 'inactive'

The status of the payment method.

namestring

The name of the account holder for the payment method.

descriptionstring

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-enabledstring

If set to <code>true</code>, this payment method can be used for payments.

push_enabledstring

If set to <code>true</code>, this payment method can be used for disbursements.

numberstring

The last four digits of the account number for credit, debit, and ACH payment methods.

fee_amountnumber

The convenience fee amount for this payment method.

fee_currencystring

USD

expiration_datestring

The expiration month and year in <i>MM/YYYY</i> format for credit and debit card payment methods.

card_brandstring

The brand of the card for credit and debit card payment methods.

pay_pal_account_idstring

The PayPal Account ID of the client.

pay_pal_account_emailstring

The email used with this PayPal account.

Example response

{
  "payment_method_identifier": "f9d5c9076006b",
  "name": "John Smith",
  "description": "Debit Card",
  "pull-enabled": "true",
  "push_enabled": "true",
  "number": "6666",
  "fee_amount": 3,
  "fee_currency": "USD",
  "expiration_date": "12/2025",
  "card_brand": "Visa",
  "pay_pal_account_id": "YB6935G4PHS92",
  "pay_pal_account_email": "buyer@paynearme.com"
}