Registering a Webhook URL

Please contact system administrators to register a webhook URL for transaction webhooks. Below is an example payload provided by the transaction webhook upon updates made to said transaction(s).

Payload Example

{
  "category": "transactions",
  "action": "MODIFY",
  "data": {
    "company": "merchant1",
    "uuid": "a00b4fdb-6e61-4f06-812d-493058447042",
    "numericId": 99,
    "method": "RCC",
    "type": "Debit",
    "amount": 482,
    "status": "Returned",
    "standardEntryClassCode": null,
    "createdAt": "2025-05-28T19:16:28.091530868Z",
    "externalUniqueId": null,
    "holdDetails": null,
    "changeDetails": null,
    "voidDetails": null,
    "paymentDetails": {
      "name": "Kyle Bode",
      "accountType": "Checking",
      "routingNumber": "121000248",
      "bankDetails": {
        "address": "7TH FL,  MAC N9300-074",
        "areaCode": "800",
        "city": "MINNEAPOLIS",
        "state": "MN",
        "name": "WELLS FARGO BANK, NA",
        "phonePrefix": "745",
        "phoneSuffix": "2426",
        "zip": "55415",
        "zipExt": "0000",
        "servicingFRBNumber": "121000374"
      }
    },
    "batchDetails": {
      "batchUuid": null,
      "batchNumericId": null,
      "batchedAt": "2025-05-30T15:29:07.016232064Z"
    },
    "settlementDetails": {
      "settlementUuid": null,
      "settlementNumericId": null,
      "expectedToSettleAt": null,
      "settlementProcessedAt": null,
      "lateReturnSettlementUuid": null,
      "lateReturnSettlementNumericId": null,
      "lateReturnSettlementProcessedAt": null
    },
    "returnDetails": {
      "returnCode": "A",
      "returnReason": "NSF - Not Sufficient Funds",
      "returnedAt": "2025-05-30T15:29:15.894111371Z",
      "lateReturnedAt": null
    }
  }
}

The action field will only ever be one of three values: "INSERT", "MODIFY" and "REMOVE". This action field, along with the category field, details the type of action that is expected with the following payload data.

Other important fields include batchDetails, returnDetails, settlementDetails, and paymentDetails. These fields are objects which contain additional information regarding the transactions batch information, return information, settlement information, and payment information respectively.

Schema

This is the schema for the payload of the transaction webhook

{
  "companyUuid": "string",
  "categoryUuid": "string",
  "category": "string",
  "changeDetails": {
    "changeCode": "string",
    "changeReason": "string",
    "changedAt": "string (date-time)",
    "oldValues": {
      "key": "string",
      "value": "string"
    },
    "newValues": {
      "key": "string",
      "value": "string"
    },
    "filterUuid": "string"
  },
  "uuid": "string",
  "numericId": "integer",
  "method": "string",
  "type": "string",
  "amount": "integer",
  "status": "string",
  "standardEntryClassCode": "string (nullable)",
  "paymentDetails": {
    "name": "string",
    "accountType": "string",
    "routingNumber": "string",
    "bankDetails": {
      "address": "string",
      "areaCode": "string",
      "city": "string",
      "state": "string",
      "name": "string",
      "phonePrefix": "string",
      "phoneSuffix": "string",
      "zip": "string",
      "zipExt": "string",
      "servicingFRBNumber": "string"
    }
  },
  "createdAt": "string (date-time)",
  "batchDetails": {
    "batchUuid": "string (nullable)",
    "batchNumericId": "integer (nullable)",
    "batchedAt": "string (date-time, nullable)"
  },
  "settlementDetails": {
    "settlementUuid": "string (nullable)",
    "settlementNumericId": "integer (nullable)",
    "expectedToSettleAt": "string (nullable)",
    "settlementProcessedAt": "string (date-time, nullable)",
    "lateReturnSettlementUuid": "string (nullable)",
    "lateReturnSettlementNumericId": "integer (nullable)",
    "lateReturnSettlementProcessedAt": "string (date-time, nullable)"
  },
  "returnDetails": {
    "returnCode": "string",
    "returnReason": "string",
    "returnedAt": "string (date-time, nullable)",
    "lateReturnedAt": "string (date-time, nullable)"
  },
  "holdDetails": {
    "holdReason": "string",
    "holdCode": "string",
    "releasedAt": "string (date-time, nullable)"
  },
  "voidDetails": {
    "voidedAt": "string (date-time, nullable)"
  },
  "externalUniqueId": "string (nullable)",
  "companyName": "string",
  "effectiveDate": "string (nullable)",
  "submittedForDate": "string (nullable)",
  "rtpTransactionId": "string (nullable)",
  "isDuplicate": "boolean",
  "routing-account": "string (nullable)",
  "sequenceUuid": "string (nullable)"
}