Overview
Use this webhook to approve or reject inbound payments in real time.
When the PaaS platform notifies your system about an inbound payment, your endpoint must respond with a JSON body indicating whether to accept or reject the payment. The platform uses your response to decide whether the payment is approved.
Feature Enablement
A fintech administrator must:
- Log in to the Passport Dashboard.
- Navigate to Platform > Webhooks.
- In Callback URL, enter the endpoint where the PaaS platform should send inbound payment notifications.
- Enter the Secret Token that the PaaS platform will use when calling your endpoint.
- (Optional) Select Auto Approve Error if required by your use case.
- Click Save.
Authorization Feature Configuration
The Auto Approve Error feature is designed to automatically accept any payment when an error is received from your Callback URL. In this scenario, if the Platform attempts to send a POST message to your system and encounters any error response, it will automatically approve the inbound payment. This function ensures that payment processing continues smoothly even in the event of a technical issue with your system.
You must return your accept or reject response within 3 seconds. If your endpoint does not respond in time, the platform may treat the attempt as a failure.
Webhook response
Return a JSON response body with a single boolean field named accept.
- Accept the inbound payment:
{"accept": true}
- Reject the inbound payment:
{"accept": false}
Return HTTP 200 with Content-Type: application/json along with the JSON body above.