Webhooks

Webhooks

We advise that you subscribe to the following webhooks for all use cases. Depending on your proposition, there are other webhooks that also should be utilised. A full list of webhook notifications is available here and includes examples of the full data set available for each webhook.

• PAYIN: for individual notifications of all payments received into an account (credits)
• PAYOUT: for individual notifications of all payments made from an account (debits)
• Payment Compliance Status: for notification of a payment being held/released by Modulr
• Account Status Change: for notification of an account suspension by Modulr because subsequent action will be needed by the Partner

PAYIN Webhook

For all inbound payments, whether it is triggered by you loading your account, a scheme reversed payment or any other unexpected payment into an account, the PAYIN webhook will provide the following key data parameters:

• Payment Types which includes PO_REV for any scheme reversals back into the account
• Payer Name and Details which may match the destination account you have sent a payment to
• Modulr References of receiving AccountID, PaymentID and TransactionID
• ReturnReason Code – refer to the Payment Return Reasons for the description relating to each code
• Payment Reference – passed via the scheme, but note that on a return it might be different from the one you used on the outbound payment
• OriginalSchemeId – this is the original scheme reference for the earlier outbound payment but only when reversed