Events

Learn about the various event types.

Events

Persons

person.created

{
  "id" : "e13b9e14-c062-42ea-8563-8fc9223b29b5",
  "firstName" : "John",
  "lastName" : "Doe",
  "email": "[email protected]",
  "personType" : "CONTRACTOR",
  "contractorType" : "individual",
  "phoneNumber" : {
   "countryCode" : "1",
   "number" : "6756278192"
   },
  "tenantKey" : "abc123",
  "timestamp" : 1681007225
}

person.updated

{
  "id" : "e13b9e14-c062-42ea-8563-8fc9223b29b5",
  "firstName" : "John",
  "lastName" : "Doe",
  "email": "[email protected]",
  "phoneNumber" : {
   "countryCode" : "1",
   "number" : "6756278192"
   },
  "tenantKey" : "abc123",
  "timestamp" : 1681007225
}

Users

user.profile.updated

First Time Password Setup

{
  "id" : "e13b9e14-c062-42ea-8563-8fc9223b29b5",
  "type" : "password_set",
  "tenantKey" : "abc123",
  "timestamp" : 1681007225
}

user.created

{
  "id" : "e13b9e14-c062-42ea-8563-8fc9223b29b5",
  "firstName" : "John",
  "lastName" : "Doe",
  "email": "[email protected]",
  "personId" : "e13b9e14-c062-42ea-8563-8fc9223b29b5",
  "phoneNumber" : {
   "countryCode" : "1",
   "number" : "6756278192"
   },
  "tenantKey" : "abc123",
  "timestamp" : 1681007225
}

user.kyc.updated

{
  "userId" : "e13b9e14-c062-42ea-8563-8fc9223b29b5",
  "type" : "identity",
  "status" : "approved",
  "tenantKey" : "abc123",
  "timestamp" : 1681007225
}
StatusMeaning
in progressUser has initiated the kyc process
document providedUser has provided documentation
approvedKYC has been approved
rejectedKYC has been rejected
TypeMeaning
identityUser basic ID KYC
addressUser address KYC

Payroll

Below are the payroll statuses to expect:

StatusMeaning
savedPayroll is saved.
approvedPayroll has been approved. Waiting to be scheduled. Payroll is scheduled once funds are successfully collected.
scheduledFunds have been collected and payroll scheduled for the specified payroll date.
processingPayroll is under process.
completedPayroll processing has completed.

payroll.created

{
  "id" : "e13b9e14-c062-42ea-8563-8fc9223b29b5",
  "workerType" : "CONTRACTOR",
  "type" : "ONE_OFF",
  "tenantKey" : "abc123",
  "timestamp" : 1681007225
}

payroll.status.updated

{
  "id" : "e13b9e14-c062-42ea-8563-8fc9223b29b5",
  "status" : "Saved",
  "tenantKey" : "abc123",
  "timestamp" : 1681007225
}

Transactions

Every transaction processed through the platform emits events for each stage of the transaction.

StateMeaning
initiatedTransaction has been successfully created for processing.
processingTransaction is now in transit.
succeededTransaction has been successfully deposited to the beneficiary.
failedTransaction has failed.
returnedTransaction that was previously successful has been returned by the recipient bank.

transaction.initiated

Transaction has been successfully created for processing. Any preliminary compliance checks are done at this point.

{
  "id" : "e13b9e14-c062-42ea-8563-8fc9223b29b5",
  "amount" : {
   "currency" : "USD",
   "amount" : 100000
  },
  "type" : "PAYOUT",
  "reference" : "9af0f05e-1efa-407b-be23-8595f89a1b2a",
  "recipientId" : "9bd99534-8c7f-4b2a-b63d-083e33ca205e",
  "tenantKey" : "abc123",
  "timestamp" : 1681007225
}

transaction.processing

Transaction is now in transit (it is being processed by our payment processors).

{
  "id" : "e13b9e14-c062-42ea-8563-8fc9223b29b5",
  "amount" : {
   "currency" : "USD",
   "amount" : 100000
  },
  "type" : "PAYOUT",
  "reference" : "9af0f05e-1efa-407b-be23-8595f89a1b2a",
  "recipientId" : "9bd99534-8c7f-4b2a-b63d-083e33ca205e",
  "tenantKey" : "abc123",
  "timestamp" : 1681007225
}

transaction.succeeded

Transaction has been successfully deposited to the beneficiary.

{
  "id" : "e13b9e14-c062-42ea-8563-8fc9223b29b5",
  "amount" : {
   "currency" : "USD",
   "amount" : 100000
  },
  "type" : "PAYROLL",
  "reference" : "9af0f05e-1efa-407b-be23-8595f89a1b2a",
  "recipientId" : "9bd99534-8c7f-4b2a-b63d-083e33ca205e",
  "tenantKey" : "abc123",
  "timestamp" : 1681007225
}

transaction.failed

Transaction has failed, see message field for more info.

{
  "id" : "e13b9e14-c062-42ea-8563-8fc9223b29b5",
  "message": "Account inactive",
  "amount" : {
   "currency" : "USD",
   "amount" : 100000
  },
  "type" : "PAYOUT",
  "reference" : "9af0f05e-1efa-407b-be23-8595f89a1b2a",
  "recipientId" : "9bd99534-8c7f-4b2a-b63d-083e33ca205e",
  "tenantKey" : "abc123",
  "timestamp" : 1681007225
}

transaction.returned

Transaction that was previously successful has been returned by the recipient bank. See message field for more info.

{
  "id" : "e13b9e14-c062-42ea-8563-8fc9223b29b5",
  "message": "Account closed",
  "amount" : {
   "currency" : "USD",
   "amount" : 100000
  },
  "type" : "PAYOUT",
  "reference" : "9af0f05e-1efa-407b-be23-8595f89a1b2a",
  "recipientId" : "9bd99534-8c7f-4b2a-b63d-083e33ca205e",
  "tenantKey" : "abc123",
  "timestamp" : 1681007225
}

Notes:

  • The reference for PAYROLL transfers is the payrollId. For PAYOUT transfers it is the idempotency key passed during payout creation.
  • The recipientId is the userId for Cadana wallet payments and beneficiaryId for payments made directly to a person's bank account.

Instant Pay

instant-pay.succeeded

{
  "id" : "e13b9e14-c062-42ea-8563-8fc9223b29b5",
  "personId" : "e13b9e14-c062-42ea-8563-8fc9223b29b5",
  "amount" : {
   "currency" : "USD",
   "amount" : 100000
  },
 "tenantKey" : "abc123",
 "timestamp" : 1681007225
}

Contracts

contract.created

{
  "id" : "e13b9e14-c062-42ea-8563-8fc9223b29b5",
  "personId" : "ee278b2d-cbd8-4104-8af4-f02a41566894",
  "templateId" : "4f8220e5-f6b5-43cb-963e-e99219ed1736",
  "tenantKey" : "abc123",
  "timestamp" : 1681007225
}

contract.signed

{
 "id" : "e13b9e14-c062-42ea-8563-8fc9223b29b5",
 "signatureId" : "2dee5427-c648-4696-89cc-95e4d942cd24",
 "name" : "Evil Mario",
 "email" : "[email protected]",
 "isComplete" : false,
 "tenantKey" : "abc123",
 "timestamp" : 1681007225
}

contract.status.updated

{
  "id" : "e13b9e14-c062-42ea-8563-8fc9223b29b5",
  "status" : "revoked",
  "tenantKey" : "abc123",
  "timestamp" : 1681007225
}