Sale

Charges a card using a token (OTT or permanent) and captures the funds in a single step — the most common transaction type.

Charges a card using a token (OTT or permanent) and captures the funds in a single step — the most common transaction type.


Body Params
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 (S for Sale).

Allowed:
string
required
^\d+\.\d{2}$

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

string
required
^[a-zA-Z0-9]{16,19}$

Tokenized card data (16-19 alphanumeric characters).

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

Amount to charge cardholder for transaction in dollars and cents (numeric with decimal).

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

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

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

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

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

Platform-side customer identifier (max 40 characters; accepts alphanumeric, -, and _). Used to associate the transaction with a customer record in your system.

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

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

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

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

string
^(\d{5}(-?\d{4})?|[A-Za-z]\d[A-Za-z][ -]?\d[A-Za-z]\d)$

Cardholder ZIP or postal code for AVS (US ZIP, ZIP+4, or Canadian postal code).

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

Invoice number associated with the transaction (max 5-20 alphanumeric characters).

string
^[\w\s\W]{1,60}$

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
string
^[a-zA-Z0-9&\[\]=. ]+$

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

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