|
Bluefin Payconex Gateway
This page details the inputs, secure inputs and outputs available for the Vantiv Tokenization Gateway, how to complete each field, and an external link to the Vantiv integration documentation.
PCI Pal must check any payment gateway integrations prior to going live. The documentation disclaimer (which applies throughout this guide) should be read before commencing any configuration of payment gateways.
Inputs
|
Input Fields
|
Required
|
Character Limits/Required Input
|
Description
|
|
accountId
|
Yes
|
12 num
|
The Payconex account identification number that you are issued after the account has been setup.
|
|
apiAccessKey
|
Yes
|
32 char
|
The secret key that you will be
provided when your Payconex account is set up and when you have requested access to QSAPI.
|
|
tenderType
|
Yes
|
|
The payment tender type that you are submitting. Always set to CARD.
|
|
transactionType
|
Yes
|
|
The type of transaction you are
requesting, with these enumerated values allowed:
AUTHORIZATION: authorizes (holds) the funds on the card but does not transfer them. Most banks support a $0.00 authorization in order to validate the card number, expiration date, and account status. This does, however, incur an authorization charge on the merchant account and a transaction charge in Payconex.
SALE: authorizes the funds on the card and flags the transaction to be captured for settlement at the next settlement time.
REFUND: refunds a previous sale. If the transaction has not yet been settled, then this results in a void.Otherwise, for Cards only, It results in a credit back on the card. ACH transactions can't be refunded once they are submitted for settlement (NOTE: For actual transaction settlement times, contact Bluefin support). You can specify an amount less than the original sale amount. Requires token_id.
CREDIT: puts money onto a card or into a bank with no offsetting sale.
Most operations can be managed via REFUND. Only allowed if account is configured to allow Credits.
CAPTURE: flags a previous
authorization to be captured for settlement at the next settlement time. Requires token_id.
SETTLEBATCH: settles all un-settled sales, refunds, credits, or authorizations that have been captured.
STORE: stores credit card/ach account info for later use.
FORCE: forces through a transaction. A 6 digit authorization_code must also be provided.
REVERSAL: removes an authorization request on a credit card or debit/ebt.
Requires token_id (Elavon,
Paymentech, RapidConnect only)
BALANCE: request account balance on an EBT/Debit card (Elavon only).
CANCEL: removes a refund request on a credit card or debit/ebt. Requires the
refund token_id (RapidConnect only)
|
|
transactionAmount
|
Yes
|
Decimal
|
This is the dollar (or other currency) amount of the transaction. Only numbers and a single decimal are allowed. Commas are not allowed.
The maximum amount is 999999.99. That is 1 cent less than 1 million. This is because the decimal is counted in
the max size. Values with no decimal and no cents are allowed. Values with
only a single number after the decimal are allowed and will be assumed to have a trailing 0.
|
|
transactionDescription
|
No
|
65k char
|
A description of the payment. This is an open field. If emails are sent to the customer or merchant, this will show in the “Description:” field. You may use this to send any information that you wish. It can store up to 65,000 characters.
|
|
firstName
|
No
|
50 char
|
The first name of the cardholder
as it appears on the front of the card.
|
|
lastName
|
No
|
50 char
|
The last name of the cardholder
as it appears on the front of the card.
|
|
streetAddress1
|
No
|
100 char
|
Street address of the cardholder or bank account holder
|
|
city
|
No
|
100 char
|
The city portion of the cardholder or account holder address. This is not sent to the processor. It is only stored for your reporting purposes.
|
|
state
|
No
|
2 char
|
The two digit state code of the
cardholder or account holder address. This is not sent to the processor. It is only stored for your reporting purposes.
|
|
zip
|
No
|
10 char
|
The 5 digit format or 5+4 formatted zip code of the cardholder or accountholder. For example, 12345 or 12345-1234. Only numbers and a hyphen are allowed.
|
|
phone
|
No
|
20 char
|
The phone number of the cardholder/account holder. It does not expect any specific format, is not sent to the processor, and is stored only for your reporting use.
|
Secure Inputs
|
Input Fields
|
Required
|
Character Limits/Required Input
|
Description
|
|
cardNumber
|
Yes
|
19 chars
|
Secure input of the card number
|
|
cardExpiration
|
Yes
|
3 or 4 chars
|
Secure input of the card CVV, either three or four digits long depending on the card
|
|
cardVerification
|
Yes
|
4 chars
|
Secure input of the card expiry - in the format MMYY
|
Outputs
|
Output Fields
|
Description
|
|
error
|
Boolean value indicating if there was an error with the transaction or not.
|
|
keyed
|
True for keyed transaction
|
|
last4
|
The last four digits of the card number or Primary Account Number (PAN).
|
|
swiped
|
Boolean value. True for swiped transaction.
|
|
currencyOut
|
The currency for the transaction.
|
|
errorMsg
|
Deprecated (Legacy), same as errorMessage
|
|
cardBrand
|
VISA, MASTERCARD, AMERICAN EXPRESS, DISCOVER, ACH, EBT
|
|
entryMode
|
Indicates the mode of entry of the
transaction. Can be used instead of keyed
and swipe variables with responses of:
Keyed
Swiped
EMV
Contactless
Fallback Swiped
NFC
|
|
errorCode
|
0 for no error, > 0 for error number
|
|
tenderTypeOut
|
This will be the same as the tender_type provided in the request. It is provided for reference purposes.
|
|
errorMessage
|
DECLINED or textual description of other API Errors (e.g., “Must send card_number” or “Invalid bank_account_number”).
|
|
requestAmount
|
Used only in partial auth. Indicates the amount of money that the merchant attempted to authorize the card for.
|
|
transactionId
|
The transaction id for the new transaction. When using tokenization, this is the transaction_id that you submit as the token_id
|
|
cardExpirationOut
|
The month and year of the card expiration date in the format MMYY. For example, 0115 for January 2015
|
|
transactionTypeOut
|
This is the transaction_type of the original transaction.
|
|
authorizationCode
|
This is the auth code returned by the processor.
|
|
transactionAmountOut
|
The same variable submitted in the request. If a partial auth is valid, this represents the actual amount authorized
|
|
transactionApproved
|
Boolean value indicating if the transaction was approved. True for approved.
|
|
authorizationMessage
|
APPROVED or the auth message from the processor (e.g. AUTH DECLINED 200).
|
|
transactionTimestamp
|
This is the timestamp of the newly created transaction.
|
Please email support@pcipal.com for a copy of the Vantiv documentation.