Files webhook

Payology sends POST to the HTTPS receiver configured for your organization. Authentication/custom headers depend on that configuration; there is no universal signature header in the reviewed sender. Acknowledge durable receipt with any 2xx; the body is receiver-defined and may be empty. Delivery may be repeated: deduplicate by webhook_token and business identifiers. Network failures, 408, 429 and 5xx are retryable; other HTTP errors are terminal except for one configured OAuth token refresh on 401/403. Retry count, delay and HTTP timeout are configurable and were not checked in a live environment.

Receiver acknowledgement

After durably accepting the event, the receiver may return:

HTTP/1.1 204 No Content

An empty HTTP 200 is also accepted. A response JSON body is optional and defined by the receiver.

Headers by file event

EventPayloadAdditional headers
Check File CreationArray of X9 file objectsevent-type: Check File Creation
NACHA File CreationArray of ACH file objectsevent-type: NACHA File Creation
CC SettlementsOne CC file objectevent-type: CC Settlements; payment-method-type: CC; file-token; file-date

Every delivery also contains webhook-notification: true and webhook_token. The examples below correspond to these event types.

Payload

JSON payload sent by Payology to the configured receiver.

Headers
string
enum
required

Fixed marker identifying a Payology webhook delivery.

Allowed:
uuid
required

Delivery-log token reused for retries of that delivery. Store it to deduplicate repeated deliveries.

string
enum
required

Event name. Files payload shape depends on this header.

Allowed:
string
enum

Emitted for CC Settlements. The X9/ACH file producers do not add this header.

Allowed:
uuid

CC Settlements only.

string

CC Settlements only.

Responses
200

Receiver accepted the event. Response body is optional and defined by the receiver.

204

Receiver accepted the event with no response body.

408

Receiver timeout; delivery is retryable.

429

Receiver rate limit; delivery is retryable.

2XX

Any successful 2xx response acknowledges delivery.

4XX

Other receiver errors generally end this delivery. Configured OAuth may refresh once after 401 or 403.

5XX

Receiver server error; delivery is retryable.

LoadingLoading…