iPaymy and Xero Integration v2.1 · [SHORTCODE]&licenceFee=1&key=IPM-CO-90 ... Singapore issued...

13
2018 iPaymy and Xero Integration USER GUIDE V2.1

Transcript of iPaymy and Xero Integration v2.1 · [SHORTCODE]&licenceFee=1&key=IPM-CO-90 ... Singapore issued...

Page 1: iPaymy and Xero Integration v2.1 · [SHORTCODE]&licenceFee=1&key=IPM-CO-90 ... Singapore issued Visa and Mastercard credit cards have a license fee of 2.6% and American Express

2018

iPaymyandXeroIntegrationUSERGUIDEV2.1

Page 2: iPaymy and Xero Integration v2.1 · [SHORTCODE]&licenceFee=1&key=IPM-CO-90 ... Singapore issued Visa and Mastercard credit cards have a license fee of 2.6% and American Express

iPaymyandXeroIntegration

2

WhatistheXerointegrationwithiPaymy?

TheiPaymy-XerointegrationisalinkbetweenyouriPaymyandXeroaccount.TheintegrationallowsyoutoissueaninvoicefromXeroandcollectpaymentsfromyourcustomerviaacreditcardthroughaniPaymylandingpage.ThestatusofthepaymentsistrackedinbothiPaymyandXero.ThroughtheintegrationyouhavetheoptiontoabsorbtheiPaymylicensefeesoroffsetittoyourcustomers.

Part1:RegisteringyourCompanyiniPaymyandEnablingXeroPaymentIntegration

Step1:EnableXeropaymentintegrationintheiPaymyplatformbyregisteringyourcompanyinthecompanyprofile.

1. IntheBusinesstab,selectMyCompanies2. ClickRegisterYourCompany3. Completetherequestedinformation4. Checkthebox“Doyouwanttoenablepaymentintegrationforthiscompany?”

Ifyourcompanyisalreadyregistered,intheMyCompaniestabclicktheediticon nexttothedesiredcompany.Fromtherecheckthebox“Doyouwanttoenablepaymentintegrationforthiscompany?”

Page 3: iPaymy and Xero Integration v2.1 · [SHORTCODE]&licenceFee=1&key=IPM-CO-90 ... Singapore issued Visa and Mastercard credit cards have a license fee of 2.6% and American Express

iPaymyandXeroIntegration

3

Step2:ConnectyouriPaymyandXeroaccount

1. Enteryourbankaccountdetailsforwhereyouwouldlikeyourfundstobedeposited2. ClickConnecttoXero

3. YouwillthenbepromptedtologintoyourXeroaccount,enteryourlogincredentials.

4. Afterenteringyourlogincredentials,youwillbepromptedtoallowiPaymytoaccessyourXeroaccount.ClickAllowAccess.OncecompleteyouwillbetakenbacktotheiPaymyplatform.

Page 4: iPaymy and Xero Integration v2.1 · [SHORTCODE]&licenceFee=1&key=IPM-CO-90 ... Singapore issued Visa and Mastercard credit cards have a license fee of 2.6% and American Express

iPaymyandXeroIntegration

4

5. TheiPaymypagewilldisplay“Connectedwith[NameofXeroAccount].”Thisconfirmsyour

connectionwassuccessful.IfyoueverwishtodisconnectfromXerosimplyclickDisconnectFromXero.

6. Asafinalstep,selectwhichaccountinXeroyouwouldlikeallthepaymentsinreconcileinthroughthedropdownmenuunderSalesDefaultAccountCode.

7. ClickUpdatetosaveallthesedetails.

Page 5: iPaymy and Xero Integration v2.1 · [SHORTCODE]&licenceFee=1&key=IPM-CO-90 ... Singapore issued Visa and Mastercard credit cards have a license fee of 2.6% and American Express

iPaymyandXeroIntegration

5

Part2:AddingtheCustomPaymentURLtotheXeroPlatform

Step1:AddtheiPaymypaymentservicetoyourXeroaccountLogintoyourXeroaccountandfollowthestepsbelow:

1. IntheSettingsmenu,selectGeneralSettings2. UnderConnect,clickPaymentServices

3. ClickAddPaymentService,thenselectCustomPaymentURL

Page 6: iPaymy and Xero Integration v2.1 · [SHORTCODE]&licenceFee=1&key=IPM-CO-90 ... Singapore issued Visa and Mastercard credit cards have a license fee of 2.6% and American Express

iPaymyandXeroIntegration

6

Step2:ObtainthecustomiPaymypaymentURLsfromtheiPaymyPlatform1. InyouriPaymyplatform,viewyourregisteredcompany’sdetailsbyclickingonthe“eye”

iconintheactioncolumn.Thiswilltakeyoutoyourcompanyinformationpage.

2. Thefield“PaymentProviderIntegration”shouldbeindicatedas“Enabled.”Onyour

companyinformationpagetherewillalsobetwoURLstoselectfrom:• URLwithLicensefeePayablebyCustomer(yourcustomerpayslicensefee)• URLwithLicensefeePayablebyCompany(yourcompanypayslicensefee)

3. RightclickonthedesiredURLandselect“CopyLinkAddress.”Thesewillbepastedintoyour

Xeroaccount.

TheURLsshouldlooksimilartotheexamplesbelow:• URLwithLicensefeePayablebyCustomer

https://dashboard.ipaymy.com/api/thirdpartypayments/create-payment?invoiceNo=[INVOICENUMBER]&currency=[CURRENCY]&amount=[AMOUNTDUE]&shortCode=[SHORTCODE]&licenceFee=1&key=IPM-CO-90

• URLwithLicensefeePayablebyCompanyhttps://dashboard.ipaymy.com/api/thirdpartypayments/create-payment?invoiceNo=[INVOICENUMBER]&currency=[CURRENCY]&amount=[AMOUNTDUE]&shortCode=[SHORTCODE]&licenceFee=0&key=IPM-CO-90

Page 7: iPaymy and Xero Integration v2.1 · [SHORTCODE]&licenceFee=1&key=IPM-CO-90 ... Singapore issued Visa and Mastercard credit cards have a license fee of 2.6% and American Express

iPaymyandXeroIntegration

7

Step3:EnterthedetailsforthecustomURLinXeroOnceyouhavenamedthecustomURL,pastetheURLinthe“YourcustomURL”field.Afteryouenterthetextinthe“Paynowtext”clickSave.Thepaynowtextwilldisplayasabuttononthedigitalinvoicethatwilltakethecustomertothepaymentpage.iPaymyrecommendsusing“PaywithCreditCardviaiPaymy.”

Page 8: iPaymy and Xero Integration v2.1 · [SHORTCODE]&licenceFee=1&key=IPM-CO-90 ... Singapore issued Visa and Mastercard credit cards have a license fee of 2.6% and American Express

iPaymyandXeroIntegration

8

Part3:AddanExpenseAccountNote:ONLYappliesforcompanieswhowillbepayinglicensefeeForcompanieswhoelecttopaythelicensefee,theamountwillberecordedasanexpenseinthisaccount.Step1:AddaNewExpenseAccountToaddanewexpenseaccountinXerocompletethefollowingsteps:

1. IntheSettingsmenu,selectChartofAccounts2. ClickAddAccount3. SelectExpenseastheaccounttype4. EnterIPM100astheCode.Itisimportantthatthisexactcodeisentered.5. Enterthename“iPaymyLicenseFee”6. CheckEnablepaymentstothisaccount7. ClickSave

Yourformshouldlooklikethefollowing:

Page 9: iPaymy and Xero Integration v2.1 · [SHORTCODE]&licenceFee=1&key=IPM-CO-90 ... Singapore issued Visa and Mastercard credit cards have a license fee of 2.6% and American Express

iPaymyandXeroIntegration

9

Part4:AddNewBrandingThemeinXeroStep1:AddNewBrandingThemeinXeroToaddanewbrandingthemeinXerocompletethefollowingsteps:

1. IntheSettingsmenu,selectGeneralSettings.2. UnderFeatures,clickInvoiceSettings.

3. ClickAddNewBrandingTheme.InthebrandingthemeformselectthedesirediPaymyoption

fromthedropdownmenuunderPaymentService(creditcard).

Page 10: iPaymy and Xero Integration v2.1 · [SHORTCODE]&licenceFee=1&key=IPM-CO-90 ... Singapore issued Visa and Mastercard credit cards have a license fee of 2.6% and American Express

iPaymyandXeroIntegration

10

Part5:ImplementingiPaymyBrandingThemesinyourInvoicesWhencreatinganinvoiceselectthedesiredbrandingthemeinthedropdownmenuinthe“Branding”field.Asaresult,whenyourcustomerreceivesaninvoiceandtheyclicktopaytheywillautomaticallyberedirectedtoacustomiPaymypaymentportal.Note:Itwilltake4businessdaysforthefundstoarriveinyouraccountonceyourcustomerhaspaidviacreditcard.Therefore,weadvisesettingyourduedate4daysearliertowhenyouractuallyneedthefundsby.

Page 11: iPaymy and Xero Integration v2.1 · [SHORTCODE]&licenceFee=1&key=IPM-CO-90 ... Singapore issued Visa and Mastercard credit cards have a license fee of 2.6% and American Express

iPaymyandXeroIntegration

11

Part6:CustomerPaymentYourcustomerwillreceiveacopyoftheinvoiceviae-mail.Dependingonhowyoucustomizeyoure-mailandinvoicesettingstheappearancemaydiffer.Belowisastepbystepguideonwhatyourcustomerwillsee.Step1:CustomerReceivesE-MailYourcustomerwillreceiveane-mailcontainingalinktotheiPaymypaymentsitesimilartotheexamplebelow.

Step2:CustomerTakentoanInvoiceSummaryPageUponclickingonthelinknextto“viewandpayyourbillonline”thecustomerwillbetakentoaninvoicesummarypage.Toinitiatethepayment,clickonPayonCreditCardviaiPaymy.Note,thatthetextofthisgreenbuttonwilldisplaywhateverisspecifiedasthe“PayNowText”setinthe“AddCustomURL”function.

Page 12: iPaymy and Xero Integration v2.1 · [SHORTCODE]&licenceFee=1&key=IPM-CO-90 ... Singapore issued Visa and Mastercard credit cards have a license fee of 2.6% and American Express

iPaymyandXeroIntegration

12

Step3:CustomerTakentoaPaymentSummaryPageThepaymentsummarypagedisplaysintheinvoiceandtheamountdue.Forpaymentswhereyourcompanywillbeabsorbingthelicensefee,onlythetotalinvoiceamountisdisplayed.

Forpaymentswhereyourcustomerwillbeabsorbingthelicensefee,theinvoiceamount,licensefeeandtotalwillbedisplayed.

AusercanlearnmoreaboutthelicensefeeratesbyclickingontheViewRateslink.AsastandardSingaporeissuedVisaandMastercardcreditcardshavealicensefeeof2.6%andAmericanExpressandInternationallyissuedcreditcardshavealicensefeeof3.3%.

Step4:CustomerEntersCreditCardDetailsWhenyourcustomerclicksEnterCardDetailsthefollowingscreenappearspromptingforcreditcarddetails.

Step5:PaymentConfirmationUponsuccessfulthecustomerwillbetakentoapaymentconfirmationpage.ThepaymentconfirmationpagewillhaveaconfirmationreferencenumberandiPaymysupportcontactdetails.

Page 13: iPaymy and Xero Integration v2.1 · [SHORTCODE]&licenceFee=1&key=IPM-CO-90 ... Singapore issued Visa and Mastercard credit cards have a license fee of 2.6% and American Express

iPaymyandXeroIntegration

13

Part7:TrackingYourPaymentStep1:TrackingyourpaymentiniPaymyAssoonasyourcustomermakesapaymentitwillberecordediniPaymy.

1. Toviewyourpaymenthistory,clickonBusinesstabandthenPaymentIntegration.2. Filterwhichcompanyyouwouldliketoviewthepaymentreceivedhistoryfor.

Step2:TrackingyourpaymentinXeroOncethefundsaredepositedintoyourprovidedaccount(4businessdaysafterthecustomer’scardischarged)theinvoicewillbemarkedaspaidinXero.

1. ClickonAccountsandthenSales2. NexttoInvoicesclickonPaid3. Alistofrecentlypaidinvoiceswilldisplay