Overview

The Application Form Redirect allows you to launch a SportsPay application form from within your platform for either a:

• 🆕 New application (using an OfferID)
• 🔄 Existing or saved application (using an ApplicationID)

This form can be pre-filled with known information, and organization's have the option to save their progress and return later if needed.

Once an organization completes or exits the form, SportsPay will redirect them back to your website using the provided CallbackURL, and include the ApplicationID and application status in the redirect.

You can use the ApplicationID from the redirect to allow the organization to resume the same application at a later time.

Route Format

🔹 For New Applications

To start a new application, use this route format:

https://register.sportspay.com/en-ca/register/{OfferID}?OrgID={OrgID}&AuthPersonEmail={Email}&CallbackURL={URL}

Use an OfferID to initiate a brand-new application via one of your Pricing Models/Offers. All query parameters are required.

🔹 For Returning or Existing Applications

To resume an existing or saved application, use the ApplicationID from the previous callback:

https://register.sportspay.com/en-ca/register/{ApplicationID}?OrgID={OrgID}&CallbackURL={URL}

Use an ApplicationID when the user is returning to complete an existing application. AuthPersonEmail is optional but can be included.

Required Query Parameters

🔹For New Applications (OfferID)

🔹For Existing Applications (ApplicationID)

Optional Pre-Filled Fields (POST)

You may submit additional POST data to pre-fill application fields. These values will only be used if the fields haven’t already been completed.

Redirect Behavior

After a user exits or submits the form, they are redirected to your specified CallbackURL with the following query parameters:
{CallbackURL}?data={PtnrData}&code={ApplicationID}&status={Status}

Redirect Parameters

Status Values

Example

GET Example (Basic)

https://register.sportspay.com/en-ca/register/ACME1234?OrgID=550e8400-e29b-41d4-a716-446655440000&[email protected]&CallbackURL=https://yoursite.com/registration-return

POST Example (Pre-Filled Fields)

Send a POST request to the above URL with form-encoded data like:
LegalName=Acme+Corp&OrgName=Acme+Inc&OrgCity=Toronto&OrgProvinceStateCode=ON

Example Redirect

https://yoursite.com/registration-return?data=abc123xyz&code=ACME1234&status=in-review

Notification Callback

When a merchant's account setup is complete and approved, SportsPay can automatically notify your system by sending the organization's credentials to a designated API endpoint — this is referred to as the notification callback.

This callback ensures a seamless handoff of credentials (such as terminal ID and password) for integration into your platform.

Set Up

Please coordinate with the SportsPay Team to set up your preferred notification method. You can choose one of the following:

• Callback (Recommended): SportsPay will send the finalized account credentials via a secure webhook to your specified endpoint.
• Email Delivery: If you do not have an API endpoint available, we can email the credentials directly to your team.

Note: The structure of the callback payload can be customized to match your implementation needs.

{
  "sportspay_merchant_id": "MERC1234",
  "sportspay_term_id": "TERM1234",
  "sportspay_term_password": "Pass1234",
  "org_id": "a1nKKJ545sdeafx",
  "livemode": false,
  "sportspay_account_status":"completed"
}

Fields

Error Handling

If you receive a status of error in the redirect, we recommend:

1. Logging the error
2. Providing users with an option to retry the onboarding process
3. Contacting SportsPay support if issues persist