/
Balance transaction settl...

Balance transaction settled
Webhook

Request

Security
SecretApiKey or JWT
Bodyapplication/json

Payload of invoice revenue recognition-related webhook event.

recognitionIdstring

ID of the recognized revenue.

invoiceIdstring, <= 50 characters

ID of the invoice.

Example:"in_0YVF9605RKC62BP14NE2R7V2XT"
itemIdstring

ID of the invoice item.

amountnumber, (double)

Amount recognized.

currencystring, = 3 characters(CurrencyCode)

Currency code in ISO 4217 format.

Example:"USD"
eventTypestring

Type of event that triggered the webhook.

Value:"invoice-revenue-recognized"
_embeddedobject

Embedded objects related to the invoice revenue recognition event.

Payload
{
  "recognitionId": "string",
  "invoiceId": "in_0YVF9605RKC62BP14NE2R7V2XT",
  "itemId": "string",
  "amount": 0.1,
  "currency": "USD",
  "eventType": "invoice-revenue-recognized",
  "_embedded": {
    "invoice": { … }
  },
  "_links": [
    { … }
  ]
}

Responses

Returns any 2xx status to indicate that data is received.