|
Amount
|
decimal number
|
|
Y
|
|
Amount to authorize. Use a positve amount to indicate a purchase, and a negative amount to indicate a refund.
|
|
PaymentId
|
integer
|
|
Y
|
|
A PaymentId retrieved prior to making the authorization request, using TXN/Payments/ReserveIds.
|
| FK: T_PAYMENT.payment_no Resource: Payments |
|
ConstituentId
|
integer
|
|
N
|
|
If not passing ConstituentId, do not pass BillingAddress
|
| FK: T_CUSTOMER.customer_no Resource: Constituents |
|
Card
|
CardData
|
|
Y
|
|
In the Card object, supply one of the following: 1) card number, 2) track1 and/or track2 data, 3) VantivEncryptedCard object 4) Payment Express token, or 5) account id to reference a previously stored card. If refunding using a ReferenceNumber, do not fill in any of these values. Note that if Cvv2 field is passed, the transaction will be declined if it does not match the value on the cardholder account, except for the EPay gateway.
|
|
ThreeDSecureData
|
ThreeDSecureData
|
|
N
|
|
Optional 3DSecure authentication data (only valid for SecureCXL)
|
|
BillingAddress
|
BillingAddress
|
|
N
|
|
Used for Address Verification System (AVS). Do not pass without also passing ConstituentId
|
|
AuthorizationCode
|
string
|
|
N
|
|
Supply a force or manual auth code that was previously obtained. The supplied auth code will be used for settlement and the card will not be authorized online. Cannot be used for Payment Express or EPay gateways.
|
|
ReferenceNumber
|
string
|
|
N
|
|
ReferenceNumber may be passed to generate a refund, except for the SecureCXL gateway. A Card object will still be required.
|
|
TransactionOrigin
|
string
|
|
Y
|
|
Text indicating the origin of the transaction. The text will be written to T_PAYMENT_GATEWAY_ACTIVITY.origin if payment card tokenization is enabled.
|
|
PaymentMethodId
|
integer
|
|
Y
|
|
A valid payment method ID for use online. Payment methods and their properties can be retrieved from the PaymentMethods resource.
|
| FK: TR_PAYMENT_METHOD.id Resource: PaymentMethods |
|
IsECommerce
|
boolean
|
|
Y
|
|
Set to true for online transactions. Defaults to false.
|
|
IsRecurring
|
boolean
|
|
N
|
|
Set to true for recurring billing transactions. Defaults to false. Use for Payment Express only and turn on RecurringBillingSupported property in the Payment Gateway profile.
|
|
AllowPartialAuth
|
boolean
|
|
N
|
|
If the requested amount is not available on the cardholder account, accept whatever amount can be authorized. Only works on Vantiv. If a partial amount is authorized, the partial amount will be returned in AuthorizedAmount in the AuthorizationResponse.
|
|
UserData
|
string
|
|
N
|
|
User-generated free-form text stored in T_PAYMENT_GATEWAY_ACTIVITY.user_data. Tessitura-generated transactions write the invoice, order, or contribution number.
|
|
StoreAccount
|
boolean
|
|
N
|
|
If supplied, controls whether or not the account will be stored in T_ACCOUNT_DATA after completion of the authorization, as long as the system-wide default CC_STORE_ACCOUNT is not set to No.
|
|
ReturnUrl
|
string
|
|
N
|
|
Set for return Url when 3DSecure redirection happens. Use for Tessitura Merchant Services only.
|
|
ShopperIp
|
string
|
40
|
N
|
|
Specifies the IP Address of the end-user. Supports IPv4 and IPv6 formatting. Stored in T_PAYMENT_GATEWAY_ACTIVITY.shopper_ip and provider transaction details reporting. Use for Tessitura Merchant Services only.
|
|
DeliveryDate
|
date
|
|
N
|
|
A delivery date that is used for Tessitura Merchant Services authorizations only. The date to use for any specific cart is returned by the GetCart service.
|
|
ShopperEmail
|
string
|
|
N
|
|
Specifies the email address of the end-user and used for fraud prevention. Use for Tessitura Merchant Services only.
|
|
ShopperName
|
ShopperName
|
|
N
|
|
Specify the name of the end-user and used for fraud prevention. Use for Tessitura Merchant Services only.
|