Transfer Transactions

Send Funds

This transaction is used to send funds from one merchant’s settlement account to another.

Request Fields to Send Transfer

Required
Request Field
Description
N
TERMID
8 character terminal ID assigned by SportsPay; must be the first field
N
TYPE
Will always be T for transfers
N
PASS
Password for the TERMID
N
SUBTYPE
S for send funds
N
TRANGP
The transfer group
N
RECV
The receiving TERMID
N
AMT
The transfer amount with decimal
N
MSG
The reason for the transfer (to be displayed on PaymentsHQ). Maximum 30 characters, no punctuation, alphanumeric and spaces only.

Note: This is the same as the DESC field for a payment

N
REF
Unique value; if omitted or blank, it will be assigned by the gateway
INV
Tag the transfer with an invoice number for reporting
CUSTNAME
Name of the customer
CUSTEMAIL
E-mail address of the customer
p

It is recommended to supply REF to ensure a transfer is only approved once

s

REF must be unique to both the sending and receiving TERMID in the past year

Response Fields to Send Request

Response Field
Description
CODE
0000 is CAPTURED, anything else is an error code
TEXT
APPROVED or error message
REF
Reference number of the transfer
DATE TIME
Gateway time
DUR
The amount of time the gateway required to process the request

Reverse Transfer

This transaction is used to reverse a previously sent transfer. Transactions can be reversed within 30 days and can only be completely reversed – they cannot be partially reversed. 

p

If you need to refund money that was previously collected using an Inter-Merchant Transfer but are unable to do a Reverse Transfer due to the 30 days elapsing, simply create a new Send Transfer with the initial Receiver as the Sender and the initial Sender as the Receiver.

Request Fields to Reverse Transfer

Required
Request Field
Description
N
TERMID
8 character terminal ID assigned by SportsPay; must be the first field
N
TYPE
Will always be T for transfers
N
PASS
Password for the TERMID
N
SUBTYPE
R for reversal
N
ORIGREF
Reference number of the original transfer
MSG
The reason for the reversal (to be displayed on PaymentsHQ). Maximum 30 characters, no punctuation, alphanumeric and spaces only.

Note: This is the same as the DESC field for a payment

Note:
  • CUSTNAME and CUSTEMAIL fields will automatically be populated from the original transfer if they were included
  • Senders are always able to reverse a transfer (within the 30 day period) through PaymentsHQ

Response Fields to Reverse Request

Response Field
Description
CODE
0000 is APPROVED, anything else is an error code
TEXT
APPROVED or error message
DATE TIME
Gateway time
DUR
The amount of time the gateway required to process the request