|
Wirecard Payment Gateway
This page details the inputs, secure inputs and outputs available for the Wirecard Payment Gateway, how to complete each field, and an external link to the Wirecard 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
|
|
merchant-account-id
|
Yes
|
36 char
|
Merchant account ID
|
|
request-id
|
Yes
|
n/a
|
ID for the request
|
|
entry-mode
|
Yes
|
n/a
|
Indicates the type of payment. "telephone-order" for MOTO
|
|
transaction-type
|
Yes
|
n/a
|
The type of transaction
|
|
transaction-state
|
Yes
|
|
Determines a transaction’s behavior during transaction processing and merchant settlement. Examples are: authorization, capture, credit, purchase, refund, void authorization, void capture, void credit, void purchase.
|
|
value
|
Yes
|
18 float
|
The only amount that accompanies the transaction when it is created and/or requested. In the case of a sale or refund, this is what the merchant requests. In the case of a chargeback, this is the amount that is being contested.
|
|
currency
|
Yes
|
3 char
|
This is the currency in which a transaction is received and processed.
|
|
firstName
|
No
|
32 char
|
The first name of the account holder.
|
|
lastName
|
Yes
|
32 char
|
The last name of the account holder.
|
|
email
|
No
|
64 char
|
The email address of the account holder.
|
|
phone
|
No
|
32 char
|
The phone number of the account holder.
|
|
addressStreet1
|
No
|
128 char
|
The first line of the street address of the account holder.
|
|
addressStreet2
|
No
|
128 char
|
The second line of the street address of the account holder.
|
|
addressCity
|
No
|
32 char
|
The city of the address of the account holder.
|
|
addressState
|
No
|
32 char
|
The state or province of the address of the account holder.
|
|
addressCountry
|
No
|
3 char
|
The Country Id of the address of the account holder.
|
|
cardType
|
Yes
|
15 char
|
A card scheme accepted by the processing system. This includes physically issued cards.
|
|
payment-method
|
|
256 char
|
The name of the payment method.
|
|
order-number
|
No
|
64 char
|
Merchant-provided string to store the 'Order Number' for the transaction.
|
|
order-detail
|
No
|
2048 char
|
Merchant-provided string to store the 'Order Detail' for the transaction.
|
|
descriptor
|
No
|
64 char
|
The description of the transaction that shows up on the account holder’s statement. In the case of a credit card statement, it can be dynamically set per Transaction. This is only supported by some acquirers.
|
|
gender
|
No
|
1 char (M or F)
|
The gender of the account holder.
|
|
date-of-birth
|
No
|
N/A
|
The date of birth of the account holder.
|
Secure Inputs
|
Input Fields
|
Required
|
Character Limits/Required Input
|
Description
|
|
account-number
|
Yes
|
36 char
|
The embossed or encoded number that identifies the card issuer to which a transaction is to be routed and the account to which it is to be charged unless specific instructions indicate otherwise. In the case of a credit card, this is the primary account number.
|
|
expiry-month
|
Yes
|
2 char (MM)
|
The 2-digit representation of the expiration month of the account-number
|
|
expiry-year
|
Yes
|
4 char (YYYY)
|
The 4-digit representation of the expiration year of the account-number
|
|
card-security-code
|
Yes
|
4 char
|
A security feature for credit or debit card transactions, providing increased protection against credit card or debit Card fraud. The card security code is located on the back of MasterCard, Visa and Discover credit or debit cards and is typically a separate group of 3 digits to the right of the signature strip. On American Express cards, the card security code is a printed, not embossed, group of four digits on the front towards the right.
|
Outputs
|
Output Fields
|
Description
|
|
merchant-account-id-out
|
Merchant account ID
|
|
transaction-id-out
|
A unique identifier assigned for every transaction.
|
|
request-id-out
|
ID for the request
|
|
transaction-state-out
|
The current status of a transaction. Typically, a transaction will start from an "in-progress" state, and then finish in either the "success" or "failed" state. This information is returned in the response only.
|
|
completion-time-stamp-out
|
The date and time that a transaction state became either "success" or "failed" in GMT.
|
|
requested-amount-value
|
The transaction amount, as sent in the request
|
|
requested-amount-currency
|
This is the currency in which a transaction is received and processed.
|
|
account-holder-first-name
|
The first name of the account holder.
|
|
account-holder-last-name
|
The last name of the account holder.
|
|
account-holder-email
|
The email address of the account holder.
|
|
account-holder-phone
|
The phone number of the account holder.
|
|
account-holder-address-street1
|
The first line of the street address of the account holder.
|
|
account-holder-address-street2
|
The second line of the street address of the account holder.
|
|
account-holder-address-city
|
The city of the address of the account holder.
|
|
account-holder-address-state
|
The state or province of the address of the account holder.
|
|
account-holder-address-country
|
The Country Id of the address of the account holder.
|
|
account-holder-card-token-id
|
A unique identifier assigned for every card token. This is a surrogate value for the primary account number.
|
|
account-holder-card-token-masked-account-number
|
The masked account number. This information is returned in the response only.
|
|
order-detail-out
|
Merchant-provided string to store the 'Order Detail' for the transaction.
|
|
code
|
The status of a transaction. This is primarily used in conjunction with the transaction state to determine the exact details of the status of the transaction. This information is returned in the response only.
|
|
description
|
Text used to describe the transaction status. This information is returned in the response only.
|
|
provider-account-id
|
|
|
csc-code
|
Card CVV as sent in the request
|
Further information can be found by viewing the integration documentation: