Merchant ACH Funding Item Subscriptions

Receive notifications for individual ACH transaction funding details, providing visibility into each ACH credit or debit as it is processed.

Subscription Arguments

When creating a merchant ACH funding item subscription, you can specify filtering arguments to receive only the events you need.

Required Arguments

Argument	Type	Description
entity_ksuid	string	Required. Your 27-character merchant identifier

Optional Filter Arguments

Argument	Type	Description
roll_up	boolean	When true, includes funding items for child merchants in the hierarchy. Default: false
transaction_event_type	string	Filter by transaction event type
transaction_movement_type	string	Filter by movement type: CREDIT or DEBIT
transaction_amount_min	integer	Minimum transaction amount (in minor units)
transaction_amount_max	integer	Maximum transaction amount (in minor units)
net_transaction_amount_min	integer	Minimum net transaction amount (in minor units)
net_transaction_amount_max	integer	Maximum net transaction amount (in minor units)

---

Webhook Payload

When an ACH funding item event matches your subscription criteria, your webhook receives a JSON payload with a wrapper containing metadata and a data array of events.

Wrapper Fields

Field	Type	Description
id	UUID	Unique identifier for this notification
type	string	Subscription type (merchant_ach_funding_item)
timestamp	string	When the notification was generated
attempts	array	Delivery attempt history
data	array	Array of ACH funding item event objects

Event Fields

Field	Type	Description
funding_item_id	string	Unique identifier for the funding item
acquiring_bank_id	string	Acquiring bank identifier
merchant_id	string	Merchant identifier
transaction_event_id	string	Related transaction event identifier
transaction_datetime	string	When the transaction occurred
merchant_dba_name	string	Merchant DBA (doing business as) name
transaction_id	string	Transaction identifier
transaction_event_type	string	Type of transaction event
transaction_movement_type	string	Movement type: CREDIT or DEBIT
transaction_amount	string	Transaction amount in currency units
grouped_fee_total_amount	string	Total grouped fees in currency units
withheld_total_amount	string	Total withheld amount in currency units
net_transaction_amount	string	Net transaction amount in currency units
currency_code	string	ISO 4217 currency code
currency_exponent	string	Decimal places for currency

Example Payload

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "type": "merchant_ach_funding_item",
  "timestamp": "2024-01-15 14:30:00.000 -0800",
  "attempts": [],
  "data": [
    {
      "funding_item_id": "FI-2024-0001234",
      "acquiring_bank_id": "38JJwCSHfpeHvxATBDjrwmU9rIH",
      "merchant_id": "38JJwH9aUdIi2EtTJTCH7vzm8bw",
      "transaction_event_id": "38JJwDbCjHRzWaz0qBQskHimXQk",
      "transaction_datetime": "2024-01-15 14:30:00.000",
      "merchant_dba_name": "Example Merchant",
      "transaction_id": "TXN-001234",
      "transaction_event_type": "ACH_CREDIT",
      "transaction_movement_type": "CREDIT",
      "transaction_amount": "500.00",
      "grouped_fee_total_amount": "1.50",
      "withheld_total_amount": "0.00",
      "net_transaction_amount": "498.50",
      "currency_code": "840",
      "currency_exponent": "2"
    }
  ]
}

---

API Operations

List Subscriptions

Retrieve a paginated list of merchant ACH funding item subscriptions.

curl -X GET "https://api.notifications.paynetworx.cloud/v1/subscriptions/merchant_ach_funding_item?limit=10&offset=0" \
  -H "Authorization: YOUR_API_TOKEN"

Query Parameters

Parameter	Type	Default	Description
limit	integer	10	Maximum number of results (0-1000)
offset	integer	0	Number of results to skip

---

Create Subscription

Create a new merchant ACH funding item subscription with filtering arguments.

curl -X POST "https://api.notifications.paynetworx.cloud/v1/subscriptions/merchant_ach_funding_item" \
  -H "Authorization: YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "ACH Credits Only",
    "description": "Notifications for ACH credit transactions",
    "arguments": {
      "entity_ksuid": "2MER123CHANT456KSUID789ABC",
      "transaction_movement_type": "CREDIT",
      "roll_up": false
    }
  }'

Request Body

Field	Type	Required	Description
name	string	Yes	Name for the subscription (1-64 characters)
description	string	No	Description (1-256 characters)
arguments	object	Yes	Filter arguments (see above)

---

Get Subscription

Retrieve details of a specific subscription.

curl -X GET "https://api.notifications.paynetworx.cloud/v1/subscriptions/merchant_ach_funding_item/{id}" \
  -H "Authorization: YOUR_API_TOKEN"

---

Update Subscription

Update an existing subscription.

curl -X PUT "https://api.notifications.paynetworx.cloud/v1/subscriptions/merchant_ach_funding_item/{id}" \
  -H "Authorization: YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Name",
    "description": "Updated description",
    "arguments": {
      "entity_ksuid": "2MER123CHANT456KSUID789ABC",
      "transaction_amount_min": 10000
    }
  }'

---

Delete Subscription

Delete a subscription. This also removes all destination mappings.

curl -X DELETE "https://api.notifications.paynetworx.cloud/v1/subscriptions/merchant_ach_funding_item/{id}" \
  -H "Authorization: YOUR_API_TOKEN"

---

List Subscription Destinations

List webhook destinations linked to this subscription.

curl -X GET "https://api.notifications.paynetworx.cloud/v1/subscriptions/merchant_ach_funding_item/{id}/destinations" \
  -H "Authorization: YOUR_API_TOKEN"

---

Add Destination to Subscription

Link a webhook destination to receive events from this subscription.

curl -X POST "https://api.notifications.paynetworx.cloud/v1/subscriptions/merchant_ach_funding_item/{id}/destinations" \
  -H "Authorization: YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "destination_id": "9603F4B2-1874-42FE-A2BC-F7B45C45A9D6"
  }'

---

Remove Destination from Subscription

Unlink a webhook destination from this subscription.

curl -X DELETE "https://api.notifications.paynetworx.cloud/v1/subscriptions/merchant_ach_funding_item/{id}/destinations/{destination_id}" \
  -H "Authorization: YOUR_API_TOKEN"

---

Send Test Event

Send a test notification to verify your webhook integration.

curl -X POST "https://api.notifications.paynetworx.cloud/v1/subscriptions/merchant_ach_funding_item/{id}/test" \
  -H "Authorization: YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Query Parameters

Parameter	Type	Default	Description
dry_run	boolean	false	When true, returns the payload that would be sent without actually delivering it

Request Body (Optional)

Field	Type	Description
overrides	object	Optional field overrides for the test payload

This sends a sample ACH funding item payload to all linked webhook destinations. Use dry_run=true to preview the payload without sending.

---

Error Responses

Status	Description
400	Bad Request - Invalid input parameters
403	Forbidden - Insufficient permissions
500	Internal Server Error