Pay Ops cookbook

Register a webhook so Payabli notifies your server in real time when an event occurs. This recipe creates a single subscription for one event type.

/// Prerequisites

Before you start, make sure you have the following:

• A publicly accessible URL that accepts POST requests. Supported ports are 80, 443, 8080, and 4443. For local development, see the webhook quickstart for tunneling setup.
• An eventType to subscribe to. See the webhook payloads reference for all available events.
• The ownerId of the paypoint or organization that owns the notification, plus its matching ownerType: 0 for organization or 2 for paypoint.

/// Step 1: Create the webhook subscription

Register the webhook with Payabli. Set method to web and target to your server’s public URL.

Send a POST request to /api/Notification.

$
curl -X POST "https://api.payabli.com/api/Notification" \
>
  -H "Content-Type: application/json" \
>
  -H "requestToken: YOUR_API_TOKEN" \
>
  -d '{
>
    "content": {
>
      "eventType": "ApprovedPayment"
>
    },
>
    "frequency": "untilcancelled",
>
    "method": "web",
>
    "ownerId": 236,
>
    "ownerType": 0,
>
    "status": 1,
>
    "target": "https://your-server.example.com/webhook"
>
  }'

The response returns the notificationId in responseData. Save this — you need it to update or delete the subscription later.

1
{
2
  "isSuccess": true,
3
  "responseCode": 1,
4
  "responseData": 1717,
5
  "responseText": "Success"
6
}

See Create notification for the full API reference.

/// What’s next

You’re now subscribed. Trigger the event to see a payload land on your server. Learn more about webhook payloads and managing notifications.

Retrieve a list of ACH returns for a paypoint to monitor failed ACH debits and respond to return codes. The disputes endpoint returns both card chargebacks and ACH returns, so this recipe filters by payment method to return ACH-side records only.

/// Prerequisites

Before you start, make sure you have the following:

• Your paypoint’s entrypoint identifier
• An API token with access to the paypoint. See the authentication recipe for help

/// List ACH returns for the paypoint

Query the disputes endpoint with a method filter of ach to exclude card chargebacks from the results. Filtering on method (instead of status) keeps the request robust to the different status values an ACH return can carry, including R29 returns and any legacy records.

Send a GET request to /api/Query/chargebacks/{entry}.

$
curl -X GET "https://api.payabli.com/api/Query/chargebacks/your-entry-point?method(eq)=ach&limitRecord=20&fromRecord=0" \
>
  -H "requestToken: YOUR_API_TOKEN"

The response includes one record per ACH return. The ReasonCode field contains the Nacha return code (for example, R01 for insufficient funds), Reason contains the human-readable explanation, and Transaction contains the original ACH transaction details.

1
{
2
  "Summary": {
3
    "totalRecords": 1,
4
    "totalAmount": 250.00,
5
    "totalNetAmount": 250.00,
6
    "totalPages": 1,
7
    "pageSize": 20
8
  },
9
  "Records": [
10
    {
11
      "Id": 612,
12
      "Method": "ach",
13
      "Status": 4,
14
      "ChargebackDate": "2026-04-22T00:00:00Z",
15
      "CreatedAt": "2026-04-22T14:18:03Z",
16
      "NetAmount": 250.00,
17
      "Reason": "Insufficient Funds",
18
      "ReasonCode": "R01",
19
      "AccountType": "XXXXXX1234",
20
      "LastFour": "XXXXXX1234",
21
      "PaymentTransId": "10-bfcd5a17861d4a8690ca53c00000X",
22
      "PaypointEntryname": "your-entry-point",
23
      "PaypointDbaname": "Big Sky Imports",
24
      "Customer": {
25
        "customerId": 1324,
26
        "FirstName": "Janis",
27
        "LastName": "Berzins",
28
        "BillingEmail": "janis.berzins@example.com"
29
      },
30
      "Transaction": {
31
        "Method": "ach",
32
        "Operation": "Sale",
33
        "TotalAmount": 250.00,
34
        "NetAmount": 250.00,
35
        "TransactionTime": "2026-04-18T09:32:11Z",
36
        "PaymentTransId": "10-bfcd5a17861d4a8690ca53c00000X"
37
      }
38
    }
39
  ]
40
}

See List disputes by paypoint for the full API reference, including all available filters and pagination options.

/// What’s next

You’ve retrieved ACH returns for a paypoint. To resolve them, see Managing merchant ACH debit failures and returns and the ACH return codes reference. To get notified when a return comes in, subscribe to the ReceivedAchReturn webhook event.