payment-status-changed

This event is triggered whenever a payment has its status changed

Payload (object)

• id (string) - The payment id

• referenceId (string)
  The external reference with your own system, this should be an identifier to reference this payee on your system

• ledgerAccount (string) - the id for the ledger account used to fund this payment

• payeeMemo (string) - Message included in the payment line for this payment

• payorMemo (string) - Message to be displayed to you on this payment

• submitted (boolean) - If this payment has been submitted for processing

• completed (boolean) -If this payment has been completed (paid)

• sourceAmount (object) - The amount to be paid

  • 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) - The amount to be paid in the destination currency

  • 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

• refundAmount (object) - The amount refunded for this payment, only applicable if this payment has been returned

  • 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

• paymentCategory (string) - Payment category to be used for this payment

• taxJurisdiction (string) - Tax rules to apply to this payment

• chargedServiceFee (object) - The total amount of service fee charged for this payment

  • 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

• refundedServiceFee (object) - The total amount of service fee refunded for this payment

  • 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

• cancellationReason (string) - The reason given for the cancellation of this payment (if applicable)

• status (object) - This payment status

  • DRAFT
  • SUBMITTED
  • PROCESSING
  • COMPLETED
  • RETURNED
  • FAILED
  • CANCELLED
  • WAITING_COMPLIANCE

• payee (object) - The payee information

  • userId (string) - The user id for the payee
  • payorId (string) - This is your own payor id
  • referenceId (string)
    The external reference for the payor this should be an identifier to reference this payee on your system
  • "email (string) - The payee's email
  • payable (boolean) - Flag whether the payee is payable

• auditInfo (object) - Information about this record

  • submittedAt (Date) - The date and time this payment was submitted
  • estimateDeliveryAt (Date) - The date and time this payment is expected to be completed
  • createdBy (string) - User who created this record
  • updatedBy (string) - User who updated this record
  • updatedAt (Date) - Last update date
  • createdAt (Date) - Date of creation

• virtualPayment (boolean) - A payment that is used to calculate fees and withholdings.

{
  id: 'string',
  referenceId: 'string',
  ledgerAccount: 'string',
  payeeMemo: 'string',
  payorMemo: 'string',
  submitted: boolean,
  completed: boolean,
  sourceAmount: {
    value: number,
    currency: 'string',
    formattedValue: 'string',
    digits: number,
    wholeValue: number,
  },
  destinationAmount: {
    value: number,
    currency: 'string',
    formattedValue: 'string',
    digits: number,
    wholeValue: number,
  },
  refundAmount: {
    value: number,
    currency: 'string',
    formattedValue: 'string',
    digits: number,
    wholeValue: number,
  },
  paymentCategory: 'string',
  taxJurisdiction: 'string',
  chargedServiceFee: {
    value: number,
    currency: 'string',
    formattedValue: 'string',
    digits: number,
    wholeValue: number,
  },
  refundedServiceFee: {
    value: number,
    currency: 'string',
    formattedValue: 'string',
    digits: number,
    wholeValue: number,
  },
  cancellationReason: 'string',
  status: [
    'DRAFT',
    'SUBMITTED',
    'PROCESSING',
    'COMPLETED',
    'RETURNED',
    'FAILED',
    'CANCELLED',
    'WAITING_COMPLIANCE'
  ],
  payee: {
    userId: 'string',
    payorId: 'string',
    referenceId: 'string',
    email: 'string',
    payable: boolean,
  },
  auditInfo: {
    submittedAt: Date,
    estimateDeliveryAt: Date,
    createdBy: 'string',
    updatedBy: 'string',
    updatedAt: Date,
    createdAt: Date,
  },
  virtualPayment: boolean,
}