v1

latestOpenAPI 3.0.02026-07-24440173.4 KB

Webhook

GetWebhooks

Retrieves all webhook events triggered by MyFatoorah to your endpoint based on webhook configuration and delivery status. Useful for retrieving missed webhook events if your server was down or slow.

post/v2/GetWebhooks

Request body

Startstring date-time

Start date for filtering webhook events (format: ISO 8601) in UTC Time zone

Endstring date-time

End date for filtering webhook events (format: ISO 8601) in UTC Time zone

Pageinteger

Page number for pagination (1-based). The number of events in a single page is 500 events.

Webhook V1: TransactionsStatusChanged, RefundStatusChanged, RecurringStatusChanged, BalanceTransferred, SupplierStatusChanged, DisputeStatusChanged.

Webhook V2: PAYMENT_STATUS_CHANGED, REFUND_STATUS_CHANGED, RECURRING_UPDATES, BALANCE_TRANSFERRED, SUPPLIER_STATUS_CHANGED, DISPUTE_STATUS_CHANGED

Status'Waiting' | 'Running' | 'Succeeded' | 'Failed'

Status of webhook attempts to filter: Waiting (not yet triggered from MyFatoorah), Running (The webhook is triggered from MyFatoorah but we are still attempting to reach your endpoint till we get success status code or all the retries are consumed.), Succeeded (successfully received), Failed (Your server failed to receive the webhook and all the retries are consumed.)

Keystring[]

Array of Keys based on the KeyType

KeyType'InvoiceId' | 'CustomerReference' | 'WebhookReference'

InvoiceId: Filters for Payment Webhook with this InvoiceId. CustomerReference: Filters for Payment Webhook with this CustomerReference. WebhookReference: Filters for webhook events with this Webhook Reference

Response

Successful response

IsSuccessboolean

Indicates if the request was successful

Messagestring

Status or result message