Note: This endpoint is available only in the sandbox environment.
The Simulate Refund endpoint enables the simulation of refunds on cashouts processed by the integrator. These refunds may be enforced either by the receiving users or by the banks of the receiving users.
Key Features:
- Partial Refunds: The refund amount can be partial, meaning it’s not necessary to refund the full cashout amount in a single transaction.
- Multiple Refunds: Multiple refunds can occur on the same cashout, with each refund representing a portion of the originally transferred amount.
- Refund Limit: The total refunded amount, combining all individual refunds, cannot exceed the original cashout value.
This endpoint is particularly useful for integration testing, allowing the integrator to simulate various refund scenarios and verify the system’s behavior in cases of compulsory refunds.
Register Webhook: CashOutRefunded
We strongly recommend registering the new CashOutRefunded webhook event. This event allows you to monitor cash-out refunds made by the receiving user or the receiving bank. It is important to note that these refunds can be partial, and it is not necessary for the full amount of the cash-out to be returned in one go. Registering this webhook guarantees that you will be notified in real time of all refunds, including partial ones, ensuring complete control of refund operations.
Register the new webhook event on this endpoint: https://wudi-pay.readme.io/reference/register-webhook
Example of the CashOutRefunded webhook return
{ "amount": 100, "provider": "FAKE_BANK", "end_to_end_id": "D12345678202411141224Zweka2x9w5D", "correlation_id": "duh1hb5et441h8wrhnb1ty4j8ehe", "account_id": 73, "workspace_id": 34, "original_end_to_end_id": "E12345678202411141215ZCAoUWgHiEb", "updated_at": "2024-11-14T12:24:02.000000Z", "created_at": "2024-11-14T12:24:02.000000Z", "id": 2 }