Super Merchants

Super merchants are intended for PSPs. The key difference between a 'Supermerchant' and a normal merchant is the ability to create 'Submerchants'.

Supermerchants cannot initiate transactions on their own behalf. Instead, they create 'Submerchants' which have the same settings at the top level merchant, but a different name and logo. The Supermerchant can query any transaction for any of its Submerchants.

In order to make an API call on behalf of the Submerchant, an additional parameter must be passed in with a standard API call, with the name 'SubMerchantCode' and a value of the Submerchant's entity code.

Initiate Transaction Example Request With SubMerchantCode:

{
  "Amount":"10.00",
  "CurrencyCode":"AUD",
  "MerchantReference":"Reference1234",
  "MerchantHomepageURL":"http://localhost.com",
  "SuccessURL":"http://localhost.com",
  "FailureURL":"http://localhost.com",
  "CancellationURL":"http://localhost.com",
  "NotificationURL":"http://localhost.com" ,
  "SubMerchantCode":"SubMerch4" 
}


Maintenance on Submerchants can be done via our console or the API.

Update Sub Merchant API Call


URL:

https://poliapi.apac.paywithpoli.com/api/Entity/UpdateSubMerchant
KeyValueDescription
MessageIDnvarchar(30)Round trip text data
MessageStatusint0 = success
1 = error
SubMerchantCodenvarchar(20)The Submerchant code that you created and want to set
MerchantNamenvarchar(200)The display name you want to set for the Submerchant code
MerchantLogonvarchar(max)Base64 encoding of Logo content
LogoContentTypenvarchar(30)The content type of the logo sent to us - eg. image/jpeg
SupportEmailnvarchar(50)The public facing support email for customers that will be displayed during transactions
SupportPhoneIntThe public facing support number for customers that will be displayed during transactions


Example request

{
  "MessageID":"messageid",
  "SubMerchantCode":"ABC00",
  "MerchantName":"merchantname",
  "MerchantLogo":"logocontent",
  "LogoContentType":"image/jpeg",
  "SupportEmail":"email@email.com",
  "SupportPhone":"0412345678"
}

Example response

{
    "MessageID": "messageid",
    "MessageStatus": 0,
    "Result": "Created",
    "ErrorCode": 0,
    "ErrorMessage": ""
}

Logo Content

To find the logo content, you must base64 encode the logo content. Will allow you to upload an image and will return the Base64 encoded value of the image. This should then be put into the “MerchantLogo” field.

An example:

{
  "MessageID":"messageid",
  "SubMerchantCode":"SubMerch1",
  "MerchantName":"merchantname",  
  "MerchantLogo":"R0lGODlhkwBVAPcAABQSFIyKjMTGxCxGnKyqrOTm5HRydERCRLzG5HyKxFRqrJyq1Gx6tERapPT29MzW7IyazCwqLLS63OTm9GRiZBweHDxSpFxytHSCvOTi5NTW1ExOTISSxKSy1JSizOzu9JyenDROpMTO5ExirMTCxDQ2NCQmJNzi9JSSlMzOzDRKpLSytISChExKTFxqtGx6vPz+/LzC3Gx2tHyGxIyWzKy23Jym1PTy/BwaHDRKnOzu7ERGRMTK5HyOxKSu1ExarPT2/NTa7JSezLS+3OTq9GxqbCQeJGR2tHSGvNze7Nze3FRWVISWxKy21JymzOzy9MzS5FRmrDw+PGx+vBQWFIyOjMzKzDRGnKyurOzq7HR2dMTG5FxqrKSq1NTW7JSazCwuLERWpGRytNza3FRSVKyy1JyizKSipDxOpMzO5FRirDw6PCwmJOTi9JSWlNTS1LS2tISGhFxutExGRISOxExerPz6/Ly+3Ozq9GxubCQiJHyGvNzi7IyWxPTy9HR+vAAAAADEAACzMwB2AAAAvAAA6iwAGAAAAAgAcrABACQAAAUAAAAVGADA6wDeGAB2AADMTwDpQAAY5gAAdgAVjADAawDe+AB2vnzM/gH7/ywY/wAA/wDlWwAKwQCi3gB3dlAsmQHjwSw23gABdkj+yMP/CSX/MwX/AFAE+wHqoiwY3QAAdjhexKoaQTXcPgB2yAACAAAAACwAAAAAAFAAAAEBACwAAAAAAFQcAADqAAAYAAAAAABSAwC/AADeAAB2AFA0AQEAACwAAADAAALt+ADr6gAYGAIAAKAMhwJRHQBQgwAAc3EAzAAA+wAAGHEAAHFETwDrQAAY5gAAdhPm7AC/CQDe+wB2vsCA/ult/xhQ/wAA/wO0+wB5ogBQ3QAAdnE0WAAAqgAAQnHAAHFAyADqCQAYMwAAAHEAAAABAAAAAAAAAPIH7SvA657eGHd2AAABUEAAAAgAAEgAAHEAqAAAQQAAPgAAyDiQUKrrADUYAAAAAGAuea1n3XdpSAVmACH5BAEAADAALAAAAACTAFUABwj/AGEIHEiwoMGDCBMqXMiwocOHECNKnEixosWLGDNq3Mixo8ePIEOKHEmypMmTKFOqXMmypcuXMGPKnEmzps2bOHPq3Mmzp8+fQIMKHUq0KAweRpMWdLFHqdEbXnioUDHDjtOfN2rM+KFiwBWvA2ZcXRiABQstcdCqjcMijpsqVd7GBSGggEYvM7p+3Qv2SlWCbW40FLCjsOHDhTdoeJjFrOPHjylWAEC5suXLmKlIceOgYpAXfEP3DWtVYJIgPEonhIO5dYqHGozIrmCkApsKtnGzUQ1xcuvfv6lUkQiEhgrRyMG+sAokCJQ0HZIoZA288muHGnLX3i7biJ7dE31X/x9feYOOh0HqjBatd0D75TeybOHhwwaC1eQBXG8Ye/bt7bgZAZ5E4uU3nhSdMVTDceuN1uBXdJwwAQ8S+NCHEBIgRN14+zE0RoC0afffgBEVaGB1eTBEwwAPuvcVg+1dYYENH/CRBBRNLMABBgkgZdCG1XW4UHZszNadkST2dqKBAihExxUxPnhFaCrQ4AcMNySxQBBllCFEDxhgQMSP+QmpUGy0CUjbiLbx9pCJS/62BEJ20JAcWO2xuFcCYwo0QQw8JACFEDZw0EcPYhUEJHBmJoTmfyAGGIGbDsF5WRUrYOEGBVSQR4VdBtWQHJR9jUBHGF69IN1AdkwQxBAd0P+BgBlCYMABDUMoWuZDY9RGmx56eBesHm2GxyFBKZhA3hkGecFgaF95lQMdQcBgBxouPHCQF1Bs0YUTCdxRAwQY7JGAruQ1ilB2xBKL27u4TWpskAURQF6KBAFRx4sOHvfCBAPdEANCE9ywhQg+dLFAHx74wAETHAw80KK/qXsQmkdmLCClDVlqmZB2eFxeQXZ6xZfJOfgAERRc8kEDB0IgsIAQM9BBA0EUu/ZQBnO0sMMcPwcN9BwbSHZsQTscCFiee3Wlgo8QITCBE0GY8bIZTuzBAQeq5YyZxSiJTJmZGyg90Ax4irYFRV0EgcDDHEigYw8cQDHxrjCJrZ9BG3T/ClwJA03w7Ho2VNTGEF/cIUQfPnhAQwIcLHB3ug/pIMDlmGeOudH0FlR2dVIMtCK/fLlwUdw8cEC3DR7sAYEQkx/dEAn5ccyQ3mSbDcMPD6qQxkU+DNFHAjY7QcMeQsAukNeXgV2QAPklWKLsAyUNukAPjCoHRl5AcATddDhRKwQ3L4/37LXPy6hByla3g0A2jNZeDRjhwcAFHGhtAw0YMKE8DMz72EOgRx7pKalzA9GA34CDL9A0aACCucgELiAHDsyAAx6gAxKE8IXYIZAhtCOP7RaCO88t8DduEAjvSOeVH2QEDy8w1csy6DoPeHB9DiHgeAz4pupQ4ToOIEx+/8YAAyAMji8vyEgaeqAAOvQBZglIQB8KZz7KOSSE4xmhQvRGBdxQ4YTAWYOfRiWGjNiADjOg29YSgIQESAyA52OIDqvDw0rFiTxYEMgJRpVEjHyPDhyw2R72gIQZ4OGGFXsIFqujxYToLU4tGEgb3IMnsEQBIxNgQBQACcgoShFncVzIHIFTx47dETgRyELg9CQ/FQDhIk4kHgcgFyY6ULGK1FvIIoHTSIQ80kAlyABB7BClKXnlPhVJwgsq2Ac6MIF4SMAAH0BpxcFET32npAwOtHClgvwgOSro40TsIIY1cgAJdJgCBpBQPkTq7IrpkwgOskkZE2iBiAdB26jsNv8ROnivZoDM3wwYADVcflCU15QIGC/zxQrg4KFgWMMGiuAGK2jRBy1SwQgiCBEI0EEO/jwUB16gTjqQaTxUoIvmVloXGOzyN708yDwPChE8FNMrKmiAGF7pECBoTQw9eCKPCImEF3jhpPS0TBxgMMrflJIhC73MGyxyhOSgIQdqkAPAGMKDI3jPUD1AJxMwMIUX2BCpSaXMUl/ampgaZKY4pMgWTCYaC6AhCnJwQjcPwgMGsNFcHsVAHyDAgBccgQEcC2CcltrU1jx1IVG1zFQt4gIWrUcFFqhDHciKAR+kIQg3akICgEoHDNAAkH2wVR9eIIYpuKANGkqrUl0az4j/wDWRFvFCDpjmFTRYIApi2GwPIKc1OgzXmbEcXgIgcAEGYEANIsCPbNXK1IRGJLKVmaxFvmDMI+a0DkfAwAzMNVw1BpRcqWXCC9arhoKiNa1rrS1EbvvOixyhRWi46xFay4BoJkBrNODfLHvAADnI4Ah1cO97k8pY60IEu5TRrkVu4IKm9eUKIQhDHS7gAjmEaQ9gQsI516mGOkShAT+o1kIUu6T4inAi9P2aRoAgBsue7Ao/UANwwyReNDr3uXXQ8BWmwNHpTJe6jcXMYxUCYQBI+CJ16u6LpjyAMPzABcA9QhQ025UB/CBXDmHxiVycRRjEoQgsAEEAdEABYSYku8bN68gD1GDMBunlzntBgxl4GuYjA4AF1S2gQMhghyoc4AxSsIJC4CzZj0ggCscxJnJK5wM+P2QFfiYzIwdtBxRUIQIBUHRC3ODpUlfB1ChQJUiCIAQ5HBEsaBCDDVY1kQyc+taoxrWuc+1pRReA17seyApgkIIMYCEFqs6JHYKwhQ7YoAs1SMNWx0Ltalv72tjOtra3ze1ue/vb4A63uMdN7nKb+9zoTre6183udrv73fCOt7znTe+cBAQAOw==",
  "LogoContentType":"image/gif",
  "SupportEmail":"email@email.com",
  "SupportPhone":"0412345678"
}

This string is a base64 encoded POLi logo in the correct dimensions.

supermerchants.txt · Last modified: 2017/05/16 16:04 (external edit)