|
Input Fields
|
Required
|
Character Limits/Required Input
|
Description
|
|
username
|
Yes
|
30 char
|
User name used to log in to Speedpay.
Example: JSMITH09
|
|
Password
|
Yes
|
10 char
|
Password used to log in to Speedpay.
Example: 123@abc
|
|
creditAccount
|
Yes
|
22 char
|
The consumer's account number with your institution—the account to which a payment will be credited.
|
|
creditFirstname
|
No
|
15 char
|
The consumer's first name as it appears in your institution's database. If debitName is not obtained separately, but this value is available, it should be combined with creditLastname and copied over to debitName.
Example: Jane
|
|
creditMiddle
|
No
|
1 char
|
The consumer's middle initial as it
appears in your institution's database.
Example: Q
|
|
creditLastname
|
No
|
50 chars
|
The consumer's last name as it appears in your institutions database. If debitName is not obtained separately, but this value is available, it should be combined with creditFirstname and copied over to debitName.
Example: Smith
|
|
creditCity
|
No
|
25 char
|
The city from the consumer's billing address. If the debitCity is not obtained separately, this value can be copied over to debitCity.
|
|
creditState
|
No
|
2 char
|
The state from the consumer's billing address. If the debitState is not obtained separately, this value can be copied over to debitState.
|
|
creditZip
|
No
|
9 char
|
The ZIP code from the consumer's billing address. If the debitZIP is not obtained separately, this value can be copied over to debitZIP
|
|
debitFirstName
|
No
|
15 char
|
The first name of the person holding the debitAccount.
|
|
debitLastName
|
No
|
50 char
|
The last name of the person holding the debitAccount.
Example: Smith
|
|
debitAddress1
|
No
|
36 char
|
The address of the person holding the debitAccount.
|
|
debitAddress2
|
No
|
36 char
|
The secondary address of the person holding the debitAccount.
|
|
debitCity
|
No
|
25 char
|
The city of residence of the person holding the debitAccount. If the creditCity is not sent in separately, this value can be copied over to creditCity.
|
|
debitState
|
No
|
2 char
|
The state of residence of the person holding the debitAccount. If the creditState is not sent separately, this value can be copied over to creditState.
Example: NY
|
|
debitZip
|
Yes (for AVS)
|
9 char
|
The ZIP code of the person holding the debitAccount. If the creditZip is not sent in separately, this value can be copied over to creditZip.
Example: 10038
|
|
debitName
|
No
|
50 char
|
The name of the person on the debitAccount. If the credit names are not obtained separately, this name can be parsed and used for the creditFirstname and creditLastname values. This helps your customer service representatives find payments and makes reports easier to read.
Example: Jane Smith
|
|
debitJointName
|
No
|
50 char
|
The joint name of the person holding the debitAccount, if any.
Example: John Smith
|
|
phone
|
No
|
15 char
|
The consumer's primary contact number. This field can also be used to store miscellaneous data.
|
|
phone2
|
No
|
15 char
|
The consumer's secondary contact number. This field can also be used to store miscellaneous data.
|
|
language
|
No
|
char
|
This field indicates a customer's preferred language so that Speedpay can send customer notifications in the language indicate.
The following values are allowed:
|
|
scheduledPaymentDate
|
Yes
|
DateTime
|
The date on which the payment is to be processed.
Format: 2019-11-30T15:20:40Z
|
|
paymentAmount
|
Yes
|
Decimal
|
Payment amount (if splitAmount is being used, the sum of split amounts). Does not include feeAmount.
|
|
feeAmount
|
No
|
Decimal
|
Dollar or percentage amount your institution charges as a fee. Separate from the paymentAmount and splitAmount (if any).
Example: 4.00
|
|
feeChargeType
|
Yes
|
char
|
Determines whether the fee should be included with the payment amount when checks are printed or credit card payments are settled.
Possible values:
|
|
collectorId
|
No
|
10 char
|
The ID of the user who entered the payment. This value must be a valid user ID stored in the Speedpay database.
|
|
collectorGroup
|
No
|
5 chars
|
The name of the group to which the user who entered the payment is assigned. This must be a valid user group stored in the Speedpay database.
|
|
emailAddress
|
No
|
128 char
|
Email address where confirmation messages will be sent.
|
|
creditSiteId
|
No
|
4 char
|
An ID that determines the group. Payments entered with the same creditSiteId will be processed together.
Example: TEST
|
|
creditInstId
|
Yes
|
4 char
|
An ID that appears in the "Print Site" field on the Speedpay Call Center application (Desktop). This field usually tracks the interface or physical location that entered thepayment. It is sometimes also set equal to the creditInstId.
Values are:
-
Payment entered by the consumer over the internet.
-
Payment entered by the consumer over interactive voice response unit.
-
Payment entered by Call Center application (Desktop).
|
|
payeecode
|
Yes
|
4 char
|
A four-digit alphanumeric code that represents the payee name. This field must be a valid entry in the PAYEE table in the Speedpay database.
Example: ACME
|
|
uniqueTransactionID
|
No
|
50 char
|
Must be a valid GUID (which is 36 alphanumeric characters) and can be used to indicate a unique ID for each transaction sent to Speedpay in order to prevent duplicates [in addition to our duplicate payment check].
|
