Embedded Components

Creates a payment session for Embedded Components. The returned URL is rendered inside an iframe on your checkout page so the payment form appears as part of your own UI.

Use the EMBED parameter to control which visual components render on the embedded fragment.

Body Params

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

string
required
^[a-zA-Z0-9]{8}$

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

string
required
length ≤ 16
^[a-zA-Z0-9]+$

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
^\d+\.\d{2}$

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

string
^[WCHIASP]{1,10}$

Activates Embedded Components mode. Accepts any combination of the following
letters to suppress individual UI sections (letters may be combined in any order).
At least one letter is required; an empty value is rejected (2038).

  • 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
  • S — omit the SportsPay branding
  • P — omit the partner area
string
^[a-zA-Z0-9éèàùâêîôûëïüçÉÈÀÙÂÊÎÔÛËÏÜÇœŒæÆ ._+\-&,'()]{2,60}$

Customer's name (2-60 characters; accepts letters including accented letters, digits, spaces, and . _ + - & , ' ( ); other characters are removed).

string
required
^[\w\.-]+@[a-zA-Z\d\.-]+\.[a-zA-Z]{2,}$

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

string
^[a-zA-Z0-9\-_/]{1,40}$

Platform-side customer identifier (max 40 characters; accepts letters, digits, -, _, 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
^\d{5,20}$

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
^[a-zA-Z0-9\-/]{5,40}$

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

string
^[a-zA-Z0-9-]{5,20}$

Invoice number associated with the transaction (5-20 characters; accepts letters, digits, and -; stored in uppercase). Acts as a transaction tag — does not need to be unique.

string
^[a-zA-Z0-9éèàùâêîôûëïüçÉÈÀÙÂÊÎÔÛËÏÜÇœŒæÆ \-'.&()%+]{1,60}$

Description of payment (up to 60 characters; accepts letters including accented letters, digits, spaces, and - ' . & ( ) % +; other characters are removed).

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. The AMT values must total no more than the transaction AMT (8425).

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. The AMT values must total no more than the transaction AMT (8425).

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. The AMT values must total no more than the transaction AMT (8425).

ACCOUNT
string
^\d+\.\d{2}$

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
^\d+\.\d{2}$

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

string
^\d+\.\d{2}$

Platform Charge - Amount to subtract from transaction amount in dollars and cents (mutually exclusive with PLATFORM and PLATFEE). Maximum is the lesser of 100.00 and AMT.

string

One or more transfers to other merchants, each in square brackets with its fields separated by &, for example [TRANGP=TESTGRP&RECV=DEVM0058&AMT=1.20&REF=12345678&MSG=DEMOTRANSFER]. Send it as a string in this format, also in JSON requests.
Each entry takes the same fields and rules as an Inter-Merchant Transfer, plus RECVINV (5-20 letters, digits and -) for the receiver's invoice number. In a split, REF and MSG are optional; REF is generated if left out.
The split amounts together can't be more than the transaction AMT.

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