Payments webhooks

❗️
API version 2023-01-01 deprecating
This version will be deprecated on May 1, 2025. If your platform is on this version, you should upgrade to at least 2023-12-01 to simplify authorization and access new features.

Payins

Webhooks can be configured to receive updates on every status change that occurs through the life cycle of a payin.

Payin webhook payload

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

Payin events

Event	Description
`payin.created`	Triggered when a payin is created and waiting approval. The payin status is `CREATED`.
`payin.presenting`	Triggered when a payin is presented on an EMV device and waiting for the user to process the payin on the device.. The payin status is `PRESENTING`.
`payin.processing`	Triggered when a payin is approved and is currently processing. The payin status is `PROCESSING`.
`payin.succeeded`	Triggered when a payin has completed processing and the funds are available for deposit. The payin status is `SUCCEEDED`.
`payin.failed`	Triggered when a payin unsuccessfully attempted to process. The payin status is `FAILED`.
`payin.canceled`	Triggered when a payin is canceled before the payin completes processing. The payin status is `CANCELED`.
`payin.in_review`	Triggered when a payin is flagged for risk review. The payin status is `IN_REVIEW`.

Refunds

Webhooks can be configured to receive updates on every status change that occurs through the life cycle of a refund.

Refund webhook payload

The webhook payload data field represents all refund detail fields.

Refund events

Event	Description
`refund.created`	Triggered when a refund is created and waiting approval. The refund status is `CREATED`.
`refund.processing`	Triggered when a refund is approved and is currently processing. The refund status is `PROCESSING`.
`refund.succeeded`	Triggered when a refund has completed processing. The refund status is `SUCCEEDED`.
`refund.failed`	Triggered when a refund unsuccessfully attempted to process. The refund status is `FAILED`.
`refund.canceled`	Triggered when a refund is canceled before the refund completes processing. The refund status is `CANCELED`.
`refund.in_review`	Triggered when a refund is flagged for risk review. The refund status is `IN_REVIEW`.