🚀 VaultsPay API v1 is live. See what's new →
WebhooksTransfer Webhooks

Transfer Webhooks

When a transaction is successfully performed in VaultsPay, a webhook event is triggered and delivered to all active webhook subscriptions configured for the user (or their parent agent).


Event Overview

Event NameTRANSACTION_PERFORMED
Delivery MethodHTTP POST
Content-Typeapplication/json
Retry Policy3 attempts with exponential backoff

Payload Structure

Successful Transaction

{
  "transactionId": "3ac58f37-3cc3-49b3-b3dd-9f83e4263b13",
  "amount": 1000.00,
  "status": "SUCCESS",
  "refId": "CH-998877"
}

Reversed Transaction

{
  "transactionId": "3ac58f37-3cc3-49b3-b3dd-9f83e4263b13",
  "amount": 1000.00,
  "status": "REVERSED",
  "refId": "CH-998877"
}

Field Definitions

FieldTypeDescription
transactionIdUUIDUnique identifier of the transaction.
amountDecimalTransaction amount in cents.
statusEnumFinal transaction status — SUCCESS or REVERSED.
refIdStringChannel reference ID provided in the original request.