Default Notifications

Here you'll find a breakdown of notification kinds. All of them take inputs in order to prefill data in every template.

Overview

Our notifications are a set of HTML templates using handlebars in order to make them reusable and easy to scale. Inputs are different for each notification kind, on which we include your theme configuration if you're using our white labelled UI.

The list

Payroll Submitted

When you pass through submitting your payrolls, if your setup requires multiple reviews, your admins will be notified through this email in order to collect approvals before paying your employees.

Here's a preview of the payload and the actual email:

{
  "amountCurrency": "GHS",
  "isWhiteLabelled": false,
  "link": "a link",
  "numPeople": 2,
  "payrollDate": "2021-07-28",
  "payrollType": "employee",
  "personName": "John",
  "requesterName": "Lorem",
  "totAmount": "2000",
  "platformSettings": {
    "emailSettings": {
      "fromEmail": "[email protected]",
    },
    "theme": {
      "colors": {
        "foreground": "#344054",
        "primary": "#E75423",
        "secondary": "#E75423"
      },
      "logoUrl": "https://cadanapay.com/images/cadana-logo-primary.png",
      "typography": {
        "common": {
          "fontFamily": "Albert Sans"
        },
        "titles": {
          "fontFamily": "Albert Sans"
        }
      }
    }
  }
}

Paystub Generated

We’ll notify you when you pay your employees and we generate a paystub for them. Employees can see their paystubs from their dashboards.

Here's a preview of the payload and the actual email:

{
  "androidLink": "a link",
  "iPhoneLink": "a link",
  "mobileLink": "a link",
  "paystubId": "d88f6a4e-07f1-4e18-80c6-ea8eaf78c7c9",
  "personName": "John",
  "webLink": "a link",
  "platformSettings": {
    "emailSettings": {
      "fromEmail": "[email protected]",
    },
    "theme": {
      "colors": {
        "foreground": "#344054",
        "primary": "#E75423",
        "secondary": "#E75423"
      },
      "logoUrl": "https://cadanapay.com/images/cadana-logo-primary.png",
      "typography": {
        "common": {
          "fontFamily": "Albert Sans"
        },
        "titles": {
          "fontFamily": "Albert Sans"
        }
      }
    }
  }
}

Instant Pay Completed

We’ll notify you when you have to get some cash advance from your salary. Once it is through to your account, or processes in our end are completed for your bank or account to receive it, this notification is sent to your email.

Here's a preview of the payload and the actual email:

{
  "emailVerb": "completed",
  "feeAmount": "5.00",
  "paymentChannel": "mobile wallet",
  "paymentDestination": "VOD",
  "paymentDestinationForSms": "mobile wallet",
  "personName": "Abra Meyer",
  "streamAmount": "505.00",
  "streamCurrency": "GHS",
  "streamID": "f79f0581-ddfa-404d-955c-fff9bf4a3e23",
  "subjectVerb": "Received",
  "textCopyOne": "have received",
  "transferAmount": "500.00",
  "txtVerb": "sent",
  "platformSettings": {
    "emailSettings": {
      "fromEmail": "[email protected]",
    },
    "theme": {
      "colors": {
        "foreground": "#344054",
        "primary": "#E75423",
        "secondary": "#E75423"
      },
      "logoUrl": "https://cadanapay.com/images/cadana-logo-primary.png",
      "typography": {
        "common": {
          "fontFamily": "Albert Sans"
        },
        "titles": {
          "fontFamily": "Albert Sans"
        }
      }
    }
  }
}

Employee Offboarding Scheduled

We also cover offboardings made by employers. In that case we'll notify your employee when is his/her offboarding scheduled, also letting them know that they can still access to their pay stub information through their employee dashboard.

Here's a preview of the payload and the actual email:

{
  "exitDate": "2021-04-30",
  "payrollType": "one off payroll",
  "personName": "Angela Adjei",
  "reason": "quit",
  "platformSettings": {
    "emailSettings": {
      "fromEmail": "[email protected]",
    },
    "theme": {
      "colors": {
        "foreground": "#344054",
        "primary": "#E75423",
        "secondary": "#E75423"
      },
      "logoUrl": "https://cadanapay.com/images/cadana-logo-primary.png",
      "typography": {
        "common": {
          "fontFamily": "Albert Sans"
        },
        "titles": {
          "fontFamily": "Albert Sans"
        }
      }
    }
  }
}

Transaction Drafted

When you add funds to your account via a channel that takes time to settle e.g ACH, the user will get this notification informing them of the pending transfer.

Here's a preview of the payload and the actual email:

{
  "textOne": "in 1 business day",
  "amountValue": "100",
  "amountCurrency": "USD",
  "personName": "John",
  "platformSettings": {
    "emailSettings": {
      "fromEmail": "[email protected]"
    },
    "theme": {
      "colors": {
        "foreground": "#344054",
        "primary": "#E75423",
        "secondary": "#E75423"
      },
      "logoUrl": "https://cadanapay.com/images/cadana-logo-primary.png",
      "typography": {
        "common": {
          "fontFamily": "Albert Sans"
        },
        "titles": {
          "fontFamily": "Albert Sans"
        }
      }
    }
  }
}

Transaction Initiated

Whenever a user initiates a payout, the following email is sent informing the user about the payout action.

Here's a preview of the payload and the actual email:

{
  "accountName": "CDF",
  "amount": "50.00",
  "code": "ORANGE",
  "currency": "USD",
  "estimatedArrival": "Within minutes",
  "isCard": false,
  "isCrypto": false,
  "isSwift": false,
  "method": "momo",
  "personName": "Lorem",
  "platformSettings": {
    "emailSettings": {
      "fromEmail": "[email protected]"
    },
    "theme": {
      "colors": {
        "foreground": "#344054",
        "primary": "#E75423",
        "secondary": "#E75423"
      },
      "logoUrl": "https://cadanapay.com/images/cadana-logo-primary.png",
      "typography": {
        "common": {
          "fontFamily": "Albert Sans"
        },
        "titles": {
          "fontFamily": "Albert Sans"
        }
      }
    }
  }
}

Transaction Failed

If a transaction fails for any reason, the following notification is triggered containing the reason for the failure among other details.

Here's a preview of the payload and the actual email:

{
  "accountName": "Peter Obi",
  "amount": "3000.00",
  "currency": "USD",
  "method": "bank",
  "reason": "Transaction failed because you put in invalid details",
  "personName": "Lorem",
  "platformSettings": {
    "emailSettings": {
      "fromEmail": "[email protected]"
    },
    "theme": {
      "colors": {
        "foreground": "#344054",
        "primary": "#E75423",
        "secondary": "#E75423"
      },
      "logoUrl": "https://cadanapay.com/images/cadana-logo-primary.png",
      "typography": {
        "common": {
          "fontFamily": "Albert Sans"
        },
        "titles": {
          "fontFamily": "Albert Sans"
        }
      }
    }
  }
}

Card Created

Through our application you can request your own virtual card, we'll let you know once it is approved and ready for use.

Here's a preview of the payload and the actual email:

{
  "personName": "Rene",
  "platformSettings":{
    "emailSettings":{
      "fromEmail":"[email protected]"
    },
    "theme":{
      "colors":{
        "foreground":"#344054",
        "primary":"#E75423",
        "secondary":"#E75423"
      },
      "logoUrl":"https://cadanapay.com/images/cadana-logo-primary.png",
      "typography":{
        "common":{
          "fontFamily":"Albert Sans"
        },
        "titles":{
          "fontFamily":"Albert Sans"
        }
      }
    }
  }
}

Card Transaction Succeeded

While using our virtual cards you'll be notified about your successful transactions through your email with the following format.

Here's a preview of the payload and the actual email:

{
  "amount":"15.08",
  "currency":"USD",
  "description":"ARAMEX INTERNATIONAL    045246715      AE",
  "merchantCity":null,
  "merchantLogo":"https://logos.ntropy.com/aramex.com",
  "merchantName":"Aramex",
  "merchantWebsite":"aramex.com",
  "personName":"Lorem",
  "transactionCategory":"Other transport",
  "platformSettings":{
    "emailSettings":{
      "fromEmail":"[email protected]"
    },
    "theme":{
      "colors":{
        "foreground":"#344054",
        "primary":"#E75423",
        "secondary":"#E75423"
      },
      "logoUrl":"https://cadanapay.com/images/cadana-logo-primary.png",
      "typography":{
        "common":{
          "fontFamily":"Albert Sans"
        },
        "titles":{
          "fontFamily":"Albert Sans"
        }
      }
    }
  }
}

Card Transaction Failed

While using our virtual cards you'll be notified about your failed transactions through your email with the following format.

Here's a preview of the payload and the actual email:

{
  "amount": "360.00",
  "currency": "USD",
  "personName": "Briget Mendoza",
  "reason": "Insufficient balance to pay the merchant charge and transaction fee for this transaction, please top up your card and try again.",
  "platformSettings":{
    "emailSettings":{
      "fromEmail":"[email protected]"
    },
    "theme":{
      "colors":{
        "foreground":"#344054",
        "primary":"#E75423",
        "secondary":"#E75423"
      },
      "logoUrl":"https://cadanapay.com/images/cadana-logo-primary.png",
      "typography":{
        "common":{
          "fontFamily":"Albert Sans"
        },
        "titles":{
          "fontFamily":"Albert Sans"
        }
      }
    }
  }
}

Updated 9 months ago