Image
abstract swish line in gradient colouring from pink to blue on a dark blue background

Event stream documentation

BankAccountCreated, BankAccountChanged and BankAccountDeleted events

The payload for these events contains an array of bank accounts related to a person.

A BankAccountCreated event will be raised when:

  • a person adds a new bank account

A BankAccountChanged event will be raised when:

  • the person updates an existing bank account

A BankAccountDeleted event will be raised when:

  • the person deletes an existing bank account

Field definitions for this event;

Field NameData TypeAdditional information
personIdguidn/a
personalReferencestringmax-length: 20
abaNumberstring 
accountHolderNamestring 
accountNumberstring 
accountTypeCodestring 
bankAccountCountryCodestring 
bankAddressstring 
bankNamestring 
bicstring 
branchNamestring 
clabeNumberstring 
ibanstring 
isPrimaryboolean 
percentageSplitint 
rollNumberstring 
routingCodestring 
sortCodestring 


Example of this event

{
  "personId": "",
  "personalReference": "",
  "abaNumber": "",
  "accountHolderName": "",
  "accountNumber": "",
  "accountTypeCode": "",
  "bankAccountCountryCode": "",
  "bankAddress": "",
  "bankName": "",
  "bic": "",
  "branchName": "",
  "clabeNumber": "",
  "iban": "",
  "isPrimary": "",
  "percentageSplit": "",
  "rollNumber": "",
  "routingCode": "",
  "sortCode": ""
}

Looking for something specific?