ledger-account-credited

This event is triggered whenever money is credited to one of your ledger accounts, for example when you fund the account or when a payment is refunded back into it.

Credits to internal ledger accounts do not produce a webhook.

Payload (object)

  • ledgerAccountId (string) - The id of the ledger account that was credited

  • amountCredited (object) - The amount added to the account by this credit

    • value (number) - The amount in float point
    • currency (string) - 3 letters ISO code for currency
    • formattedValue (string) - The formatted value, e.g: $10.00
    • digits (number) - The amount of decimal places this currency has
    • wholeValue (number)
      An integer value for the least significant value for this currency, eg.: $10.00 would be 1000. It can be thought as how many cents for this operation
  • ledgerBalance (object) - The balance of the ledger account

    • value (number) - The amount in float point
    • currency (string) - 3 letters ISO code for currency
    • formattedValue (string) - The formatted value, e.g: $10.00
    • digits (number) - The amount of decimal places this currency has
    • wholeValue (number)
      An integer value for the least significant value for this currency, eg.: $10.00 would be 1000. It can be thought as how many cents for this operation

{
  ledgerAccountId: 'string',
  amountCredited: {
    value: number,
    currency: 'string',
    formattedValue: 'string',
    digits: number,
    wholeValue: number,
  },
  ledgerBalance: {
    value: number,
    currency: 'string',
    formattedValue: 'string',
    digits: number,
    wholeValue: number,
  },
}