Order Change callbacks track the changes to orders, payments, and schedules throughout the PayNearMe platform. These include changes that occur in the PayNearMe Consumer Portal (i.e., CF), Embedded Client, Business Portal, API, Agent Interface, or from a client's business rules or PayNearMe's risk rules. To configure the callback, the you need to work with your PayNearMe Technical Account Manager (TAM) to define what changes to monitor. Once configured, the callback evaluates the original values of an order, payment, or scheduled payment before and after a consumer, agent, or the API interacts with the order or a configured business rule or risk rule changes the order by blocking a payment. Any changes to the monitored values in the order will trigger the callback.

Defining the Changes to Monitor

The Order Change callback can be configured to monitor the following changes:

Change Event	Location	Change Event Name
Scheduled One-Time Payment is Created	Customer Portal Embedded Client Agent Interface Embedded Form API	`consumer_schedule_one_time` `agent_schedule_one_time` `api_schedule_one_time`
Scheduled One-Time Payment is Canceled	Customer Portal Embedded Client Agent Interface API	`agent_cancel_one_time` `consumer_cancel_one_time` `api_cancel_one_time`
Recurring Autopay Schedule is Created	Customer Portal Embedded Client Agent Interface Embedded Form API	`agent_schedule_recurring` `consumer_schedule_recurring` `api_schedule_recurring`
Autopay Schedule is Canceled	Customer Portal Embedded Client Agent Interface API	`agent_cancel_recurring` `consumer_cancel_recurring` `api_cancel_recurring`
Autopay Payment is Skipped	Customer Portal Embedded Client Agent Interface API	`agent_skip_recurring` `consumer_skip_recurring` `api_skip_recurring`
Autopay Payment Amount is Changed	API	`api_update_recurring`
Consumer Authorizes a Recurring Autopay Schedule	Consumer Portal	`consumer_confirm_recurring`
Mute and Unmute PCI-Sensitive Conversations when Agents Record Calls	Agent Interface Embedded Form	`mute_recording` `unmute_recording`
Payment Method is Created or Selected	Customer Portal Embedded Client Agent Interface	N/A
Disbursement is Initiated	Embedded Client Agent Interface	N/A
Disbursement is Approved	Embedded Client Agent Interface	N/A
Scheduled Payment (autopay or one-time, future-dated) is Canceled by Business Rule	N/A	`business_rule_cancel_one_time` `business_rule_cancel_recurring`
Scheduled Payment (autopay or one-time, future-dated) is Canceled by Risk Rule (i.e., Invalid Payment Method)	N/A	`payment_account_cancel_recurring` `payment_account_cancel_one_time`
Retry of a Scheduled Payment (autopay or one-time, future-dated) is Canceled via API	API	`api_cancel_retry_recurring` `api_cancel_retry_one_time`
Retry of a Scheduled Payment (autopay or one-time, future-dated) is Canceled by Agent	Agent Interface	`agent_cancel_retry_recurring` `agent_cancel_retry_one_time`
Agent Updates the Account Notes in the Agent Interface	Embedded Form Agent Interface	NOTE: Agent Notes are added to the Order Change Callback as a parameter in the request payload when an agent makes a scheduled payment or creates a recurring schedule on behalf of a consumer in the Agent Interface.

Understanding the Callback Payload

The payload of the Order Change callback depends on the changes the merchant wants to monitor. All Order Change callbacks will contain the following parameters:

site_identifier
site_customer_identifier
site_order_identifier
timestamp
version
pnm_order_identifier
payee_identifier
origin

🚧
Signature Considerations
When calculating the signature for a callback, PayNearMe does NOT include the one_time_pay_json, auto_pay_json, and pnm_selected_payment_method_json object arrays. Do not include these parameters in your signature calculations when validating Order Change callbacks from PayNearMe.

The following table provides all the potential parameters that could be included in the Order Change callback payload:

Parameter	Description	Type
`site_identifier`	The ID that identifies your merchant site.	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
`timestamp`	The Unix Epoch time of the call.	string
`version`	The version of the API you’re using.	string
`pnm_order_identifier`	The unique, PayNearMe-generated ID for this order.	string
`payment`	The total payment amount the consumer submitted online or paid to the retailer.	num
`payee_identifier`	The Site ID of the merchant accepting the payment	num
`origin`	Indicates from where the consumer submitted his/her changes. Supported values include the following: `ef_agent` (Embedded Form) `Consumer Flow` `PNM Now` (Agent Interface) `API`	enum
`agent`	The identifier of the agent who completed this action.	string
`agent_notes`	If enabled, the notes that the agent included when making a payment or creating a schedule on behalf of the consumer in either the Agent Interface or the Embedded Form. Updating notes in the Agent Interface will trigger the Order Change Callback. This parameter has a 500 character limit.	string
`ppa`	The name of the financial institution (e.g., Toledo Federal Credit Union)	string
`payment_date_time`	The date and time when the consumer submitted the payment in Month DD, YYY HH:MM AM/PM format.	string
`customer_email`	The consumer’s email address	string
`customer_phone`	The consumer’s phone number	string
`push_approval_state`	Indicates whether the disbursement is in one of the following statuses: `queued` `pushed` `queried_user` `canceled`	string
`push_payment_method_identifier`	The payment method ID where PayNearMe sends disbursement funds	string
`one_time_pay_json`	An array of JSON snippets that can contain the following parameters: `identifier` `amount` `means` `date` `status` `created` (date) `canceled` (date) `payment_type` `contact` `agent_name` For examples of the `one_time_pay_json` snippet, see the Scheduled One-Time Payment Changes code samples below. NOTE: This object is not included when calculating the callback signature.	obj
`auto_pay`	Defines the frequency of auto payments. The following values are supported: every (i.e., `weekly`) every other (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 end of the month (i.e., `end_of_month`)	string
`auto_pay_json`	A JSON snippet that can contain the following parameters: `identifier` `amount` `means` `date` `status` `frequency` `created date` `canceled date` `payment_type` `end_date` `duration_type` `number_of_payments_planned` `number_of_payments_remaining` `number_of_payments_completed` `number_of_payments_skipped` `agent_name` `schedule` For examples of the `auto_pay_json` snippet, see the Recurring Autopay Scheduled Changes code samples below. NOTE: This object is not included when calculating the callback signature.	obj
`change_event`	A JSON snippet that identifies order changes initiated by a consumer or an agent, which could contain the following parameters: `name` `consumer_schedule_one_time` `agent_schedule_one_time` `api_schedule_one_time` `agent_cancel_one_time` `consumer_cancel_one_time` `api_cancel_one_time` `agent_schedule_recurring` `consumer_schedule_recurring` `api_schedule_recurring` `agent_cancel_recurring` `consumer_cancel_recurring` `api_cancel_recurring` `consumer_skip_recurring` `agent_skip_recurring` `api_skip_recurring` `api_update_recurring` `consumer_confirm_recurring` `mute_recording` `unmute_recording` `business_rule_cancel_one_time` `business_rule_cancel_recurring` `payment_account_cancel_recurring` `payment_account_cancel_one_time` `api_cancel_retry_recurring` `api_cancel_retry_one_time` `change_by_agent_id` `change_by_agent_email` `change_by_consumer_contact` `context` (i.e., the external ID of the schedule) `consumer_email` For examples of the `change_event` JSON snippet, see the code samples below.	string
`pnm_selected_payment_method_json`	A JSON snippet containing the following parameters: `payment_method_identifier` `type` `name` `description` `number` For an example of the `pnm_selected_payment_method_json` snippet, see the Payment Method is Created or Selected code sample below. NOTE: This object is not included when calculating the callback signature.	obj

Code Samples

Scheduled One-Time Payment Changes

Agent Creates a Scheduled, One-Time Payment

{
  "timestamp": "1671061629",
  "agent": "U2161327354",
  "origin": "ef_agent",
  "site_customer_identifier": "07920654",
  "site_order_identifier": "0792065426317",
  "payee_identifier": "S8804198473",
  "pnm_order_identifier": "84581567735",
  "version": "3.0",
  "site_identifier": "S8804198473",
  "signature": "88b5b2389ef3e22c368382551290aba1fac25b2e5da05e5c5d5a0c8412ea0937",
  "one_time_pay_json": [
    {
      "date": "2022-12-16 00:00:00 -0800",
      "means": "Debit Card 0004",
      "amount": "1132.85",
      "status": "active",
      "created": "2022-12-14 15:47:08 -0800",
      "agent_name": "Tabatha Menser",
      "identifier": "956591089387365",
      "payment_type": "debit"
    },
    {
      "date": "2022-12-16 00:00:00 -0800",
      "means": "Debit Card 0004",
      "amount": "1150.00",
      "status": "disabled",
      "created": "2022-12-14 15:29:25 -0800",
      "canceled": "2022-12-14 15:46:40 -0800",
      "agent_name": "Tabatha Menser",
      "identifier": "237085517673336",
      "payment_type": "debit"
    }
  ],
  "change_event": {
    "name": "agent_schedule_one_time",
    "context": "956591089387365",
    "change_by_agent_id": "U2161327354",
    "change_by_agent_email": "[change_by_agent_email–*****.com(25)]"
  }
}

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "84581567735"
    }
  }
}

Consumer Creates a Scheduled One-Time Payment

{
  "timestamp": "1668809221",
  "origin": "Consumer Flow",
  "site_customer_identifier": "36425574",
  "site_order_identifier": "3642557425860",
  "payee_identifier": "S8804198473",
  "pnm_order_identifier": "81400213163",
  "version": "3.0",
  "site_identifier": "S8804198473",
  "signature": "17f79598a7b73f7638c96a252b617d2f107caf06a4e2c2bf3bc98c46803b92ec",
  "one_time_pay_json": [
    {
      "date": "2022-11-21 00:00:00 -0800",
      "means": "First Financial Bank, NA 4741 (Personal Checking)",
      "amount": "487.84",
      "status": "active",
      "created": "2022-11-18 14:07:01 -0800",
      "agent_name": "",
      "identifier": "967736575498888",
      "payment_type": "ach"
    }
  ],
  "change_event": {
    "name": "consumer_schedule_one_time",
    "context": "967736575498888"
  }
}

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "81400213163"
    }
  }
}

API Creates a Scheduled One-Time Payment

{
  "timestamp": "1751404235",
  "origin": "API",
  "site_customer_identifier": "760040000",
  "site_order_identifier": "7019960131",
  "payee_identifier": "S3711063247",
  "pnm_order_identifier": "86288919831",
  "version": "3.0",
  "site_identifier": "S3711063247",
  "signature": "7fb4b956421913d1f5578fd25731854a0cabc72bda905bcc1680a467155fe2d9",
  "one_time_pay_json": [
    {
      "identifier": "854701781051878",
      "amount": "150.00",
      "means": "Valley National Bank 6896 (Business Savings)",
      "date": "2025-07-02 00:00:00 -0700",
      "status": "active",
      "created": "2025-07-01 14:10:34 -0700",
      "payment_type": "ach",
      "agent_name": ""
    }
  ],
  "change_event": {
    "name": "api_schedule_one_time",
    "context": "854701781051878"
  }
}

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "86288919831"
    }
  }
}

Agent Cancels a Scheduled One-Time Payment

{
  "timestamp": "1671061600",
  "agent": "[email protected]",
  "origin": "PNM Now",
  "site_customer_identifier": "07920654",
  "site_order_identifier": "0792065426317",
  "payee_identifier": "S8804198473",
  "pnm_order_identifier": "84581567735",
  "version": "3.0",
  "site_identifier": "S8804198473",
  "signature": "c2c7e3a3c53c5c087271164a36989f6e3bbeeed14c52e110aa9adf1776d08337",
  "one_time_pay_json": [
    {
      "date": "2022-12-16 00:00:00 -0800",
      "means": "Debit Card 0004",
      "amount": "1150.00",
      "status": "disabled",
      "created": "2022-12-14 15:29:25 -0800",
      "canceled": "2022-12-14 15:46:40 -0800",
      "agent_name": "Reginald Peterson",
      "identifier": "237085517673336",
      "payment_type": "debit"
    }
  ],
  "change_event": {
    "name": "agent_cancel_one_time",
    "context": "237085517673336",
    "change_by_agent_id": "U2161327354",
    "change_by_agent_email": "[change_by_agent_email–*****.com(25)]"
  }
}

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "84581567735"
    }
  }
}

Agent Cancels the Retry of a Scheduled One-Time Payment

This change occurs when an agent cancels the pending retry transaction of a declined, one-time scheduled payment.

{
  "timestamp": "1751484260",
  "origin": "agent",
  "site_customer_identifier": "290800001",
  "site_order_identifier": "2676702689",
  "payee_identifier": "S3711063247",
  "pnm_order_identifier": "89490840746",
  "version": "3.0",
  "site_identifier": "S3711063247",
  "signature": "aa4585597568645c9bf20a3b81c02c57f8d3f82ac307b793d96d6518f94ccb1b",
  "change_event": {
    "name": "agent_cancel_retry_one_time",
    "context": "413764266249048"
  }
}

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "89490840746"
    }
  }
}

Consumer Cancels a Scheduled One-Time Payment

{
  "timestamp": "1663283467",
  "origin": "Consumer Flow",
  "site_customer_identifier": "172287398",
  "site_order_identifier": "145799037",
  "payee_identifier": "S3856438750",
  "pnm_order_identifier": "86884437427",
  "version": "3.0",
  "site_identifier": "S3856438750",
  "signature": "8373be76cb6cbb08170585b93aa0f54abde7a9d3e1deb25a2a070f81425ca226",
  "one_time_pay_json": [
    {
      "identifier": "609720137636615",
      "amount": "11.00",
      "means": "Debit Card 3023",
      "date": "2022-09-16 00:00:00 -0700",
      "status": "user_suspended",
      "created": "2022-09-15 15:59:02 -0700",
      "canceled": "2022-09-15 16:11:07 -0700",
      "payment_type": "debit",
      "agent_name": ""
    }
  ],
  "change_event": {
    "name": "consumer_cancel_one_time",
    "context": "609720137636615",
    "consumer_email": "[consumer_email–*****.com(25)]"
  }
}

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "86884437427"
    }
  }
}

Business Rule Cancels a Scheduled One-Time Payment

This change occurs when clients have set the Cancel Autopay After Decline business rule. This rule states that after a specified number of payment declines occur within a configurable timeframe (e.g., three declines within 90 days), PayNearMe will cancel the autopay schedule associated with the order. This rule applies to both future-dated, one-time payments and recurring autopay schedules.

{
  "timestamp": "1671061600",
  "origin": "pnm",
  "site_customer_identifier": "07920654",
  "site_order_identifier": "0792065426317",
  "payee_identifier": "S8804198473",
  "pnm_order_identifier": "84581567735",
  "version": "3.0",
  "site_identifier": "S8804198473",
  "signature": "c2c7e3a3c53c5c087271164a36989f6e3bbeeed14c52e110aa9adf1776d08337",
  "one_time_pay_json": [
    {
      "date": "2022-12-16 00:00:00 -0800",
      "means": "Debit Card 0004",
      "amount": "1150.00",
      "status": "disabled",
      "created": "2022-12-14 15:29:25 -0800",
      "canceled": "2022-12-14 15:46:40 -0800",
      "identifier": "237085517673336",
      "payment_type": "debit",
      "agent_name": "",
    }
  ],
  "change_event": {
    "name": "business_rule_cancel_one_time",
    "context": "237085517673336"
  }
}

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "84581567735"
    }
  }
}

Risk Rule Cancels a Scheduled One-Time Payment

This change occurs when a client configures their site to cancel one-time, scheduled payments if PayNearMe's risk engine identifies the associated payment method as non-viable. Payment methods are labeled as non-viable if they have incurred returns (for ACH payments) or NSF/fraud declines (for card payments). To enable this risk rule for your site, reach out to your PayNearMe Technical Account Manager.

{
  "timestamp": "1663283467",
  "origin": "pnm",
  "site_customer_identifier": "172287398",
  "site_order_identifier": "145799037",
  "payee_identifier": "S3856438750",
  "pnm_order_identifier": "86884437427",
  "version": "3.0",
  "site_identifier": "S3856438750",
  "signature": "8373be76cb6cbb08170585b93aa0f54abde7a9d3e1deb25a2a070f81425ca226",
  "one_time_pay_json": {
    "date": "2024-04-06 00:00",
    "means": "Bank of Louisa 4585 (Business Savings)",
    "amount": "$78.00",
    "status": "inactive",
    "canceled": "2024-04-05 14:16",
    "frequency": "Monthly",
    "identifier": "104263268184489",
    "payment_type":"ach",
    "agent_name": ""
  
  },
  "change_event": {
    "name": "payment_account_cancel_one_time",
    "context": "104263268184489"
  }
}

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "86884437427"
    }
  }
}

API Cancels a Scheduled One-Time Payment

{
  "timestamp": "1751404537",
  "origin": "API",
  "site_customer_identifier": "760040000",
  "site_order_identifier": "7019960131",
  "payee_identifier": "S3711063247",
  "pnm_order_identifier": "86288919831",
  "version": "3.0",
  "site_identifier": "S3711063247",
  "signature": "92232687ca34b50ffee244a91479c249b97d50357c41874daf610f58c1240652",
  "one_time_pay_json": [
    {
      "identifier": "854701781051878",
      "amount": "150.00",
      "means": "Valley National Bank 6896 (Business Savings)",
      "date": "2025-07-02 00:00:00 -0700",
      "status": "disabled",
      "created": "2025-07-01 14:10:34 -0700",
      "canceled": "2025-07-01 14:15:36 -0700",
      "payment_type": "ach",
      "agent_name": ""
    }
  ],
  "change_event": {
    "name": "api_cancel_one_time",
    "context": "854701781051878"
  }
}

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "86288919831"
    }
  }
}

API Cancels the Retry of a Scheduled One-Time Payment

This change occurs when the retry payment of a scheduled transaction is canceled via the /cancel_scheduled_retry API endpoint.

{
  "timestamp": "1751484387",
  "origin": "API",
  "site_customer_identifier": "421370000",
  "site_order_identifier": "4607360653",
  "payee_identifier": "S3711063247",
  "pnm_order_identifier": "89797031115",
  "version": "3.0",
  "site_identifier": "S3711063247",
  "signature": "32a23526eb7a0e082e9ff96e21ec3ff98cb39658d8ffd577a11dd8a4f5a16785",
  "change_event": {
    "name": "api_cancel_retry_one_time",
    "context": "902519515622887"
  }
}

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "89797031115"
    }
  }
}

Recurring Autopay Schedule Changes

Agent Creates Recurring Autopay Schedule

{
  "timestamp": "1752177365",
  "agent": "U9197843873",
  "origin": "ef_agent",
  "site_customer_identifier": "933080000",
  "site_order_identifier": "6329316487",
  "payee_identifier": "S3711063247",
  "pnm_order_identifier": "83651362328",
  "version": "3.0",
  "site_identifier": "S3711063247",
  "signature": "a35ced8ec4f06c1996f20ed8229205bbce4432d219589e32460ff15b59a78f9f",
  "auto_pay_json": {
    "identifier": "898255279527332",
    "amount": "500.00",
    "means": "Kemba Louisville Credit Union 5856 (Business Savings)",
    "date": "2025-07-11 00:00:00 -0700",
    "status": "active",
    "frequency": "Monthly",
    "created": "2025-07-10 12:56:04 -0700",
    "payment_type": "ach",
    "duration_type": "number_of_recurrences",
    "number_of_payments_planned": 20,
    "number_of_payments_remaining": 20,
    "number_of_payments_completed": 0,
    "number_of_payments_skipped": 0,
    "agent_name": "Jennifer Phillips",
    "schedule": "the 11th of every month"
  },
  "change_event": {
    "name": "agent_schedule_recurring",
    "context": "898255279527332",
    "change_by_agent_id": "U1580592154",
    "change_by_agent_email": "[change_by_agent_email–*****.com(28)]"
  }
}

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "83651362328"
    }
  }
}

Consumer Creates Recurring Autopay Schedule

{
  "timestamp": "1752098127",
  "origin": "Consumer Flow",
  "site_customer_identifier": "169430000",
  "site_order_identifier": "9168528321",
  "payee_identifier": "S3711063247",
  "pnm_order_identifier": "81781096031",
  "version": "3.0",
  "site_identifier": "S3711063247",
  "signature": "69365c6a524c41d60a658fa606f3610d2d39ada250865d30c2e3b2833e82bd6a",
  "auto_pay_json": {
    "identifier": "310380037326822",
    "amount": "250.00",
    "means": "Weststar Bank 1049 (Personal Checking)",
    "date": "2025-07-11 00:00:00 -0700",
    "status": "active",
    "frequency": "Monthly",
    "created": "2025-07-09 14:55:27 -0700",
    "payment_type": "ach",
    "duration_type": "number_of_recurrences",
    "number_of_payments_planned": 80,
    "number_of_payments_remaining": 80,
    "number_of_payments_completed": 0,
    "number_of_payments_skipped": 0,
    "agent_name": "",
    "schedule": "the 11th of every month"
  },
  "change_event": {
    "name": "consumer_schedule_recurring",
    "context": "310380037326822"
  }
}

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "81781096031"
    }
  }
}

API Creates a Recurring Autopay Schedule

{
  "timestamp": "1752177872",
  "origin": "API",
  "site_customer_identifier": "533320000",
  "site_order_identifier": "1481519179",
  "payee_identifier": "S3711063247",
  "pnm_order_identifier": "80505326505",
  "version": "3.0",
  "site_identifier": "S3711063247",
  "signature": "2eb0d1a43eb70b09829bbd09a594335e2fc4d1ce0e96c749f5ea70b6b9458b46",
  "auto_pay_json": {
    "identifier": "065052644226341",
    "amount": "250.00",
    "means": "Chase Debit 3022",
    "date": "2025-07-11 00:00:00 -0700",
    "status": "pending",
    "frequency": "Weekly",
    "created": "2025-07-10 13:04:32 -0700",
    "payment_type": "debit",
    "duration_type": "number_of_recurrences",
    "number_of_payments_planned": 80,
    "number_of_payments_remaining": 80,
    "number_of_payments_completed": 0,
    "number_of_payments_skipped": 0,
    "agent_name": "",
    "schedule": "every Friday"
  },
  "change_event": {
    "name": "api_schedule_recurring",
    "context": "065052644226341"
  }
}

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "80505326505"
    }
  }
}

Agent Cancels Recurring Autopay Schedule

{
  "timestamp": "1752177904",
  "agent": "[email protected]",
  "origin": "PNM Now",
  "site_customer_identifier": "933080000",
  "site_order_identifier": "6329316487",
  "payee_identifier": "S3711063247",
  "pnm_order_identifier": "83651362328",
  "version": "3.0",
  "site_identifier": "S3711063247",
  "signature": "0b7895fc1f6b9e5a4b750264c14d3c13e310bfdb55f17b4264d9cb61c6c31746",
  "auto_pay_json": {
    "identifier": "898255279527332",
    "amount": "500.00",
    "means": "Kemba Louisville Credit Union 5856 (Business Savings)",
    "date": "2025-08-11 00:00:00 -0700",
    "status": "inactive",
    "frequency": "Monthly",
    "canceled": "2025-07-10 13:05:04 -0700",
    "payment_type": "ach",
    "duration_type": "number_of_recurrences",
    "number_of_payments_planned": 20,
    "number_of_payments_remaining": 19,
    "number_of_payments_completed": 1,
    "number_of_payments_skipped": 1,
    "agent_name": "Jennifer Phillips"
  },
  "change_event": {
    "name": "agent_cancel_recurring",
    "context": "898255279527332",
    "change_by_agent_id": "U1580592154",
    "change_by_agent_email": "[change_by_agent_email–*****.com(28)]"
  }
}

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "83651362328"
    }
  }
}

Agent Cancels the Retry Payment of a Recurring Autopay Schedule

This change occurs when an agent cancels the pending retry transaction of a declined autopay payment

{
  "timestamp": "1751484129",
  "origin": "agent",
  "site_customer_identifier": "586780000",
  "site_order_identifier": "7888214228",
  "payee_identifier": "S3711063247",
  "pnm_order_identifier": "84760939014",
  "version": "3.0",
  "site_identifier": "S3711063247",
  "signature": "736aec69f19213eb1385b01f278fed06073b10e7191782a232ae33c527f66759",
  "auto_pay_json": {
    "identifier": "910715648972654",
    "amount": "$211.74",
    "means": "Hsbc Debit 0033",
    "date": "2025-07-09 00:00",
    "status": "active",
    "frequency": "Weekly",
    "created": "2025-07-01 21:37"
  },
  "change_event": {
    "name": "agent_cancel_retry_recurring",
    "context": "910715648972654"
  }

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "84760939014"
    }
  }
}

Consumer Cancels Recurring Autopay Schedule

{
  "timestamp": "1752098281",
  "origin": "Consumer Flow",
  "site_customer_identifier": "718690000",
  "site_order_identifier": "7341550424",
  "payee_identifier": "S3711063247",
  "pnm_order_identifier": "80983731317",
  "version": "3.0",
  "site_identifier": "S3711063247",
  "signature": "d80fc6edef55561cbe563c2800a0d28265b7aaa37502feedc4e1994a95069de7",
  "auto_pay_json": {
    "identifier": "564384741178926",
    "amount": "200.00",
    "means": "Nascoga FCU 0599 (Business Savings)",
    "date": "2025-08-09 00:00:00 -0700",
    "status": "inactive",
    "frequency": "Monthly",
    "canceled": "2025-07-09 14:58:01 -0700",
    "payment_type": "ach",
    "duration_type": "indefinite",
    "number_of_payments_completed": 1,
    "number_of_payments_skipped": 0,
    "agent_name": ""
  },
  "change_event": {
    "name": "consumer_cancel_recurring",
    "context": "564384741178926"
  }
}

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "80983731317"
    }
  }
}

Business Rule Cancels a Recurring Autopay Schedule

{
  "timestamp": "1752242466",
  "origin": "pnm",
  "site_customer_identifier": "239500000",
  "site_order_identifier": "4491943600",
  "payee_identifier": "S3711063247",
  "pnm_order_identifier": "87140349200",
  "version": "3.0",
  "site_identifier": "S3711063247",
  "signature": "4a8768b4dfda14ed9e6caf38433e02a262a57362ceb276f3fee8255090781683",
  "auto_pay_json": {
    "identifier": "464657599512894",
    "amount": "208.74",
    "means": "Scotiabank Debit 3136",
    "date": "2025-07-11 00:00:00 -0700",
    "status": "inactive",
    "frequency": "Monthly",
    "canceled": "2025-07-11 07:01:06 -0700",
    "payment_type": "debit",
    "duration_type": "end_date",
    "end_date": "2027-07-11 00:00:00 -0700",
    "number_of_payments_completed": 0,
    "number_of_payments_skipped": 0,
    "agent_name": ""
  },
  "change_event": {
    "name": "business_rule_cancel_recurring",
    "context": "464657599512894"
  }
}

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "87140349200"
    }
  }
}

Risk Rule Cancels a Recurring Autopay Schedule

This change occurs when a client configures their site to autopay schedules if PayNearMe's risk engine identifies the associated payment method as non-viable during recurring payment orchestration. Payment methods are labeled as non-viable if they have incurred returns (for ACH payments) or NSF/fraud declines (for card payments). To enable this risk rule for your site, reach out to your PayNearMe Technical Account Manager.

{
  "timestamp": "1751406902",
  "origin": "pnm",
  "site_customer_identifier": "809200000",
  "site_order_identifier": "9087487965",
  "payee_identifier": "S3711063247",
  "pnm_order_identifier": "86369432963",
  "version": "3.0",
  "site_identifier": "S3711063247",
  "signature": "423f63da4b62117a1328d51761aed8150dc8a408f01dff886faf7c079280ca8e",
  "auto_pay_json": {
    "identifier": "898255279527332",
    "amount": "500.00",
    "means": "Kemba Louisville Credit Union 5856 (Business Savings)",
    "date": "2025-08-11 00:00:00 -0700",
    "status": "inactive",
    "frequency": "Monthly",
    "canceled": "2025-07-10 13:05:04 -0700",
    "payment_type": "ach",
    "duration_type": "number_of_recurrences",
    "number_of_payments_planned": 20,
    "number_of_payments_remaining": 19,
    "number_of_payments_completed": 1,
    "number_of_payments_skipped": 1,
    "agent_name": ""
  },
  "change_event": {
    "name": "payment_account_cancel_recurring",
    "context": "711493977063376"
  }
}

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "86369432963"
    }
  }
}

API Cancels Recurring Autopay Schedule

{
  "timestamp": "1752178187",
  "origin": "API",
  "site_customer_identifier": "533320000",
  "site_order_identifier": "1481519179",
  "payee_identifier": "S3711063247",
  "pnm_order_identifier": "80505326505",
  "version": "3.0",
  "site_identifier": "S3711063247",
  "signature": "f7ce2c3bede82de7b47150618dbee64e8d96903bc6f5d17e13751e2d33524de1",
  "auto_pay_json": {
    "identifier": "065052644226341",
    "amount": "250.00",
    "means": "Chase Debit 3022",
    "date": "2025-07-11 00:00:00 -0700",
    "status": "inactive",
    "frequency": "Weekly",
    "canceled": "2025-07-10 13:09:46 -0700",
    "payment_type": "debit",
    "duration_type": "number_of_recurrences",
    "number_of_payments_planned": 80,
    "number_of_payments_remaining": 80,
    "number_of_payments_completed": 0,
    "number_of_payments_skipped": 0,
    "agent_name": ""
  },
  "change_event": {
    "name": "api_cancel_recurring",
    "context": "065052644226341"
  }
}

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "80505326505"
    }
  }
}

API Cancels the Retry Payment of a Recurring Autopay Schedule

This change occurs when the retry payment of a declined autopay transaction is canceled via the /cancel_scheduled_retry API endpoint.

{
  "timestamp": "1752262695",
  "origin": "API",
  "site_customer_identifier": "933080000",
  "site_order_identifier": "6329316487",
  "payee_identifier": "S3711063247",
  "pnm_order_identifier": "83651362328",
  "version": "3.0",
  "site_identifier": "S3711063247",
  "signature": "e872da41257fb8eee17c322c5097131f93fbd72115711f61137f224b5d3007a2",
  "auto_pay_json": {
    "identifier": "934734277952527",
    "amount": "208.74",
    "means": "Scotiabank Debit 8403",
    "date": "2025-07-18 00:00:00 -0700",
    "status": "active",
    "frequency": "Weekly",
    "created": "2025-07-10 13:55:51 -0700",
    "payment_type": "debit",
    "duration_type": "indefinite",
    "number_of_payments_completed": 2,
    "number_of_payments_skipped": 0,
    "agent_name": "",
    "schedule": "every Friday",
    "retry_canceled": "2025-07-11 12:38:14 -0700"
  },
  "change_event": {
    "name": "api_cancel_retry_recurring",
    "context": "934734277952527"
  }
}

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "83651362328"
    }
  }
}

Agent Skips Recurring Autopay Payment

{
  "timestamp": "1752177895",
  "agent": "[email protected]",
  "origin": "PNM Now",
  "site_customer_identifier": "933080000",
  "site_order_identifier": "6329316487",
  "payee_identifier": "S3711063247",
  "pnm_order_identifier": "83651362328",
  "version": "3.0",
  "site_identifier": "S3711063247",
  "signature": "a9c6db7c67f93bdf721466005c0d1932ddf323c4a52a55098d6e913978024b56",
  "auto_pay_json": {
    "identifier": "898255279527332",
    "amount": "500.00",
    "means": "Kemba Louisville Credit Union 5856 (Business Savings)",
    "date": "2025-08-11 00:00:00 -0700",
    "status": "active",
    "frequency": "Monthly",
    "created": "2025-07-10 12:56:04 -0700",
    "payment_type": "ach",
    "duration_type": "number_of_recurrences",
    "number_of_payments_planned": 20,
    "number_of_payments_remaining": 19,
    "number_of_payments_completed": 1,
    "number_of_payments_skipped": 1,
    "agent_name": "Jennifer Phillips",
    "schedule": "the 11th of every month"
  },
  "change_event": {
    "name": "agent_skip_recurring",
    "context": "898255279527332",
    "change_by_agent_id": "U1580592154",
    "change_by_agent_email": "[change_by_agent_email–*****.com(28)]"
  }
}

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "83651362328"
    }
  }
}

Consumer Skips Recurring Autopay Payment

{
  "timestamp": "1752178547",
  "origin": "Consumer Flow",
  "site_customer_identifier": "933080000",
  "site_order_identifier": "6329316487",
  "payee_identifier": "S3711063247",
  "pnm_order_identifier": "83651362328",
  "version": "3.0",
  "site_identifier": "S3711063247",
  "signature": "8f805a48dbffdb2e1aa1feb361656f85e15594a917335d2a548d0e2a88a76ff5",
  "auto_pay_json": {
    "identifier": "070207541691399",
    "amount": "250.00",
    "means": "Capital One Debit 6501",
    "date": "2025-07-28 00:00:00 -0700",
    "status": "active",
    "frequency": "Twice a Month",
    "created": "2025-07-10 13:15:31 -0700",
    "payment_type": "debit",
    "duration_type": "indefinite",
    "number_of_payments_completed": 1,
    "number_of_payments_skipped": 1,
    "agent_name": "",
    "schedule": "the 15th and 28th of every month"
  },
  "change_event": {
    "name": "consumer_skip_recurring",
    "context": "070207541691399"
  }
}

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "83651362328"
    }
  }
}

API Skips Recurring Autopay Payment

{
  "timestamp": "1751407442",
  "origin": "API",
  "site_customer_identifier": "473060000",
  "site_order_identifier": "5519253810",
  "payee_identifier": "S3711063247",
  "pnm_order_identifier": "83589540614",
  "version": "3.0",
  "site_identifier": "S3711063247",
  "signature": "74db5bfbc593f3017b85be15e6480da4a92a3c506439b8f8375b3bf13fc980a4",
  "auto_pay_json": {
    "identifier": "898255279527332",
    "amount": "500.00",
    "means": "Kemba Louisville Credit Union 5856 (Business Savings)",
    "date": "2025-08-11 00:00:00 -0700",
    "status": "active",
    "frequency": "Monthly",
    "created": "2025-07-10 12:56:04 -0700",
    "payment_type": "ach",
    "duration_type": "number_of_recurrences",
    "number_of_payments_planned": 20,
    "number_of_payments_remaining": 18,
    "number_of_payments_completed": 2,
    "number_of_payments_skipped": 1,
    "agent_name": "Jennifer Phillips",
    "schedule": "the 11th of every month"
  },
  "change_event": {
    "name": "api_skip_recurring",
    "context": "712138105980373"
  }
}

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "83589540614"
    }
  }
}

Consumer Authorizes a Recurring Autopay Schedule

{
  "timestamp": "1751406299",
  "origin": "Consumer Flow",
  "site_customer_identifier": "327320000",
  "site_order_identifier": "1236147840",
  "payee_identifier": "S3711063247",
  "pnm_order_identifier": "89153051190",
  "version": "3.0",
  "site_identifier": "S3711063247",
  "signature": "53835d6d39ac029b473fe0cf289220f0a076744c64181350bab15fa5df37349b",
  "auto_pay_json": {
    "identifier": "333607041995755",
    "amount": "100.00",
    "means": "Wells Fargo Credit 1437",
    "date": "2025-07-02 00:00:00 -0700",
    "status": "active",
    "frequency": "Monthly",
    "created": "2025-07-01 14:44:26 -0700",
    "payment_type": "credit",
    "duration_type": "indefinite",
    "number_of_payments_completed": 0,
    "number_of_payments_skipped": 0,
    "agent_name": "Jennifer Phillips",
    "schedule": "the 2nd of every month"
  },
  "change_event": {
    "name": "consumer_confirm_recurring",
    "context": "333607041995755"
  }
}

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "89153051190"
    }
  }
}

API Updates the Payment Amount of a Recurring Autopay Schedule

This change is triggered when a client uses the /update_auto_pay API call to change the auto_pay_amount in a recurring schedule. This call requires a signed client agreement that stipulates clients can change the autopay amount for active autopay schedules.

{
  "timestamp": "1752178693",
  "origin": "API",
  "site_customer_identifier": "933080000",
  "site_order_identifier": "6329316487",
  "payee_identifier": "S3711063247",
  "pnm_order_identifier": "83651362328",
  "version": "3.0",
  "site_identifier": "S3711063247",
  "signature": "15c1db7c3f78c16e8ecdc1d175cc82cadd00d387744f79397dd4acf7a0c92cbf",
  "auto_pay_json": {
    "identifier": "070207541691399",
    "amount": "550.00",
    "means": "Capital One Debit 6501",
    "date": "2025-07-28 00:00:00 -0700",
    "status": "active",
    "frequency": "Twice a Month",
    "created": "2025-07-10 13:15:31 -0700",
    "payment_type": "debit",
    "duration_type": "indefinite",
    "number_of_payments_completed": 1,
    "number_of_payments_skipped": 1,
    "agent_name": "",
    "schedule": "the 15th and 28th of every month"
  },
  "change_event": {
    "name": "api_update_recurring",
    "context": "070207541691399"
  }
}

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "83651362328"
    }
  }
}

Payment Method Changes

Payment Method is Created or Selected

{
  "timestamp": "1752009188",
  "origin": "Consumer Flow",
  "site_customer_identifier": "718690000",
  "site_order_identifier": "7341550424",
  "payee_identifier": "S3711063247",
  "pnm_order_identifier": "80983731317",
  "version": "3.0",
  "site_identifier": "S3711063247",
  "signature": "794cfe200a91e57ea2574528461ed054ad5f4e864d65893c99e6e0803ceb034d",
  "selected_payment_method": {
    "payment_method_identifier": "6e328075e303c",
    "type": "ach",
    "name": "Archie Ellis",
    "description": "Nascoga FCU",
    "number": "0599"
  }
}

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "80983731317"
    }
  }
}

Disbursement Changes

Disbursement Initiated

{
  "timestamp": "1663025425",
  "origin": "Consumer Flow",
  "site_customer_identifier": "219400000",
  "site_order_identifier": "4214718639",
  "payee_identifier": "S1733026124",
  "pnm_order_identifier": "59888224950",
  "version": "3.0",
  "d_status": "queued",
  "site_identifier": "S1733026124",
  "signature": "187cc60d0a8613954258e6508517d89fddce4147287a8053dfc1d1d1f3c717ab"
}

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "59888224950"
    }
  }
}

Disbursement Approved

{
  "timestamp": "1656627995",
  "origin": "Consumer Flow",
  "site_customer_identifier": "payout1",
  "payee_identifier": "S1733026124",
  "pnm_order_identifier": "54109985767",
  "version": "3.0",
  "d_status": "pushed",
  "site_identifier": "S1733026124",
  "signature": "579abee7cc0d47b319546cbc3f2cf8c3a9b6d1c009c26f72d01e0c3f2c161711"
}

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "54109985767"
    }
  }
}

Agent-Initiated Changes

Agent Mutes Call Center Recording

This change is only relevant to agents in the Embedded Form and Agent Interface that record consumer phone calls and take payments over this recorded line. To comply with PCI DSS regulations about card data storage, agents must mute the recording when consumers transmit their debit or credit card account number and CVV code and then unmute the recording to capture the remainder of the interaction. The Order Change Callback captures these mute/unmute events for tracking. Contact your PayNearMe Technical Account Manager for more details.

{
  "timestamp": "1751548210",
  "agent": "[email protected]",
  "origin": "ef_agent",
  "site_customer_identifier": "08500607",
  "site_order_identifier": "0850060726518",
  "payee_identifier": "S8804198473",
  "pnm_order_identifier": "89890663439",
  "version": "3.0",
  "site_identifier": "S8804198473",
  "signature": "14266659735659a31b36c4357908d785148ebad93e648ad31ed57a395d1052ba",
  "change_event": {
    "name": "mute_recording",
    "change_by_agent_email": "[change_by_agent_email–*****.com(26)]"
  }
}

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "89890663439"
    }
  }
}

Agent Unmutes Call Center Recording

{
  "timestamp": "1751548212",
  "agent": "[email protected]",
  "origin": "ef_agent",
  "site_customer_identifier": "08500607",
  "site_order_identifier": "0850060726518",
  "payee_identifier": "S8804198473",
  "pnm_order_identifier": "89890663439",
  "version": "3.0",
  "site_identifier": "S8804198473",
  "signature": "21cacd682ef75bca416d41c1e2947165fce4122853814dd082ccf9374c68d907",
  "change_event": {
    "name": "unmute_recording",
    "change_by_agent_email": "[change_by_agent_email–*****.com(26)]"
  }
}

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "89890663439"
    }
  }
}

Agent Updates Account Notes

This change occurs in the Agent Interface and the Embedded Form when an agent updates the payment notes associated with a consumer's account. Agent notes must be enabled for your configuration by your PayNearMe Technical Account Manager.

{
  "timestamp": "1745358606",
  "agent": "[email protected]",
  "origin": "PNM Now",
  "site_customer_identifier": "576120000",
  "site_order_identifier": "5270465563",
  "payee_identifier": "S8456408962",
  "pnm_order_identifier": "81849894053",
  "version": "3.0",
  "agent_notes": "5/1 - Account added to Int Saver payment plan; 7/2 - Cust requested payoff amount",
  "site_identifier": "S8456408962",
  "signature": "de927e7768b0b2ad9d59a16ffaf22acf9e82c52467e9aa71bc11fc8c5dbaf6d0"
}

{
  "order_change_response": {
    "version": "3.0",
    "change": {
      "pnm_order_identifier": "81849894053"
    }
  }
}

Defining the Changes to Monitor

Understanding the Callback Payload

🚧Signature Considerations

Code Samples

Scheduled One-Time Payment Changes

Agent Creates a Scheduled, One-Time Payment

Consumer Creates a Scheduled One-Time Payment

API Creates a Scheduled One-Time Payment

Agent Cancels a Scheduled One-Time Payment

Agent Cancels the Retry of a Scheduled One-Time Payment

Consumer Cancels a Scheduled One-Time Payment

Business Rule Cancels a Scheduled One-Time Payment

Risk Rule Cancels a Scheduled One-Time Payment

API Cancels a Scheduled One-Time Payment

API Cancels the Retry of a Scheduled One-Time Payment

Recurring Autopay Schedule Changes

Agent Creates Recurring Autopay Schedule

Consumer Creates Recurring Autopay Schedule

API Creates a Recurring Autopay Schedule

Agent Cancels Recurring Autopay Schedule

Agent Cancels the Retry Payment of a Recurring Autopay Schedule

Consumer Cancels Recurring Autopay Schedule

Business Rule Cancels a Recurring Autopay Schedule

Risk Rule Cancels a Recurring Autopay Schedule

API Cancels Recurring Autopay Schedule

API Cancels the Retry Payment of a Recurring Autopay Schedule

Agent Skips Recurring Autopay Payment

Consumer Skips Recurring Autopay Payment

API Skips Recurring Autopay Payment

Consumer Authorizes a Recurring Autopay Schedule

API Updates the Payment Amount of a Recurring Autopay Schedule

Payment Method Changes

Payment Method is Created or Selected

Disbursement Changes

Disbursement Initiated

Disbursement Approved

Agent-Initiated Changes

Agent Mutes Call Center Recording

Agent Unmutes Call Center Recording

Agent Updates Account Notes

🚧
Signature Considerations