API Reference
  1. Direct Payments

Auth

post
https://svra.interpaypos.com:1443/

Authorizes funds on a card without capturing them. Use when you need to verify a card or place a hold that you'll capture later with a Force Post.

Authorizes funds on a card without capturing them. Use when you need to verify a card or place a hold that you'll capture later with a Force Post.

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 (A for Authorization only).

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). Accepts either a One-Time Token (OTT) from Embedded Tokenization or a permanent token.

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}$

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 (5-20 alphanumeric characters). Acts as a transaction tag — does not need to be unique.

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

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

Response

Updated 4 days ago

Related

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

Updated 4 days ago

Related

Did this page help you?