Embedded Components

Body Params

Start an embedded session that collects card data and charges the cardholder.

string
required

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

string
required
length ≤ 16

Password for the Terminal ID (provided by SportsPay).

string
enum
required

Type of transaction (W for Web-Redirect).

Allowed:
string
enum
required

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

Allowed:
string
required

Amount to be processed in dollars and cents (numeric with decimal).

string

Activates Embedded Components mode. Accepts any combination of the following letters to suppress individual UI sections (letters may be combined in any order). May also be sent as an empty string to activate embedded mode with default chrome.

  • W — omit the wrapper container (background & centering)
  • C — omit the card container
  • H — omit the header section
  • I — omit the info section
  • A — omit the amount/schedule block
  • B — omit the pay/cancel buttons (use the provided JS hooks to submit or cancel)
  • S — omit the SportsPay branding
  • P — omit the partner area
string

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

string
required

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

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.

string
required

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

string
enum

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

Allowed:
string

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

string

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

string

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

string

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.

string

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

string

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

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).

string

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

string

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

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].

string

URL the iframe will navigate to after an approved transaction. Use this to trigger your post-payment flow (e.g., a parent-page postMessage listener or a navigation).

string

URL the iframe will navigate to after a declined or failed transaction.

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json