Pre-Auth

Places a temporary hold on a card for an estimated amount. Finalize later with a Completion for the actual amount (equal to, less than, or zero).

Body Params
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 (P for Pre-Authorization).

Allowed:
string
required

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

string
required

Tokenized card data (16-19 alphanumeric characters). Accepts either a One-Time Token (OTT) from Embedded Tokenization or a permanent token.

string
required

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

string

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

string

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

string

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

string

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

string

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

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

Response

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