timestamp

The Unix Epoch time of the call

string

site_customer_identifier

A unique string ID the merchant creates to identify consumers.

string

site_order_identifier

A unique string ID the merchant creates to identify the order.

string

pnm_order_identifier

The unique, PayNearMe-generated ID for this order.

string

version

The version of the API. The Schedule Authorization callback is only available in API version 3.0.

string

schedule_type

Indicates the type of scheduled payment. Supported options include the following:

• Autopay
• One-Time

enum

pnm_schedule_identifier

A PayNearMe-defined ID for the schedule (either recurring or one-time).

string

pricing_schedule_name

Specifies the pricing category associated with the payment. Supported options include the following:

• agent
• agent_waived
• consumer_recurring
• agent_recurring
• consumer
• consumer_ivr kiosk

enum

status

Indicates the status of the scheduled payment. Supported options include the following:

• active
• pending
• inactive

enum

origin

Indicates who created the scheduled payment. Supported options include the following:

• merchant
• consumer

enum

customer_contact

Displays the redacted mobile phone or email address of the consumer.

string

agent_name

For payments where orgin=merchant, this parameter displays the name of the Customer Service agent that created the scheduled payment on behalf of the consumer.

string

agent_email

For payments where orgin=merchant, this parameter displays the email address of the Customer Service agent that created the scheduled payment on behalf of the consumer.

string

pay_amount_due

Indicates whether or not each scheduled payment will be the amount due for each bill (i.e., dynamically change for each billing cycle)

bool

payment_amount

The total payment amount the consumer submitted online or paid to the retailer.

dec

start_date

Indicates the start date of the recurring schedule or the date when the scheduled payment will be made in YYYY-MM-DD format.

string

frequency

The frequency of the autopay. Supported options include the following:

• weekly
• biweekly
• monthly
• twice_monthly
• end_of_month
• due_date_monthly

enum

duration

The duration of the autopay schedule. Supported options include the following:

• indefinite
• number_of_recurrences
• end_date
• paid_in_full

enum

schedule_description

Provides a description of the autopay schedule's frequency. Supported options include the following:

• every <Monday-Sunday> (i.e., weekly)
• every other <Monday - Sunday> (i.e., biweekly)
• the <1-31> of every month (i.e., monthly)
• the <1-31> and <1-31> of every month (i.e., twice_monthly)
• the last day of the month (i.e., end_of_month)

enum

payment_method_type

The type of payment method used for this scheduled payment. Supported options include the following:

• ach
• card
• cash_app
• paypal
• venmo

enum

payment_method_description

A short description of the payment method plus the last four digits of the account number (e.g., Debit Card 4466, Bank of New York Mellon 5955 (Business Savings))

string

pnm_payment_method_identifier

The PayNearMe-defined ID of the payment method.

string

payment_method_card_brand

For card payment methods, this parameter displays the branded name for the card (e.g., Debit Card, Credit Card)

string

payment_method_card_last4

For card payment methods, this parameter displays the last four digits of the card PAN.

string

payment_method_card_network

For card payment methods, this parameter displays the card network used for processing payments made with this card (e.g., Pulse, Mastercard, Visa)

string

payment_method_bank_name

For ach payment methods, this parameter displays the name of the consumer's bank.

string

payment_method_bank_last4

For ach payment methods, this parameter displays the last four digits of the consumer's bank account.

string

payment_method_bank_account_type

For ach payment methods, this parameter displays the type of bank account the consumer is using for this payment. Supported options include the following:

• Checking
• Savings

enum

payment_method_bank_routing_number

For ach payment methods, this parameter displays the routing number of the consumer's bank.

string

site_identifier

The ID that identifies your client site.

string

signature

The HMAC signature of the callback (v3.0) or the MD5 signature of the callback (v2.0) used to authenticate it as a genuine PayNearMe callback.

string

pnm_schedule_identifier

The unique, PayNearMe-generated ID for this schedule.

string

R

version

The version of the API. The Schedule Authorization callback is only available in API version 3.0.

string

R

accept_schedule

Indicates whether you want to accept the schedule. Supported values for this field include the following: 

• yes
• no

enum

R

site_schedule_payment_method_identifier

An arbitrary, client-defined string that identifies the schedule in the client's system. NOTE: This parameter is only required for authorized schedules.

string

R

decline_reason

A short description of why the schedule was not authorized. NOTE: This parameter is only required for unauthorized schedules.

string

R

memo

A customized text string that indicates if the schedule was authorized and, if not, the reason the authorization was declined.

string

O