Webhooks

This document outlines the available webhooks provided by Push, detailing each webhook type and the structure of the webhook payloads.

{
  "type": "", // the type of the webhook
  "data": {
    // documented fields from the below reference guide
  },
  "timestamp": "2024-01-14T22:31:02.756096Z" // timestamp for the webhook event
}

Types

intent.approved

This webhook is triggered when an intent is approved.

Key	Type	Description
id	string	Unique identifier for the intent.
idempotency_key	string	Idempotency key for the intent.
direction	string	Direction (either cash_in or cash_out)
amount	float	Amount of the payment.
status	string	Status of the intent.
currency	string	Currency code (USD).
limits_utilization.daily_cash_in	string	Daily cash-in limit usage, formatted to two decimal places.
limits_utilization.daily_cash_out	string	Daily cash-out limit usage, formatted to two decimal places.
limits_utilization.monthly_cash_in	string	Monthly cash-in limit usage, formatted to two decimal places.
limits_utilization.monthly_cash_out	string	Monthly cash-out limit usage, formatted to two decimal places.

intent.declined

This webhook is triggered when an intent is declined.

Key	Type	Description
id	string	Unique identifier for the intent.
idempotency_key	string	Idempotency key for the intent.
direction	string	Direction (either cash_in or cash_out)
amount	float	Amount of the payment.
status	string	Status of the intent.
decline_category	string	A reason for the decline.
currency	string	Currency code (USD).

Retries

If we do not receive a success response from your webhook endpoint, we will retry delivery. We use exponential backoff to increase the time between each retry.

• sandbox: delivery will be attempted 3 times.
• production: delivery will be attempted for 3 days.

Best Practices

Handle Duplicates

Your application should include logic to ensure a given intent is not handled more than once. We provide at-least-once delivery for webhooks. Rarely, a webhook may be delivered more than once. Additionally, when we return the user to your specified redirect URL, your application may process the completed intent as part of that request. You should ensure that your application ignores the webhook if it has already processed the intent via a redirect.