Sign in

v1

latestOpenAPI 3.0.12026-07-264182324.3 KB
Payment Methods

Use the <code>/update_payment_method</code> endpoint to retire or deactivate a payment method.<h2>Retiring a Payment Method</h2> When a payment method is "retired" <ul><li>The <code>payment_method_identifier</code> will not be returned in the <code>/find_order</code> or <code>/find_payment_methods</code> responses</li><li>The payment method will not display in the PayNearMe Business Portal, Agent Interface, or on the Select Payment Method screen of the Consumer Portal</li><li>The retired <code>payment_method_identifier</code> can be used in the <code>/make_payment</code> call to complete a payment.</li></ul> Use <code>retire_payment_method=true</code> to retire the payment method in either the <code>/create_payment_method</code> or <code>/update_payment_method</code> calls. To "unretire" a payment method so that it will display again in the places listed above, use <code>retire_payment_method=false</code>. <h2>Deactivating a Payment Method</h2>When a payment method is "deactivated" <ul><li>The <code>payment_method_identifier</code> will not be returned in the <code>/find_order</code> or <code>/find_payment_methods</code> responses.</li><li>The payment method will not display on the Select Payment Method screen of the Consumer Portal.</li><li>The payment method will display as <b>Inactive</b> in the PayNearMe Business Portal and Agent Interface.</li><li>The deactivated <code>payment_method_identifier</code> will automatically decline payments for all transaction attempts.</li><li>The deactivated payment method cannot be reactivated by submitting <code>deactivate_payment_method=false</code>. It can only be reactivated by re-adding it via the <code>/create_payment_method</code> endpoint.</li></ul> To deactivate a payment method, use <code>deactivate_payment_method=true</code>.

post/update_payment_method

Request body

site_identifierstring required

Identifies your client site.

timestampstring required

The Unix Epoch time of the call

versionstring required

The version of the API. This version must match the version associated with your API key pair.

signaturestring 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.

payment_method_identifierstring

A unique, string ID that identifies a specific payment method.

retire_payment_methodstring

Pass <code>true</code> to indicate if you want to retire a payment method. Retired payment methods are not returned in the <code>payment_methods</code> block of the order object, but can be used for payments.

deactivate_payment_methodstring

Pass <code>true</code> to indicate if you want to deactivate the payment method. Deactivated payment methods are not returned in the <code>payment_methods</code> block of the order object and cannot be used for payments.

Response

Payment Method Updated

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"
}