API Overview

Welcome to the Payment Evolution API documentation. This guide provides comprehensive information on integrating with Payment Evolution’s services to enable seamless payment processing and management within your applications.

Employee API 

 Overview  

The Payment Evolution Employee API allows partners to add, get and update employees within their group of companies 

Employee Elements 

Payrun Elements

Employee Loan API  

Authentication Header  

The Payment Evolution REST API uses a standard HTTP authorization header to pass authorization information. The Authorization header has the following form:

Authorization: PE signature = <issued signature token>

 The Issued signature token can be retrieved and regenerated through the payroll application. Within the Add-ons section, click the API tab (contact support if unavailable), and enable/generate a token.  

 Overview: 

The Payment Evolution “Employee Loan API” issues employee loans and helps check loan status.  

 Root element <EmployeeLoan>  

Sample Code:   

<?xml version="1.0" encoding="utf-8"?>  

<EmployeeLoan>  

<Amount>69.75</Amount>  

<ProcessDate>15/12/2011</ProcessDate>  

<Tag>0000123001</Tag>  

<Token>45j1Sqw/8nTpL0ZJ8gCZOOut+rHZG4ia5zQekOpCXmo=</Token>   

</EmployeeLoan>

Employee Deduction API 

Overview: 

The Payment Evolution “Employee Deduction API” allows you to retrieve latest details on specific deduction, add new deduction and update the advance deduction 

 Elements for Employee Deductions and Description 

Sample POST  

<EmployeeDeductions>  

        <Amount>77.89</Amount>  

        <AmountUnit>A</AmountUnit>  

        <EffectiveDate>2019-01-04T00:00:00</EffectiveDate>  

        <Frequency>R</Frequency>  

        <Goal>130.00</Goal>  

        <Name>Custom Deduction A</Name>  

</EmployeeDeductions>

Sample Response   

<EmployeeDeductions>  

        <Amount>77.89</Amount>  

        <AmountUnit>A</AmountUnit>  

        <Balance>0.00</Balance>  

        <DateCreated>2019-01-04T01:14:29</DateCreated>  

        <DateModified>2019-01-04T01:26:59</DateModified>  

        <DeductionID>000004A05</DeductionID>  

        <DeductionType>A</DeductionType>  

        <EffectiveDate>2019-01-04T00:00:00</EffectiveDate>  

        <EmployeeNumber>000004</EmployeeNumber>  

        <EndDate>2099-12-31T00:00:00</EndDate>  

        <Frequency>O</Frequency>  

        <Goal>130.00</Goal>  

        <MaxAmount>0.00</MaxAmount>  

        <MinAmount>0.00</MinAmount>  

        <Name>Custom Deduction 2</Name>  

     </EmployeeDeductions>

PayCalc API  

Authentication Header 

The Payment Evolution REST API uses standard HTTP authorization header to pass authorization information. The Authorization header has the following form:  

Authorization: PE signature = <issued signature token>

The Issued signature token can be retrieved and regenerated through the payroll application. Within the Add-ons section, click the API tab (contact support if unavailable), and enable/generate a token.  

Overview  

The PaymentEvolution payCalc API calculates Canadian payroll deductions. These are typically referred to as “gross to net” calculations based on a series of inputs.  

 Sample POST  

{  

 "TD1ProvincialClaim":null,  

 "TD1FederalClaim":21111,  

 "CppExempt": false,  

 "EiExempt": false,  

 "PayPeriodEndDate": "05/15/2017",  

 "PayPeriodPerYear": "52",  

 "PayRate": "100",  

 "PayRateUnit": "H",  

 "Province": "6",  

 "StandardHours": "35",  

 "TaxExempt": false,  

 "netPay": false,  

 "Type": "Salary",  

 "CountryCode": "CAN",  

 "NR301": false,  

}

  Sample Response  

{  

    "Earnings": {  

        "GrossSalary": 3500,  

        "AdditionalEarnings": 0,  

        "TotalTaxableIncome": 3500,  

        "NetAmount": 2107.86  

    },  

    "Deductions": {  

        "FederalTaxDeductions": 713.07,  

        "ProvincialTaxDeductions": 452.1,  

        "CppDeductions": 169.92,  

        "EiDeductions": 57.05,  

        "TotalDeductions": -1392.14  

    },  

    "Remittance": {  

        "RemitCPPEmployee": 169.92,  

        "RemitCPPContribution": 169.92,  

        "RemitTotalCPP": 339.84,  

        "RemitEIEmployee": 57.05,  

        "RemitEIContribution": 79.87,  

        "RemitTotalEI": 136.92,  

        "TotalEmployeeTax": 1165.17,  

        "TotalRemittance": 1641.93  

    },  

    "TaxCredits": {  

        "FederalTD1": 21111,  

        "ProvincialTD1": 10171  

    }  

}

  Code samples  

curl -X POST \  

  https://moja-calc.paymentevolution.com/api/v2/calculate \  

  -H 'accept: application/json' \  

  -H 'authorization: PE signature=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \  

  -H 'cache-control: no-cache' \  

  -H 'content-type: application/json' \  

  -d '{  

 "TD1ProvincialClaim":null,  

 "TD1FederalClaim":21111,  

 "CppExempt": false,  

 "EiExempt": false,  

 "PayPeriodEndDate": "05/15/2017",  

 "PayPeriodPerYear": "52",  

 "PayRate": "100",  

 "PayRateUnit": "H",  

 "Province": "6",  

 "StandardHours": "35",  

 "TaxExempt": false,  

 "netPay": false,  

 "Type": "Salary",  

 "CountryCode": "CAN",  

 "NR301": false,  

}'

ePay Transactions API:

Overview: The Payment Evolution “ePay Transactions API” can be used to get an existing ePay Transaction  

Root element <ePay>. Each <Transaction> within <ePay>  

Elements for Transaction Items  
The total of all <Credit>, <Amount> must equal/match the <Amount> from the <Debit> transaction  

 Elements for <PaymentMethod type=”B”>, BankType Items   

Sample code:   

<?xml version="1.0" encoding="utf-8"?>  

<ePay>  

  <Transaction>  

    <Debit type="D">  

      <PaymentMethod type="B">  

        <AccountNumber>3333-303</AccountNumber>  

        <TransitNumber>09688</TransitNumber>  

        <InstitutionNumber>006</InstitutionNumber>  

      </PaymentMethod>  

      <Name>Your Company</Name>  

      <ProcessDate>15/12/2011</ProcessDate>  

      <PaymentType>B</PaymentType>  

      <Amount>69.75</Amount>  

      <Status>N</Status>  

    </Debit>  

    <Credit type="C">  

      <PaymentMethod type="B">  

        <AccountNumber>4445-44</AccountNumber>  

        <TransitNumber>4684</TransitNumber>  

        <InstitutionNumber>002</InstitutionNumber>  

      </PaymentMethod>  

      <Name>Payees Store #630</Name>  

      <UniqueID>UniqueIDPayee</UniqueID>  

      <GroupID>PayeesRestaurants</GroupID>  

      <PaymentType>B</PaymentType>  

      <Amount>25</Amount>  

      <Status>N</Status>  

    </Credit>  

    <Credit type="C">  

      <PaymentMethod type="B">  

        <AccountNumber>5555-5501</AccountNumber>  

        <TransitNumber>04686</TransitNumber>  

        <InstitutionNumber>004</InstitutionNumber>  

      </PaymentMethod>  

      <Name>Payees Store #444</Name>  

      <UniqueID>UniqueIDPayee444</UniqueID>  

      <GroupID>PayeesRestaurants</GroupID>  

      <PaymentType>B</PaymentType>  

      <Amount>44.75</Amount>  

      <Status>N</Status>  

    </Credit>  

  </Transaction>  

</ePay>

 ePay Transactions Update API

 Overview: The Payment Evolution “ePay Transactions Update API” can be used to update an existing ePay Transaction  

 Root element <ePay>. Each <Transaction process=”Update”> within <ePay>  

Elements for Transaction Update Items    

 Elements for <PaymentMethod type=”B”>, BankType Items  

 Sample Code:   

<?xml version="1.0" encoding="utf-8"?>  

<ePay>  

  <Transaction process=”Update”>  

    <Credit type="C">  

      <TransactionID>CPAYEE33012033</TransactionID>    

      <PaymentMethod type="B">  

        <AccountNumber>3333-303</AccountNumber>  

        <TransitNumber>09688</TransitNumber>  

        <InstitutionNumber>006</InstitutionNumber>  

      </PaymentMethod>  

      <ProcessDate>31/12/2011</ProcessDate>  

    </Credit>  

    <Credit type="C">  

      <TransactionID>CPA2DE33012033</TransactionID>    

      <ProcessDate>01/01/2012</ProcessDate>  

    </Credit>  

  </Transaction>  

</ePay>

Company API

Overview  

The PaymentEvolution Company API allows partners to add, get and update companies within their group of companies  

 Sample POST  

<Company>  

        <AddressLine1>test workplace4 st</AddressLine1>  

        <AddressLine2></AddressLine2>  

        <City>toronto</City>  

        <Company>Workplace7</Company>  

        <Country>Canada</Country>  

        <Email>workplace9@we.local</Email>  

        <FirstName>test</FirstName>  

        <LastName>test</LastName>  

        <PayrollAccount></PayrollAccount>  

        <PostalCode>L4W5A8</PostalCode>  

        <Province>ONTARIO</Province>  

        <TelephoneAreaCode>416</TelephoneAreaCode>         <TelephoneNumber>5556789</TelephoneNumber>  

    </Company>

Sample Response  

Company Model with <CompanyID> for future queries  

HolidayCalc API

The PaymentEvolution REST API uses standard HTTP authorization header to pass authorization information. The Authorization header has the following form:  

Authorization: PE signature= <issued signature token> 

Overview:

The PaymentEvolution HolidayCalc API calculates statutory holiday pay. 

* Note: All elements are required. An empty string or 0 is sufficient. 

Sample Code:

{ 

"Province":"AB", 

"StatHoliday":"Mon Jan 02 2023", 

"StatHolidayName":"New Year's Day", 

"RegularWages":"3473.93", 

"EarnSame":"", 

"VacPay":"0", 

"HoursWorked":"7", 

"HourlyRate":"15", 

"Commissions":"", 

"Incentive":"0", 

"HoursPayPeriod":"0", 

"HowManyDays":"20", 

"NormalHours":"0", 

"WagesCD":"0", 

"HoursVary":"", 

"Daytoday":"", 

"TimeBasis":"", 

"Applicable":"" 

} 

Timesheet API

Overview:  

The Payment Evolution “ePay Transactions Update API” can be used to update an existing ePay Transaction  

Elements for Timesheet  

 Posting Multiple Timesheets  

 Sample Post  

<Timesheets>   

    <Timesheet>  

        <Authorized>true</Authorized>  

        <CostAccount>9060</CostAccount>  

        <EmployeeID>000001</EmployeeID>  

        <Rate>3333.00</Rate>  

        <TimeCode>R</TimeCode>  

        <TimeRecordKey>00000100000004</TimeRecordKey>  

        <Total>6462687.00</Total>  

        <TotalHours>1939</TotalHours>  

        <WorkDateBegin>2014-06-05T07:30:00</WorkDateBegin>  

        <WorkDateEnd>2014-06-30T14:52:00</WorkDateEnd>  

    </Timesheet>  

    <Timesheet>  

        <Authorized>true</Authorized>  

        <CostAccount>9060</CostAccount>  

        <EmployeeID>000001</EmployeeID>  

        <Rate>3333.00</Rate>  

        <TimeCode>R</TimeCode>  

        <TimeRecordKey>00000100000005</TimeRecordKey>  

        <Total>6462687.00</Total>  

        <TotalHours>1939</TotalHours>  

        <WorkDateBegin>2014-09-05T07:30:00</WorkDateBegin>  

        <WorkDateEnd>2014-09-30T14:52:00</WorkDateEnd>  

    </Timesheet>  

</Timesheets>

Service Status API  

Overview

The Service Status API can be used to get the overall status of a page without all the complexities of components and notices.

Sample Code:
{
    "page": {
        "name": "PaymentEvolution",
        "state": "operational",
        "url": "https://status.paymentevolution.com",
        "links": {
            "components": {
                "href": "/v1/components",
                "count": 50
            },
            "notices": {
                "href": "/v1/notices",
                "count": 100
            },
        },
        "created_at": "2023-01-01T00:00:00.000Z",
        "updated_at": "2023-01-01T00:00:00.000Z"
    }
}

List Components API  

Overview

The List Components API can be used to retrieve a paginated list of components and their status, useful to those who want a more detailed explanation of what’s impacted, or just the status of a subset of components.

Sample Code:

{
    "components": [
        {
            "id": 1,
            "state": "operational",
            "name": "Example Component",
            "description": "This is an example component.",
            "parent_id": null,
            "created_at": "2023-01-01T00:00:00.000Z",
            "updated_at": "2023-01-01T00:00:00.000Z"
        },
        {
            "id": 2,
            "state": "operational",            
            "name": "Sub-Component",
            "description": "This is an example sub-component.",
            "parent_id": 1,
            "created_at": "2023-01-01T00:00:00.000Z",
            "updated_at": "2023-01-01T00:00:00.000Z"
        }
    ],
    "meta": {
        "count": 25,
        "total_count": 50,
        "next_page": "/api/v1/components?page=2"
    }
}

List Notices API

Overview:

This list only contains basic details; for more information, such as the impacted components or the entire progress update history, request detailed notice information.

Retrieve a paginated list of notices for a page, past, present, and future

Elements

Filtering Notices

If you want to search for certain notices, such as planned maintenances, or only current incidents you can do so by passing the “filter” query string parameter.

Only retrieve planned maintenance

Only retrieve current unplanned notices

You can mix and match other “type” and “timeline_state” values in the filter, so you have the flexibility to return just the records you need.

Sample Code:
{
    "notice": {
        "id": 1,
        "type": "unplanned",
        "timeline_state": "present",
        "state": "investigating",
        "subject": "Current Incident",
        "components": [
            {
                "id": 1,
                "state": "operational",
                "name": "Example Component",
                "description": "This is an example component.",
                "parent_id": null,
                "created_at": "2023-01-01T00:00:00.000Z",
                "updated_at": "2023-01-01T00:00:00.000Z"
            }
        ],
        "updates": [
            {
                "state": "investigating",
                "content": "We are currently investigating an issue with our service."
                "created_at": "2023-01-01T00:00:00.000Z",
                "updated_at": "2023-01-01T00:00:00.000Z"
            }
        ],
        "url": "https://status.paymentevolution.com/notices/xxx-current-incident",
        "created_at": "2023-01-01T00:00:00.000Z",
        "updated_at": "2023-01-01T00:00:00.000Z"    
    }
}

Detailed Notice Information API

Overview:

Retrieve the detail for a given notice, including its impacted components and its full list of progress updates.

Sample Code:
{
    "notice": {
        "id": 1,
        "type": "unplanned",
        "timeline_state": "present",
        "state": "investigating",
        "subject": "Current Incident",
        "components": [
            {
                "id": 1,
                "state": "operational",
                "name": "Example Component",
                "description": "This is an example component.",
                "parent_id": null,
                "created_at": "2023-01-01T00:00:00.000Z",
                "updated_at": "2023-01-01T00:00:00.000Z"
            }
        ],
        "updates": [
            {
                "state": "investigating",
                "content": "We are currently investigating an issue with our service."
                "created_at": "2023-01-01T00:00:00.000Z",
                "updated_at": "2023-01-01T00:00:00.000Z"
            }
        ],
        "url": "https://status.paymentevolution.com/notices/xxx-current-incident",
        "created_at": "2023-01-01T00:00:00.000Z",
        "updated_at": "2023-01-01T00:00:00.000Z"    
    }
}

Pagination

Overview:

Collections such as “components” and “notices” only return a maximum of 25 records per request. Larger collections are split into multiple pages and contain a URL to retrieve the next page in the collection.

We also include a count of the records on this page and the total record count across all pages.

Sample Code
{
    "notices": [],
    "meta": {
        "count": 25,
        "total_count": 100,
        "next_page": "/v1/notices?page=2"
    }
}