Platform Billing

post

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

Adds a Platform Fee (PLATFEE) or Platform Charge (PLATCHRG) to a transaction. PLATFEE is added on top of the transaction amount and paid by the cardholder; PLATCHRG is subtracted from the approved amount and paid by the merchant. Only one may be used per transaction.

Adds a Platform Fee (PLATFEE) or Platform Charge (PLATCHRG) to a transaction. PLATFEE is added on top of the transaction amount and paid by the cardholder; PLATCHRG is subtracted from the approved amount and paid by the merchant. Only one may be used per transaction.

Body Params

Add a Platform Fee to a Host-Based Sale transaction.

TERMID

string

required

^[a-zA-Z0-9]{8}$

Terminal ID of the merchant (8 alphanumeric characters). Must always be the first field.

PASS

string

required

length ≤ 16

^[a-zA-Z0-9]+$

Password for the Terminal ID (provided by SportsPay).

TYPE

string

enum

required

Type of transaction (S for Sale).

Allowed:

AMT

string

required

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

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

PLATFEE

string

required

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

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

TOKEN

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.

REF

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.

CUSTNAME

string

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

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

CUSTEMAIL

string

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

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

INV

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.

DESC

string

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

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

Response

Platform Billing

Related

Related

200Successful response

Related

Related