Inter-Merchant Transfer

Transfers funds from one SportsPay merchant to another. Both merchants must share a Transfer Group configured by SportsPay.

Body Params
string
required
^[a-zA-Z0-9]{8}$

Terminal ID of the merchant that is sending the transfer (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

Request type. T for Transfers.

Allowed:
string
enum
required

S to Send Transfer.

Allowed:
string
required
length ≤ 20
^[a-zA-Z0-9\-_]{1,20}$

The transfer group, provided by SportsPay (up to 20 characters; letters, digits, - and _).

string
required
^[a-zA-Z0-9]{8}([a-zA-Z0-9]{2})?$

The Terminal ID of the merchant that is receiving the funds (8 or 10 letters and digits).

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

Amount to transfer in dollar and cents (numeric with decimal).

string
required
length ≤ 30
^[a-zA-Z0-9 #\-]{0,30}$

Reason for the transfer that is displayed to both parties (max 30 characters; letters, digits, spaces, - and #; other characters are removed).

string
^[a-zA-Z0-9\-/]{5,40}$

Your reference for this transfer (5-40 characters; letters, digits, - and /). Use a new REF for every transfer; one that's already been used returns 8410. Leave it out and the gateway generates one. It's returned in the response; keep it, since you need it to reverse the transfer.

string
^[a-zA-Z0-9éèàùâêîôûëïüçÉÈÀÙÂÊÎÔÛËÏÜÇœŒæÆ ._+\-&,'()]{2,60}$

Customer's name to tag to the transfer (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 to tag to the transfer (max 60 characters; accepts standard email characters: alphanumeric and @ . ! # $ % + - _ { | } ~).

string
^[a-zA-Z0-9-]{5,20}$

Invoice number associated with the transfer (5-20 characters; accepts letters, digits, and -; stored in uppercase). Acts as a transaction tag — does not need to be unique.

Response

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