Get API Key

Returns a short-lived API key and JavaScript host URL for Embedded Tokenization. Include AMT to also receive the calculated USERFEE for CustomerPay-enabled merchants.

Returns a short-lived API key and JavaScript host URL for Embedded Tokenization. Include AMT to also receive the calculated USERFEE for CustomerPay-enabled merchants.

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 call. Will always be Z.

Allowed:
string
enum
required

Sub-type. Will always be TA

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

Amount of the transaction in dollars and cents (numeric with decimal).

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

Platform Fee - Amount to add to transaction amount in dollars and cents (numeric with decimal).

Response

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