Boarding new merchants using our Low Code Boarding Solution


ProPay's Low Code boarding solution provides an easy way to integrate signups into your website. ProPay will host the experience on your behalf and collect all the data needed to stand up a new merchant. All you need to do is make a single API call to set up an instance of this page and then redirect your applicant to us. 

As with all Propay merchants, new accounts will be able to process immediately upon approval, which takes place in real time. Our interface also supports applicants placing orders for terminals that will arrive automatically after a few days. 

How does Single-Sign-On boarding work?
Embedding the ProPay boarding widget into your website using Single-Sign-On, requires two steps:
  1. Use the ProPay API to obtain a working key.
    • A working, single-use key is created specifically for a single ProPay account, and sign-on only works to the account number contained in your API request.
    • This API request requires client-side x509 certificate authentication.
  2. Pass the working key you obtain via the API into the website URL as the parameter. The merchant boarding page URL is provided in the XML Response. The key is included as part of the provided URL. 
Something to consider when using Propay's Low Code boarding solution
If you intend to sign up merchants via Low Code boarding, and also want to integrate processing on their behalf into your solution, then you will need to come up with a way to get their information back from Propay. 
  • Partners using Heartland Profac will receive push notifications from, and have access to, the Heartland download portal. 
  • Partners using the ProPay gateway can be enrolled in ProPay  web hooks  to receive notice as a user signs up on this ProPay hosted site. 
For more information about this approach to boarding, including screenshots that show the new user's experience, please refer to this  Low Code Boarding manual .)
 
How to call this method?

Example Request

Example Response

Implementation Details
Request Submission

Response Handling

Request Submission

Response Handling

Request Submission

Response Handling

Request Submission

Response Handling

Request Values
Response Values
How to call this method?

You should submit a post of XML data to the following URL
 
HTTP URL(s)
Example Request

Example Response

For Merchant Boarding SSO process ONLY: 

<XMLRequest>
   <certStr>8ac9b7db6b8b3717fe60d2e8</certStr>
   <termid>760d2e8</termid>
    <class>partner</class>
    <XMLTrans>
         <transType>302</transType>
          <tier>Tier Name</tier>
    </XMLTrans>
</XMLRequest>
<XMLResponse>
    <XMLTrans>
        <url>https://propay.merchant-portals.com/MerchantSignup?onboardingauthorizationtoken=859c358e-4f61-46b5-a41c-cf6c882dd1ff</url>
        <expiration>2023-08-01T23:34:42Z</expiration>
        <transType>302</transType>
        <status>00</status>
    </XMLTrans>
</XMLResponse>

 
Implementation Details
Request Submission

Response Handling

Request Submission

Response Handling

Request Submission

Response Handling

Request Submission

Response Handling

Request Values

Element

Type

Max

Required

Notes

accountNum

Int(64)

 

Required

The account to which you will "log-in"

ReferrerUrl

String

 

Required

The ProPay system requires that your single-sign-on originate from the URL originally provided here.

IpAddress

String

 

Required

The ProPay system requires that your signle sign-on originate from the URL originally provided here. Can supply a range of class c or more restrictive.

IpSubnetMask

String

120

Optional

The ProPay system requires that your signle sign-on originate from the URL originally provided here. Can supply a range of class c or more restrictive.

Response Values

Element

Type

Notes

status

string

Result of the transaction request. See ProPay Appendix for result code definitions

AuthToken

String

The ProPay transaction identifier. Will be a GUID.

How to call this method?

Example Request

Example Response

Implementation Details
Request Submission

Response Handling

Request Submission

Response Handling

Request Submission

Response Handling

Request Submission

Response Handling

Request Values
Response Values