Webhook Payload Schemas

{
  "webhook_registration_account_number": "1234567",
  "amount": 100,
  "timestamp": true,
  "transaction_id": "JX5T452HI0",
  "tran_code": "144",
  "tran_code_description": "Transfer to DDA",
  "debit_credit_flag": "Debit",
  "description_line1": "UTB Global|1234567|7654321|",
  "description_line2": "Payment for service|c628ce5b-cc34-42ae-959f-3f2f14971f97",
  "debit_account_number": "1234567",
  "credit_account_number": "7654321",
  "counter_party_name": "UTB Global",
  "memo": "Payment for service",
  "references": {
    "payment_id": "c628ce5b-cc34-42ae-959f-3f2f14971f97"
  }
}

{
  "transaction_webhook_payload": {
    "type": "object",
    "properties": {
      "webhook_registration_account_number": {
        "type": "string",
        "description": "Account associate with the webhook registration.",
        "nullable": true,
        "example": "1234567"
      },
      "amount": {
        "type": "number",
        "description": "The amount of the transaction.",
        "format": "double",
        "example": 100
      },
      "timestamp": {
        "type": "string",
        "description": "Date the transaction was submitted to the system. When the data source is \"cache\", this will include a time component expressed in the UTC time zone. When the data source is \"core\", this will have a zeroed time component for memo posted transactions and will be null for hard posted transactions.",
        "format": "date-time",
        "nullable": true,
        "example": "2023-06-06T12:29:20"
      },
      "transaction_id": {
        "type": "string",
        "description": "Transaction Id.",
        "nullable": true,
        "example": "JX5T452HI0"
      },
      "tran_code": {
        "type": "string",
        "description": "Transaction code.",
        "nullable": true,
        "example": "144"
      },
      "tran_code_description": {
        "type": "string",
        "description": "Transaction code description.",
        "nullable": true,
        "example": "Transfer to DDA"
      },
      "debit_credit_flag": {
        "type": "string",
        "description": "Direction of the transaction. Expected values: Debit or Credit",
        "nullable": true,
        "example": "Debit"
      },
      "description_line1": {
        "type": "string",
        "description": "Description Line 1 of the transaction.",
        "nullable": true,
        "example": "UTB Global|1234567|7654321|"
      },
      "description_line2": {
        "type": "string",
        "description": "Description Line 2 of the transaction.",
        "nullable": true,
        "example": "Payment for service|c628ce5b-cc34-42ae-959f-3f2f14971f97"
      },
      "debit_account_number": {
        "type": "string",
        "description": "The account this transaction was debited from. This field may be null if the transaction depending on transaction type/direction.",
        "nullable": true,
        "example": "1234567"
      },
      "credit_account_number": {
        "type": "string",
        "description": "The account this transaction was credited to. This field may be null if the transaction depending on transaction type/direction.",
        "nullable": true,
        "example": "7654321"
      },
      "counter_party_name": {
        "type": "string",
        "description": "The name of the counter party. This field may be null if the transaction depending on transaction type. Applicable transaction types: internal_transfer, wire",
        "nullable": true,
        "example": "UTB Global"
      },
      "memo": {
        "type": "string",
        "description": "Memo line from the transaction. This field may be null if the transaction depending on transaction type. Applicable transaction types: internal_transfer",
        "nullable": true,
        "example": "Payment for service"
      },
      "references": {
        "type": "object",
        "additionalProperties": {
          "type": "string"
        },
        "description": "Dictionary of reference IDs for the transaction. Expected IDs included by transaction type: internal_transfer: payment_id wire: payment_id, wire_system_reference_id, sender_reference (debit only)",
        "nullable": true,
        "example": {
          "payment_id": "c628ce5b-cc34-42ae-959f-3f2f14971f97"
        }
      }
    },
    "additionalProperties": false
  }
}