POST
/
api
/
webhook
/
merchant
  curl --request POST \
  --url https://api.atoa.me/api/webhook/merchant \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "https://api/endpoint",
  "event": "PAYMENTS_STATUS, EXPIRED_STATUS or REFUND_STATUS"
}'

{
  "webhookId": "4a124f25-fe8d-47a0-92c8-16d94cbfe24c",
  "url": "https://api/endpoint",
  "event": "PAYMENTS_STATUS, EXPIRED_STATUS or REFUND_STATUS"
}

Generate a webhook event for a specific endpoint . Atoa utilizes webhooks to instantly alert your application, which is particularly valuable for asynchronous events, such as updates on payment transaction status, including completion, failure, or pending. Begin by generating a webhook event for a specific endpoint.

When a webhook response is anything other than HTTP 200, it is considered a failure. When this happens, our system uses a retry mechanism, following an exponential back-off strategy. If the webhook continues to fail over 24 hours, Atoa will stop the retry attempts. In these scenarios, we will send an email notification to the business owner with relevant information, including the webhook URL.

​
Webhook Subscription Guide

To stay updated on the status of payments, subscribe to our webhook with the appropriate event types.

  • PAYMENT_STATUS: Receive webhook payloads for successful, pending, and failed payments.
  • EXPIRED_STATUS: Receive webhook payloads for expired payments.
  • REFUND_STATUS: Receive webhook notifications when refunds are processed. You’ll be notified for the following refund statuses:
    • COMPLETED: Refund has been successfully processed
    • CANCELLED: Refund request was cancelled
    • FAILED: Refund processing failed

The payment will expire after the time specified in the expiresIn parameter when generating the payment request.

Refer to the refunds API for more information on refunds.

Ensure your webhook listener is set up to handle these payloads and process the events accordingly.

AUTHORIZATIONS: Bearer <token>

REQUEST BODY SCHEMA

url
string
required

Merchant webhook url provided will receive notification on status code 200 and will be retried on failure.

event
string
required

Event subscribed to which the webhook will be invoked.

RESPONSE

webhookId
string
url
string
event
string
Get List of Available Institutions or BanksGet all merchant webhooks