Payload Events & Structure

Event Types

The following event types are supported by our webhooks:

public enum PaymentUpdateEventType
{
    Update = 0
}

New events types will be supported in the future (e.g. Create)

Payment Statuses

Payments can have the following statuses:

public enum PaymentStatus
{
    Created = 0,
    Processing = 1,
    Completed = 2,
    Underpaid = 3,
    Overpaid = 4,
    FullyRefunded = 5,
    PartiallyRefunded = 6,
    Expired = 7,
    Invalid = 8,
    Cancelled = 9
}

Also available here: Payment Statuses enum

Events Structure

Webhook 'Update' payloads have the following structure:

{
  "eventType": 0,
  "trackingId": "c10b29e3c8104e0f8dc139c20d9eeb6c",
  "paymentCode": "x0y0z00000",
  "statusCode": 2,
  "amounts": {
    "requested": {
      "inPaymentCurrency": {
        "amount": 0.00000347,
        "currency": {
          "id": 1002,
          "code": "BTC",
          "name": "Bitcoin Lightning"
        }
      },
      "inRequestedCurrency": {
        "amount": 0.1,
        "currency": {
          "id": 1,
          "code": "USD",
          "name": "United States Dollar",
          "symbol": "$"
        }
      }
    },
    "paid": {
      "inPaymentCurrency": {
        "amount": 0.00000347,
        "currency": {
          "id": 1002,
          "code": "BTC",
          "name": "Bitcoin Lightning"
        }
      }
    }
  },
  "reference": "abc123",
  "description": "",
  "terminalId": "000000000000000000000000",
  "merchantId": "000000000000000000000000"
}