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 risk rules. To configure the callback, the merchant works with their 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 or agent 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
One-Time Payment is Created	Customer Portal Embedded Client Agent Interface	`consumer_schedule_one_time` `agent_schedule_one_time`
One-Time Payment is Canceled	Customer Portal Embedded Client Agent Interface	`agent_cancel_one_time` `consumer_cancel_one_time`
Autopay Schedule is Created	Customer Portal Embedded Client Agent Interface	`agent_schedule_recurring` `consumer_schedule_recurring`
Autopay Schedule is Canceled by Agent or Consumer	Customer Portal Embedded Client Agent Interface	`agent_cancel_recurring` `consumer_cancel_recurring`
Autopay Payment is Skipped	Customer Portal Embedded Client Agent Interface	`agent_skip_recurring` `consumer_skip_recurring`
Autopay Payment Amount is Changed	API	`api_update_recurring`
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	N/A

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` `Consumer Flow` `PNM Now`	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 Agent Creates a One-Time Payment, Consumer Creates a One-Time Payment, Agent Cancels a One-Time Payment, and/or Consumer Cancels a One-Time Payment 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` `contact` `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 Agent Creates Autopay Schedule, Consumer Creates Autopay Schedule, Agent Cancels Autopay Schedule, Consumer Cancels Autopay Schedule, Agent Skips Autopay Payment, and/or Consumer Skips Autopay Payment 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` `agent_cancel_one_time` `consumer_cancel_one_time` `agent_schedule_recurring` `consumer_schedule_recurring` `agent_cancel_recurring` `consumer_cancel_recurring` `agent_skip_recurring` `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
`order_suspended_state`	Indicates whether the order is active or suspended/canceled. If suspended, the suspended_reason will display.	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

Agent Creates a 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",
  "change_event": {
    "name": "agent_schedule_one_time",
    "context": "956591089387365",
    "change_by_agent_id": "U2161327354",
    "change_by_agent_email": "[change_by_agent_email–*****.com(25)]"
  },
  "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"
    }
  ]
}

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

Consumer Creates 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",
  "change_event": {
    "name": "consumer_schedule_one_time",
    "context": "967736575498888"
  },
  "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"
    }
  ]
}

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

Agent Cancels 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",
  "change_event": {
    "name": "agent_cancel_one_time",
    "context": "237085517673336",
    "change_by_agent_id": "U2161327354",
    "change_by_agent_email": "[change_by_agent_email–*****.com(25)]"
  },
  "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"
    }
  ]
}

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

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

Agent Creates Autopay Schedule

{
  "timestamp": "1671012279",
  "agent": "U4711836652",
  "origin": "ef_agent",
  "site_customer_identifier": "05394854",
  "site_order_identifier": "0539485424977",
  "payee_identifier": "S8804198473",
  "pnm_order_identifier": "87868751022",
  "version": "3.0",
  "site_identifier": "S8804198473",
  "signature": "fff704e07e31d798bde074d210df366f77dffb6b30fb0c34f4ce645ea5a0ccdf",
  "change_event": {
    "name": "agent_schedule_recurring",
    "context": "236045199410917",
    "change_by_agent_id": "U4711836652",
    "change_by_agent_email": "[change_by_agent_email–*****.com(18)]"
  },
  "auto_pay_json": {
    "date": "2022-12-15 00:00:00 -0800",
    "means": "Debit Card 0004",
    "amount": "321.43",
    "status": "pending",
    "created": "2022-12-14 02:04:38 -0800",
    "end_date": "2023-02-25 00:00:00 -0800",
    "schedule": "every Thursday",
    "frequency": "Weekly",
    "agent_name": "Kalyani Devangayerra",
    "identifier": "236045199410917",
    "payment_type": "debit",
    "duration_type": "end_date",
    "number_of_payments_skipped": "0",
    "number_of_payments_completed": "0"
  }
}

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

Consumer Creates Autopay Schedule

{
  "timestamp": "1668522664",
  "origin": "Consumer Flow",
  "site_customer_identifier": "75506421",
  "site_order_identifier": "7550642126301",
  "payee_identifier": "S8804198473",
  "pnm_order_identifier": "86151699561",
  "version": "3.0",
  "site_identifier": "S8804198473",
  "signature": "eac5e91326ef4678d50e82b2bbe4aae875e6bfd0ac3ba7186c1d91e98e3f5fb3",
  "change_event": {
    "name": "consumer_schedule_recurring",
    "context": "750609807251862"
  },
  "auto_pay_json": {
    "date": "2022-11-16 00:00:00 -0800",
    "means": "Debit Card 0004",
    "amount": "435.90",
    "status": "active",
    "created": "2022-11-15 06:31:03 -0800",
    "schedule": "the 16th and 17th of every month",
    "frequency": "Twice a Month",
    "agent_name": "",
    "identifier": "750609807251862",
    "payment_type": "debit",
    "duration_type": "number_of_recurrences",
    "number_of_payments_planned": "2",
    "number_of_payments_skipped": "0",
    "number_of_payments_completed": "0",
    "number_of_payments_remaining": "2"
  }
}

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

Agent Cancels Autopay Schedule

{
  "timestamp": "1668851377",
  "agent": "[email protected]",
  "origin": "PNM Now",
  "site_customer_identifier": "02443494",
  "site_order_identifier": "0244349424792",
  "payee_identifier": "S8804198473",
  "pnm_order_identifier": "82239575212",
  "version": "3.0",
  "site_identifier": "S8804198473",
  "signature": "90115a088172181741e82d3d699bf4ef3cd262e5b2f5a2e230e42ac582056b9d",
  "change_event": {
    "name": "agent_cancel_recurring",
    "context": "334356614897270",
    "change_by_agent_id": "U8285666758",
    "change_by_agent_email": "[change_by_agent_email–*****.com(34)]"
  },
  "auto_pay_json": {
    "date": "2022-11-20 00:00:00 -0800",
    "means": "Wells Fargo Bank NA (Arizona) 4456 (Personal Checking)",
    "amount": "234.11",
    "status": "inactive",
    "canceled": "2022-11-19 01:49:36 -0800",
    "frequency": "Weekly",
    "agent_name": "Bob Smith",
    "identifier": "334356614897270",
    "payment_type": "ach",
    "duration_type": "number_of_recurrences",
    "number_of_payments_planned": "2",
    "number_of_payments_skipped": "0",
    "number_of_payments_completed": "0",
    "number_of_payments_remaining": "2"
  }
}

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

Consumer Cancels Autopay Schedule

{
  "timestamp": "1666286511",
  "origin": "Consumer Flow",
  "site_customer_identifier": "976226027697976448",
  "site_order_identifier": "168504258",
  "payee_identifier": "S3856438750",
  "pnm_order_identifier": "83682942954",
  "version": "3.0",
  "site_identifier": "S3856438750",
  "signature": "4cec4e7fe25485a74678b868bc69744402ce4fdf48c040d69e0f242350874e95",
  "auto_pay_json": {
    "identifier": "397817909323594",
    "amount": "569.69",
    "means": "Debit Card 9991",
    "date": "2022-10-22 00:00:00 -0700",
    "status": "inactive",
    "frequency": "Monthly",
    "canceled": "2022-10-20 10:21:51 -0700",
    "payment_type": "debit",
    "duration_type": "paid_in_full",
    "number_of_payments_completed": "4",
    "number_of_payments_skipped": "0",
    "agent_name": "Harold Robinson"
  },
  "change_event": {
    "name": "consumer_cancel_recurring",
    "context": "397817909323594",
    "consumer_email": "[consumer_email–*****.com(28)]"
  }
}

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

Agent Skips Autopay Payment

{
  "timestamp": "1667575922",
  "agent": "[email protected]",
  "origin": "PNM Now",
  "site_customer_identifier": "06424373",
  "site_order_identifier": "0642437325474",
  "payee_identifier": "S8804198473",
  "pnm_order_identifier": "83366523267",
  "version": "3.0",
  "site_identifier": "S8804198473",
  "signature": "193f9792dd7ea8f0377e26bbbbcf3ba3af5eb9c7e40ffc8274596f490b55568a",
  "change_event": {
    "name": "agent_skip_recurring",
    "context": "737393899286810",
    "change_by_agent_id": "U2161327354",
    "change_by_agent_email": "[change_by_agent_email–*****.com(25)]"
  },
  "auto_pay_json": {
    "date": "2022-11-12 00:00:00 -0800",
    "means": "First State Bank 2113 (Business Checking)",
    "amount": "441.10",
    "status": "active",
    "created": "2022-11-04 08:29:13 -0700",
    "schedule": "every Saturday",
    "frequency": "Weekly",
    "agent_name": "Reginald Peterson",
    "identifier": "737393899286810",
    "payment_type": "ach",
    "duration_type": "number_of_recurrences",
    "number_of_payments_planned": "2",
    "number_of_payments_skipped": "1",
    "number_of_payments_completed": "1",
    "number_of_payments_remaining": "1"
  }
}

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

Consumer Skips Autopay Payment

{
  "timestamp": "1658865076",
  "origin": "Consumer Flow",
  "site_customer_identifier": "12121212",
  "site_order_identifier": "12121212",
  "payee_identifier": "CARDAMOM",
  "pnm_order_identifier": "81980775176",
  "version": "3.0",
  "site_identifier": "CARDAMOM",
  "signature": "f089eaa977938abe9a13ff7495a76743",
  "change_event": {
    "name": "consumer_skip_recurring",
    "change_by_consumer_contact": "[change_by_consumer-contact–*****.com(25)]"
  },
  "auto_pay_json": {
    "date": "2022-08-27 00:00:00 -0800",
    "means": "Wells Fargo Bank NA (Arizona) 0016 (Business Checking)",
    "amount": "100.00",
    "status": "active",
    "created": "2022-07-26 12:51:13 -0700",
    "frequency": "Monthly",
    "identifier": "326866994160890"
  }
}

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

Autopay Payment Amount is Changed

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": "1712767537",
  "origin": "API",
  "site_customer_identifier": "SCI-1",
  "site_order_identifier": "SOI-1-1",
  "payee_identifier": "CARDAMOM",
  "pnm_order_identifier": "88888800001",
  "version": "2.0",
  "site_identifier": "CARDAMOM",
  "signature": "af63cc365b9dc40c70470a738e17487e",
  "auto_pay_json": {
    "identifier": "046259612390753",
    "amount": "$12.34",
    "means": "Wells Fargo Bank NA (Arizona) 0019 (Personal Checking)",
    "date": "2024-04-15 00:00",
    "status": "active",
    "frequency": "Monthly",
    "created": "2024-04-10 09:43"
  },
  "change_event": {
    "name": "api_update_recurring",
    "context": "046259612390753"
  }
}

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

Payment Method is Created or Selected

{
   "timestamp": "1650643808",
   "origin": "Consumer Flow",
   "site_customer_identifier": "881680000",
   "site_order_identifier": "3098212415",
   "payee_identifier": "CARDAMOM",
   "pnm_order_identifier": "81386543685",
   "version": "3.0",
   "site_identifier": "CARDAMOM",
   "signature": "93670daf708led3fcab955cceda72087",
   "pnm_selected_payment_method_json": {
  	"name": "Alyssa Boehm",
  	"type": "ach",
  	"number": "0829",
  	"description": "Great Southern Bank",
  	"payment_method_identifier": "516cd5d4d0b9a"
   }
}

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

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

One-Time Scheduled Payment Canceled by Business Rule

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": "1712351210",
  "origin": "pnm",
  "site_customer_identifier": "773800000",
  "site_order_identifier": "4146756281",
  "payee_identifier": "CARDAMOM",
  "pnm_order_identifier": "85764973188",
  "version": "2.0",
  "site_identifier": "CARDAMOM",
  "signature": "7d75fcc9fea1a9e78351a0d8290c6376",
  "change_event": {
    "context": "705691785743587",
    "change_name": "business_rule_cancel_one_time"
  },
  "one_time_pay_json": [
    {
      "date": "2024-04-19 00:00",
      "means": "Debit Card 7641",
      "amount": "50.00",
      "status": "disabled",
      "created": "2024-04-05 14:02",
      "canceled": "2024-04-05 14:06",
      "identifier": "705691785743587"
    }
  ]
}

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

Autopay Canceled by Business Rule

{
  "timestamp": "1712350608",
  "origin": "pnm",
  "site_customer_identifier": "807120000",
  "site_order_identifier": "9626617443",
  "payee_identifier": "CARDAMOM",
  "pnm_order_identifier": "87059892476",
  "version": "2.0",
  "site_identifier": "CARDAMOM",
  "signature": "3b4237004efff034508abe1e4bef4e3c",
  "change_event": {
    "context": "096694381026981",
    "change_name": "business_rule_cancel_recurring"
  },
  "auto_pay_json": {
    "date": "2024-04-06 00:00",
    "means": "Debit Card 3023",
    "amount": "$209.74",
    "status": "inactive",
    "canceled": "2024-04-05 13:56",
    "frequency": "Monthly",
    "identifier": "096694381026981"
  }
}

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

One Time Scheduled Payment Canceled by Risk Rule

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": "1712064713",
	"origin": "pnm",
	"site_customer_identifier": "SCI-1",
	"site_order_identifier": "SOI-1-1",
	"payee_identifier": "CARDAMOM",
	"pnm_order_identifier": "88888800001",
	"version": "2.0",
	"site_identifier": "CARDAMOM",
	"signature": "59aafa88596284e678f427ed76e2ff12",
	"one_time_pay_json":	[
	  {
		"identifier": "698724759837491",
		"amount": "24.00",
		"means": "Wells Fargo Bank NA (Arizona) 0019 (Personal Checking)",
		"date": "2024-04-04 00:00",
		"status": "disabled",
		"created": "2024-04-02 06:31",
	  }
	],
	"change_event": {
		"change_name": "payment_account_cancel_one_time",
		"context": "698724759837491"
	}
}

{
  "order_change_response": {
    "version": "2.0",
    "change": {
      "pnm_order_identifier": "88888800001"
    }
  }
}

Autopay Scheduled Canceled by Risk Rule

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": "1712065183",
	"origin": "pnm",
	"site_customer_identifier": "SCI-1",
	"site_order_identifier": "SOI-1-1",
	"payee_identifier": "CARDAMOM",
	"pnm_order_identifier": "88888800001",
	"version": "2.0",
	"site_identifier": "CARDAMOM",
	"signature": "7ee694c4fd7e9c0281ae29550c68c13",
	"auto_pay_json": {
		"identifier": "904624870770043",
		"amount": "current balance",
		"means": "Wells Fargo Bank NA (Arizona) 0019 (Personal Checking)",
		"date": "2024-05-15 00:00",
		"status": "inactive",
		"frequency": "Monthly",
		"canceled": "2024-04-02 06:39",
	},
	"change_event": {
		"change_name": "payment_account_cancel_recurring",
		"context": "904624870770043"
	}
}

{
  "order_change_response": {
    "version": "2.0",
    "change": {
      "pnm_order_identifier": "88888800001"
    }
  }
}

Retry of a One-Time Scheduled Payment is Canceled via API

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

{
  "timestamp": "1715106674",
  "origin": "API",
  "site_customer_identifier": "2222",
  "site_order_identifier": "2222",
  "payee_identifier": "CARDAMOM",
  "pnm_order_identifier": "84484295720",
  "version": "2.0",
  "site_identifier": "CARDAMOM",
  "signature": "86426d0f35fbc73e00ddd26b9eb1e443",
  "one_time_pay_json": [
    {
      "identifier": "181025028581868",
      "amount": "213.73",
      "means": "Debit Card 6501",
      "date": "2024-05-08 00:00",
      "status": "complete",
      "created": "2024-05-07 11:29"
    }
  ],
  "change_event": {
    "name": "api_cancel_retry_one_time",
    "context": "181025028581868"
  }
}

{
  "order_change_response": {
    "version": "2.0",
    "change": {
      "pnm_order_identifier": "84484295720"
    }
  }
}

Retry of a Declined Autopay Payment is Canceled via API

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

{
  "timestamp": "1745263966",
  "origin": "API",
  "site_customer_identifier": "176490000",
  "site_order_identifier": "5577668436",
  "payee_identifier": "S8456408962",
  "pnm_order_identifier": "80638818977",
  "version": "3.0",
  "site_identifier": "S8456408962",
  "signature": "1a90bece7ec928dd86c8328420a42d27c6b0a1d2194770b94caaadc1eb5ce1f0",
  "auto_pay_json": {
    "identifier": "949434695382962",
    "amount": "$213.73",
    "means": "Citibank Debit 0725",
    "date": "2025-04-28 00:00",
    "status": "active",
    "frequency": "Weekly",
    "created": "2025-04-18 14:49"
  },
  "change_event": {
    "name": "api_cancel_retry_recurring",
    "context": "949434695382962"
  }
}

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

Retry of a One-Time Scheduled Payment is Canceled by Agent

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

{
  "timestamp": "1715897952",
  "agent": "#",
  "origin": "agent",
  "site_customer_identifier": "34011817",
  "site_order_identifier": "3401181725110",
  "payee_identifier": "S7066856932",
  "pnm_order_identifier": "86279975490",
  "version": "3.0",
  "site_identifier": "S7066856932",
  "signature": "1e69e72dc10d8b17c3fa35a857855b0061f38e53f257df4f405aac14fae8f4c5",
  "change_event": {
    "name": "agent_cancel_retry_one_time",
    "context": "471099681137702",
    "change_by_agent_id": "U9578948150",
    "change_by_agent_email": "[change_by_agent_email–*****.com(15)]"
  },
  "one_time_pay_json": [
    {
      "date": "2024-06-14 00:00:00 -0700",
      "means": "Debit Card 1658",
      "amount": "164.30",
      "status": "active",
      "created": "2024-05-09 08:59:13 -0700",
      "agent_name": "Shelby Booker",
      "identifier": "531035387686283",
      "payment_type": "debit"
    }
  ]
}

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

Retry of a Declined Autopay Payment is Canceled by Agent

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

{
  "timestamp": "1719970231",
  "agent": "[email protected]",
  "origin": "agent",
  "site_customer_identifier": "4444",
  "site_order_identifier": "4444",
  "payee_identifier": "CARDAMOM",
  "pnm_order_identifier": "89362227814",
  "version": "3.0",
  "site_identifier": "CARDAMOM",
  "signature": "44e4a0bd819e317d9b4c882fff8d897e9bd3c6acafdf2a4a27fc7e6d9aba6d4",
  "auto_pay_json": {
    "date": "2024-07-10 00:00:00 -0700",
    "means": "Debit Card 7641",
    "amount": "$213.73",
    "status": "active",
    "created": "2024-07-02 18:28:10 -0700",
    "schedule": "every Wednesday",
    "frequency": "Weekly",
    "agent_name": "Craig Pearson",
    "identifier": "177724202205309",
    "payment_type": "debit",
    "duration_Type": "indefinite",
    "retry_canceled": "2024-07-02 18:30:31 -0700",
    "number_of_payment_skipped": 0,
    "number_of_payments_completed": 2
  },
  "change_event": {
    "name": "agent_cancel_retry_recurring",
    "context": "177724202205309",
    "change_by_agent_id": "U3094627939",
    "change_by_agent_email": "[change_by_agent_email-*****.com(16)]"
  }
}

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

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

Using the Order Change Callback

Defining the Changes to Monitor

Understanding the Callback Payload

🚧
Signature Considerations

Code Samples

Agent Creates a One-Time Payment

Consumer Creates One-Time Payment

Agent Cancels One-Time Payment

Consumer Cancels One-Time Payment

Agent Creates Autopay Schedule

Consumer Creates Autopay Schedule

Agent Cancels Autopay Schedule

Consumer Cancels Autopay Schedule

Agent Skips Autopay Payment

Consumer Skips Autopay Payment

Autopay Payment Amount is Changed

Payment Method is Created or Selected

Disbursement Initiated

Disbursement Approved

One-Time Scheduled Payment Canceled by Business Rule

Autopay Canceled by Business Rule

One Time Scheduled Payment Canceled by Risk Rule

Autopay Scheduled Canceled by Risk Rule

Retry of a One-Time Scheduled Payment is Canceled via API

Retry of a Declined Autopay Payment is Canceled via API

Retry of a One-Time Scheduled Payment is Canceled by Agent

Retry of a Declined Autopay Payment is Canceled by Agent

Agent Updates Account Notes

Defining the Changes to Monitor

Understanding the Callback Payload

🚧Signature Considerations

Code Samples

Agent Creates a One-Time Payment

Consumer Creates One-Time Payment

Agent Cancels One-Time Payment

Consumer Cancels One-Time Payment

Agent Creates Autopay Schedule

Consumer Creates Autopay Schedule

Agent Cancels Autopay Schedule

Consumer Cancels Autopay Schedule

Agent Skips Autopay Payment

Consumer Skips Autopay Payment

Autopay Payment Amount is Changed

Payment Method is Created or Selected

Disbursement Initiated

Disbursement Approved

One-Time Scheduled Payment Canceled by Business Rule

Autopay Canceled by Business Rule

One Time Scheduled Payment Canceled by Risk Rule

Autopay Scheduled Canceled by Risk Rule

Retry of a One-Time Scheduled Payment is Canceled via API

Retry of a Declined Autopay Payment is Canceled via API

Retry of a One-Time Scheduled Payment is Canceled by Agent

Retry of a Declined Autopay Payment is Canceled by Agent

Agent Updates Account Notes

🚧
Signature Considerations