Skip to main content

Transaction Event

Overview

The Transaction webhook event is triggered when a transaction is created or its status changes. Transactions are generated from financial activities and are assigned a specific Status depending on its progress. For more information see the Transactions documentation page.

A Transaction can have one the following statuses at a given time:

  • Pending
  • Failed
  • Settled

To configure a Transaction webhook subscription, reference the Webhook Configuration page.

Event Payload Structure

When a Transaction event occurs, NOAH sends a webhook notification to your configured endpoint with the following JSON Payload; some objects within this are optional depending on the usage from which the transaction was created.

  • FiatPayment - this object is included if there is a fiat payment method attributed to the transaction.
  • Orchestration - this object is included if the transaction is a result of a Rule execution.
  • Breakdown - list explaining how the transaction amount should be split
{
"Data": {
"ID": "123e4567-e89b-12d3-a456-426614174000",
"PublicID": "TX1234567890",
"Network": "Bitcoin",
"Created": "2024-04-16T08:00:55Z",
"Status": "Settled",
"Direction": "In",
"CustomerID": "550e8400-e29b-41d4-a716-446655440000",
"ExternalID": "EXT123456",
"Amount": "12.3",
"Breakdown": [
{
"Amount": "0.1",
"Type": "BusinessFee"
},
{
"Amount": "12.29",
"Type": "Remaining"
}
],
"NetworkFee": "0.0001",
"CryptoCurrency": "BTC",
}
"FiatPayment": {
"Amount": "5000.00",
"FeeAmount": "50.00",
"Rate": "49500.00",
"FiatCurrency": "USD",
"FiatDepositID": "e1583a74-ab77-583a-ad2f-1c47617d514b"
},
"Orchestration": {
"RuleID": "RULE123",
"RuleExecutionID": "EXEC123"
},
"EventType": "Transaction",
"EventVersion": 1730205262722,
"Occurred": "2024-10-29T12:34:23Z",
"UserID": "ory|jfu84hr7-2228-4j2c-fu0e-fu555bre38p9"
}