Webhook glossary

event name	event webhook name
Mass payment file processing is completed	mass_payment_file_processed
Mass sending of payments is completed	mass_payments_sent
Payment status changed	payment_status_changed
Account verification status changed	verification_status_changed
Beneficial owners status changed	bo_status_changed

Mass payment file process is completed

If you have uploaded a file for bulk payments, it takes some time to process the file. Rather than waiting for this process to complete and rechecking its status, you can subscribe to a real time notification about this event via this webhook.

Example

JSON

{
  "eventName": "mass_payment_file_processed",
  "data": {
    "processed": true
  }
}

Mass sending of the payments is completed

Once your mass payment file is processed, you can send all valid payments. With this webhook, you can subscribe to the asynchronous result of your mass payment. Once all valid payments are sent, this webhook will trigger.

Example

JSON

{
  "eventName": "mass_payments_sent",
  "data": {
    "sent": true
  }
}

Payment status changed

When you send a payment, a new payment is created with an initial status, like Awaiting-cash-out. This status will be changed depending on what event is currently taking place for his payment. When the status of this payment changes, the webhook for this event will be launched for the sender and recipient of this payment. It contains basic information: id, from, to, amount and status.

Example

JSON

{
  "eventName": "payment_status_changed",
  "data": {
    "id": 1,
    "from": "[email protected]",
    "to": "[email protected]",
    "amount": 12.34,
    "status": "Awaiting-cash-out"
  }
}

Account verification status changed

The onboarding process for verified users in SnapRefund an asynchronous KYB process. This webhook lets you subscribe to your account verification status in real time after you've signed up and submitted your information for verification.

Example

JSON

{
  "eventName": "verification_status_changed",
  "data": {
    "status": "verified"
  }
}

Beneficial owners status changed

If you are an organization, you will need to go through an additional verification process after confirming your account. Depending on your entity circumstances, you may need to verify beneficial owners that hold significant equity in your business.

This webhook lets you subscribe to the status of beneficial ownership validation for your account.

Example

JSON

{
  "eventName": "bo_status_changed",
  "data": {
    "status": "certified"
  }
}