This event is triggered whenever a refund transaction is added to your of your ledger accounts.
Payload (object)
- transaction (object)
- id (string) - This transaction id
- status (string) - The status this transaction is at
- sourceAmount (object) - The amount to be paid for this transaction
- value (number) - The amount to be paid 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
- destinationAmount (object)(optional) - The amount of this transaction after fees and exchange rate
- value (number) - The amount to be paid 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
- createdDate (Date)(optional) - Date this transaction was created
- cancelledDate (Date)(optional) - Date this transaction was cancelled, if applicable
- completedDate (Date)(optional) - Date this transaction was completed and the money was transferred to payee
- failedDate (Date)(optional) - Date this transaction has failed, if applicable
- returnedDate (Date)(optional) - Date this transaction was returned
- returnReason (string)(optional) - A description of why this transaction was returned
- refundedAmount (number) - Integer value of the amount refunded
- value (number) - The amount to be paid 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
- returnFees (number) - Integer value of refunded fees
- value (number) - The amount to be paid 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
- withholdingReturnedAmount (number) - Integer value for returned amount of taxes (if applicable)
- value (number) - The amount to be paid 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
{
transaction: {
id: 'string',
status: 'string',
sourceAmount: {
value: number,
currency: 'string',
formattedValue: 'string',
digits: number,
wholeValue: number,
},
destinationAmount: {
value: number,
currency: 'string',
formattedValue: 'string',
digits: number,
wholeValue: number,
},
createdDate: 'string',
cancelledDate: 'string',
completedDate: 'string',
failedDate: 'string',
returnedDate: 'string',
returnReason: 'string',
},
refundedAmount: {
value: number,
currency: 'string',
formattedValue: 'string',
digits: number,
wholeValue: number,
},
returnFees: {
value: number,
currency: 'string',
formattedValue: 'string',
digits: number,
wholeValue: number,
},
withholdingReturnedAmount: {
value: number,
currency: 'string',
formattedValue: 'string',
digits: number,
wholeValue: number,
},
}