Start Session

post

https://svra.interpaypos.com:1443/

Creates a Customized Checkout payment session and returns a SECUREID and redirect URL. The customer completes payment on the SportsPay-hosted page, then returns to your SUCCESSURL or FAILUREURL.

Body Params

Create a new redirect session that to securely process a payment directly between the customer’s web browser and the SportsPay's gateway.

TERMID

string

required

Terminal ID of the merchant (8 alphanumeric characters). Must always be the first field.

PASS

string

required

length ≤ 16

Password for the Terminal ID (provided by SportsPay).

TYPE

string

enum

required

Type of transaction (W for Web-Redirect).

Allowed:

ACTION

string

enum

required

Defines the action to perform. For this request, it will be StartSession.

Allowed:

AMT

string

required

Amount to transfer in dollar and cents (numeric with decimal).

CUSTNAME

string

Customer's name (max 40 characters; accepts alphanumeric, spaces, -, ', and .).

CUSTEMAIL

string

required

Customer's email address (max 60 characters; accepts standard email characters: alphanumeric and @ . ! # $ % + - _ { | } ~).

CUSTID

string

Platform-side customer identifier (max 40 characters; accepts alphanumeric, -, and _). Used to associate the transaction with a customer record in your system. Enables customer vaulting — payment methods saved under a CUSTID can be reused for future one-time or installment payments.

REQUESTID

string

required

Unique value assigned to the payment session to avoid duplicate sessions (5-20 digits).

LANG

string

enum

Language to display to the customer: E for English, F for French (defaults to English).

Allowed:

REFNUM

string

Unique reference number attached to the transaction (8-40 characters; accepts alphanumeric, -, and /). Must be unique within the current batch.

INV

string

Invoice number associated with the transaction (5-20 alphanumeric characters). Acts as a transaction tag — does not need to be unique.

DESC

string

Description of payment (up to 60 characters; accepts alphanumeric, spaces, symbols and punctuation marks).

PROGRAM

array of objects

Program-level line items associated with the transaction. Appears in the Deposit Report to provide a breakdown of charges contributing to a deposit. Multiple PROGRAM entries may be included.

PROGRAM

PLAYER

array of objects

Player-level line items associated with the transaction. Appears in the Deposit Report alongside PROGRAM entries. Multiple PLAYER entries may be included.

PLAYER

ACCOUNT

array of objects

Account-level line items associated with the transaction. Appears in the Deposit Report alongside PROGRAM and PLAYER entries. Multiple ACCOUNT entries may be included.

ACCOUNT

PLATFORM

string

Platform Billing amount - Gateway applies as Platform Fee (added to transaction) if CustomerPay, or Platform Charge (deducted) if Merchant Pay. Amount in dollars and cents (mutually exclusive with PLATFEE and PLATCHRG)

PLATFEE

string

Platform Fee - Amount to add to transaction amount in dollars and cents (mutually exclusive with PLATFORM and PLATCHRG).

PLATCHRG

string

Platform Charge - Amount to subtract from transaction amount in dollars and cents (mutually exclusive with PLATFORM PLATFEE).

SPLIT

string

The Split Payment information, formatted as multiple key-value pairs inside brackets. Each Split Payment entry must be enclosed in square brackets and can include multiple fields separated by &. Example format: [TRANGP=TESTGRP&RECV=DEVM0058&AMT=1.20&REF=12345678&MSG=DEMOTRANSFER].

Response

200SUCCESSFUL TRANSACTION