Invoice Received

Invoice Received
Webhook

Request

Triggered when an invoice is received.

Headers

X-Webhook-Signaturestring(X-Webhook-Signature)required

HMAC-SHA256 signature of the request body using your webhook secret.

Bodyapplication/jsonrequired

event_idstring(Event Id)required

Unique event identifier

timestampstring, (date-time)(Timestamp)required

Event timestamp

sponsor_idstring(Sponsor Id)required

Sponsor ID

event_typestring(Event Type)required

Value:"invoice.received"

dataobject(InvoiceReceivedData)required

Data payload for invoice.received webhook event.

Payload

{
  "event_id": "evt_abc123def456",
  "timestamp": "2019-08-24T14:15:22Z",
  "sponsor_id": "sandbox-1234/5678",
  "event_type": "invoice.received",
  "data": {
    "invoice_id": "42",
    "direction": "INCOMING",
    "original_format": "UBL",
    "sender_id": "0225:884553033",
    "recipient_id": "0225:123456789",
    "client_id": "client_xyz789"
  }
}

Responses

Successful Response

Bodyapplication/json

any

Response

// No response example