API Overview

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> 

Mandatory Elements
<Debit>	See Transaction, Max Number: 1
<Credit>	See Transaction, Min Number: 1, Max number: 100
Return Elements
The following are only returned on request
<TransactionID>	PaymentEvolution generated unique identifier for Credit Transaction
<UniqueID>	Custom Unique ID returned back

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

Mandatory Elements
<Status>	N = New  (fixed )  P = Pending  A = Approved  C = Cleared  R = Returned  F = Finished
<Amount>	Decimal amount  (ex: 22.00), no currency, no symbol
Optional Elements
<PaymentType>	B = B2B  (default)  F = Fees  P = Payroll  C = Commission
<GroupID>	Custom Group ID
<UniqueID>	Custom Client unique ID, for reference
<ProcessDate>	Date of transaction – format dd/MM/yyyy  (eg: 14/12/2011)
<Name>	Descriptive name
<PaymentMethod>	Attribute:  B = Bank  (Fixed), See BankType for elements  W = Wire  M = Manual  E = Email

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

Mandatory Elements
<AccountNumber>	Max 9 Digit Account Number of payee/payor
<TransitNumber>	5 Digit Transit Number belonging to corresponding <InstitutionNumber>
<InstitutionNumber>	3 Digit Institution Number  e.g. http://en.wikipedia.org/wiki/Routing_transit_number#Canadian_transit_number 001: Bank of Montreal 002: Bank of Nova Scotia 003: Royal Bank of Canada 004: Toronto Dominion Bank 006: National Bank of Canada 010 – CIBC 016 – HSBC

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> 

Mandatory Elements
<Credit>	See Transaction, Min Number: 1, Max number: 100
Return Elements
The following are only returned on request
<Status>	Current status of existing transaction
<ProcessDate>	Projected Processing/Credit Date
<Response>	Message if successful or failed

Elements for Transaction Update Items   

Mandatory Elements
<TransactionID>	PaymentEvolution unique Transaction ID (14 characters)
Optional Elements
<PaymentType>	B = B2B (default)  F = Fees  P = Payroll  C = Commission
<GroupID>	Custom Group ID
<UniqueID>	Custom Client unique ID, for reference
<ProcessDate>	Date of transaction – format dd/MM/yyyy  (eg: 14/12/2011)
<Name>	Descriptive name

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

Mandatory Elements
<AccountNumber>	Max 9 Digit Account Number of payee/payor
<TransitNumber>	5 Digit Transit Number belonging to corresponding <InstitutionNumber>
<InstitutionNumber>	3 Digit Institution Number  e.g. http://en.wikipedia.org/wiki/Routing_transit_number#Canadian_transit_number 001: Bank of Montreal 002: Bank of Nova Scotia 003: Royal Bank of Canada 004: Toronto Dominion Bank 006: National Bank of Canada 010 – CIBC 016 – HSBC

 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>