API Reference
PricingSales

payee-payability-changed

This event is triggered whenever a payee has their payability status changed, for example, the payee has filled in their data and became "payable".

Payload (object)

  • userId (string) - The payee's user id

  • payorId (string) - This is your id as payor

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

  • email (string) - The payee email

  • payable (boolean) - Boolean indicating if the payee is payable


{
  userId: 'string',
  payorId: 'string',
  referenceId: 'string',
  email: 'string',
  payable: boolean,
}