Force Post

Captures funds from a previously approved Auth Only transaction using the AUTH number returned on the original Auth.

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 (F for Force Post).

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

Amount in dollars and cents of the Authorized transaction that you are Force Posting (numeric with decimal).

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

The authorization number for the transaction you are Force Posting (6 letters and digits).

string
required
^[A-Z0-9]{1,40}$

Tokenized card data (up to 40 characters; digits and uppercase letters only). Accepts either a One-Time Token (OTT) from Embedded Tokenization or a permanent token.

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

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

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

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
^[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
^[\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-]{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).

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.

Response

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