Stop Payments Payload

The Stop Payments payload (payloadTypeId=800) relates to any stop payments placed on an ACH transaction or a check on a customer's checking account.

Possible properties:

Click to expand
  • accountId
  • accountNumberMasked
  • amountMax
  • amountMin
  • checkDateWritten
  • checkNumberMaximum
  • checkNumberMinimum
  • comment
  • companyId
  • customerId
  • customerTag
  • expirationDate
  • externalApplicationId
  • externalUrl
  • externalUserId
  • externalUserName
  • hitAmount
  • payeeName
  • payloadTypeId
  • paymentType
  • stopPayTransactionType
  • stopPayType
  • version

Example Payloads

{
  "accountId":12208791,
  "contextId":"14ee64d0-2d4f-4db0-ba61-fd05ac943c4f",
  "data":[
    [
      {
        "customerId":12208781,
        "accountId":12208791,
        "accountNumberMasked":"*************0563",
        "amountMin":1001,
        "amountMax":1001,
        "companyId":"2143258745",
        "comment":"Test to Company ID Blank #2",
        "stopPayType":"OneTime",
        "expirationDate":"2022-12-27T00:00:00.000Z",
        "stopPayTransactionType":"Debit",
        "payloadTypeId":800,
        "paymentType": "ACH",
        "version":1
      }
    ]
  ],
  "eventTimeUtc":"2022-06-27T17:09:00.000+00:00",
  "externalAccountId":0,
  "impactedCustomerId":12208781,
  "impactedUserId":0,
  "payloadTypeId":800,
  "userEventId":2637020617,
  "userEventTypeId":30608001,
  "version":1
}
{
  "accountId": 12208791,
  "contextId": "14ee64d0-2d4f-4db0-ba61-fd05ac943c4f",
  "data": [
    [
      {
        "customerId": 12208781,
        "accountId": 12208791,
        "accountNumberMasked": "*************0563",
        "amountMin": 1001,
        "amountMax": 1001,
        "hitAmount": 1001,
        "companyId": "2143258745",
        "comment": "Test to Company ID Blank #2",
        "stopPayType": "OneTime",
        "expirationDate": "2022-12-27T00:00:00.000Z",
        "stopPayTransactionType": "Debit",
        "payloadTypeId": 800,
        "paymentType": "ACH",
        "version": 1
      }
    ]
  ],
  "eventTimeUtc": "2022-06-27T17:09:00.000+00:00",
  "externalAccountId": 0,
  "impactedCustomerId": 12208781,
  "impactedUserId": 0,
  "payloadTypeId": 800,
  "userEventId": 2637020617,
  "userEventTypeId": 30608003,
  "version": 1
}