Webhooks can be configured to know when an ACH return for a payin was processed.

ACH return events

The webhook payload data field represents all ACH return detail fields returned by the get ACH return endpoint.

Events

ach_return.created

Payload

The webhook payload consists of:

data - represents all ACH return detail fields returned by the get ACH return endpoint
event_type - ach return events denoted by the format of ach_return.{ach_return_status}

{
    "data": {
        "ach_return_id": "ret_2sPFzoKTeD7b9alqNH0b9rjV6E2",
        // ...
        "status": "CREATED",
        // ...
    },
    "event_type": "ach_return.created"
}

Created

Event: ach_return.created

Triggered when an ACH return was processed and will be deducted from the merchant's next deposit.

Field	Description
`ach_return_id`	The unique ACH return identifier.
`merchant_id`	The unique merchant identifier.
`payin_id`	The unique payin identifier associated to the return.
`status`	The status of the ACH return.
`return_code`	The code explaining the reason the ACH payment was returned.
`return_desc`	The description explaining the reason the ACH payment was returned. This will be a human-readable value that may be presented to the end user.
`amount`	The amount captured by the ACH return, in minor units.
`currency_code`	Three-letter ISO currency code, in uppercase. Currently, only USD is supported.
`amount_splits`	The amount split defined on the associated payin.
`merchant_fees`	The ACH return fee billed to the merchant.
`metadata`	Valid JSON key-value object specified on the associated payin and persisted to the ACH return.
`created_at`	Date and time ACH return was created at in UTC RFC 3339 format.