Credit Card Method
CreditCardSale
Description:
This method performs both authorization and settlement into one operation.
-
Request
-
Response
-
Samples
Fieldname | Required | Type | Description | Validate | Xpath |
|---|---|---|---|---|---|
TransactionType | String | Transaction type to process. (“CreditCardCharge”) | CreditCardCharge | TranzPayRequest.TransactionType | |
ProducerID | Number | TranzPay producerID assigned to your merchant account. | Integer supplied by TranzPay | TranzPayRequest.ProducerID | |
UserName | String | TranzPay Username | Username supplied by TranzPay | TranzPayRequest.UserName | |
Password | String | TranzPay password. | Password supplied by TranzPay | TranzPayRequest.Password | |
TransactionAmount | Number | Amount of transaction in decimal format (ie. 99.99) | Decimal number greater than zero | TranzPayRequest.TransactionAmount | |
CardNumber | Number | Full credit card number | 16 digit (15 amex) | TranzPayRequest.CardNumber | |
ExpirationDateMMYY | Number | 2 digit month and 2 digit year | 0116 for Jan 2016 | TranzPayRequest.ExpirationDateMMYY | |
CVV2 | Number | 3 digit security code (4 digit amex) | Numeric only | TranzPayRequest.CVV2 | |
Description | String | Description of the payment transaction. | Any alphanumeric | TranzPayRequest.Description | |
BillingNameFirst | String | Card Holder First Name | Alpha character name | TranzPayRequest.BillingNameFirst | |
BillingNameLast | String | Card Holder Last Name/td> | Alpha character name | TranzPayRequest.BillingNameLast | |
BillingFullName | String | Full Business Name | Alpha character name | TranzPayRequest.BillingFullName | |
BillingAddress | String | Billing street address for credit card. | Any alphanumeric | TranzPayRequest.BillingAddress | |
BillingCity | String | Billing city for credit card. | Any alphanumeric | TranzPayRequest.BillingCity | |
BillingState | String | Billing state for credit card. | Any alphanumeric | TranzPayRequest.BillingState | |
BillingZipCode | String | Billing zip code for credit card. | 5 digit zip code | TranzPayRequest.BillingZipCode | |
PhoneNumber | String | Phone number of account. | 10 digit phone number | TranzPayRequest.PhoneNumber | |
String | Account Holder Email | Any alphanumeric | TranzPayRequest.Email | ||
PolicyNumber | String | Custom Policy or Account Number | Any alphanumeric | TranzPayRequest.PolicyNumber |
Fieldname | Description | Validate | Xpath | Note |
|---|---|---|---|---|
ProducerID | TranzPay producerID assigned to your merchant account. | Integer supplied by TranzPay | TranzPayResponse.ProducerID | Cell |
ProducerID | TranzPay producerID assigned to your merchant account. | Integer supplied by TranzPay | TranzPayResponse.ProducerID | Cell |
GatewayConnect | Connection to gateway was established | “Y” or “N” | TranzPayResponse.GatewayConnect | Cell |
PostedDate | Transaction date | Date/time formatted string | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
TransactionID | Merchant gateway returned unique transactionID | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
TransactionAmount | Amount of transaction in decimal format (ie. 99.99) | Decimal number greater than zero | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
AuthorizationCode | Merchant gateway authorization code | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
ResponseCode | Merchant gateway response code | “00” for successful transaction | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
ResponseMessage | Merchant gateway response message | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
CVV2ResponseCode | Merchant gateway cvv2 response code | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
CVV2ResponseMessage | Merchant gateway cvv2 response message | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
AVSResponseCode | Merchant gateway AVS response code | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
AVSResponseMessage | Merchant gateway AVS response message | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
CustomerName | Card holder full name = BillingFullName | Alpha character name | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
BillingNameFirstCard Holder First Name | Card Holder First Name | Alpha character name | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
BillingNameLast | Card Holder Last Name | Alpha character name | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
BillingAddress | Billing street address for credit card | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
BillingCity | Billing city for credit card | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
BillingState | Billing state for credit card | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
BillingZipCode | Billing zip code for credit card | 5 digit zip code | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
BillingEmail | Account Holder Email | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
Code | Validation Error Code | “V1001” | TranzPayResponse.Error.Code | Present if GatewayConnect = “N” |
Msg | Validation Error Message | Alpha character error msg | TranzPayResponse.Error.Msg | Present if GatewayConnect = “N” |
-
xML
-
JSON
<TranzPayRequest> <TransactionType>CreditCardCharge</TransactionType> <UserName>testprod</UserName> <Password>test</Password> <ProducerID>2</ProducerID> <CardNumber>4111111111111111</CardNumber> <ExpirationDateMMYY>1219</ExpirationDateMMYY> <CVV2>123</CVV2> <Description>Insurance Payment</Description> <TransactionAmount>37.99</TransactionAmount> <BillingNameFirst>Raymond</BillingNameFirst> <BillingNameLast>Henderson</BillingNameLast> <BillingAddress>399 Main St</BillingAddress> <BillingCity>Atlanta</BillingCity> <BillingState>GA</BillingState> <BillingZipCode>30505</BillingZipCode> <PhoneNumber>1231231234</PhoneNumber> <Email>[email protected]</Email> <PolicyNumber>PN42983297</PolicyNumber> <CustomField1>Sara Henderson</CustomField1> <CustomField2>Nissan Sentra</CustomField2> <CustomField3>986654332FRT566</CustomField3> <CustomField4>92677</CustomField4> </TranzPayRequest>
{
"TransactionType": "CreditCardCharge",
"UserName": "{{USERNAME}}",
"Password": "{{API_PASSWORD}}",
"ProducerID": "{{PRODUCERID}}",
"CardNumber": "4747474747474747",
"ExpirationDateMMYY": "1222",
"CVV2": "111",
"Description": "Insurance",
"TransactionAmount": "101",
"BillingNameFirst": "Sam",
"BillingNameLast": "Harper",
"BillingAddress": "123 Main St",
"BillingCity": "Atlanta",
"BillingState": "GA",
"BillingZipCode": "30505",
"PhoneNumber": "5558885555",
"Email": "[email protected]",
"PolicyNumber": "123456789",
"CustomField1": "",
"Language":"",
"Format":"JSON"
}
CreditCardAuthorization
Description:
This method authorizes a credit card transaction by requesting an authorization number from the card issuer. An approved authorization means that the transaction dollar amount has been reserved for usage but not yet deducted from the cardholder’s account. Funds are not settled (transferred to the merchant) until the CreditCardSettle() method is called using the authorization number returned by this method.
-
Request
-
Response
-
Samples
Fieldname | Required | Type | Description | Validate | Xpath |
|---|---|---|---|---|---|
TransactionType | String | Transaction type to process. (“CreditCardAuthorization”) | CreditCardAuthorizatio | TranzPayRequest.TransactionType | |
ProducerID | Number | TranzPay producerID assigned to your merchant account. | Integer supplied by TranzPay | TranzPayRequest.ProducerID | |
UserName | String | TranzPay username. | Username supplied by TranzPay | TranzPayRequest.UserName | |
Password | String | TranzPay password. | Password supplied by TranzPay | TranzPayRequest.Password | |
TransactionAmount | Number | Transaction amount in decimal format (ie. 99.99) | Decimal number greater than zero | TranzPayRequest.TransactionAmount | |
CardNumber | Number | Full credit card number | 16 digit (15 amex) | TranzPayRequest.CardNumber | |
ExpirationDateMMYY | Number | 2 digit month and 2 digit year | 0116 for Jan 2016 | TranzPayRequest.ExpirationDateMMYY | |
CVV2 | Number | 3 digit security code (4 digit amex) | Numeric only | TranzPayRequest.CVV2 | |
Description | String | Desription of the payment transaction. | Any alphanumeric | TranzPayRequest.Description | |
BillingNameFirst | String | Card Holder First NameAlpha character name | Alpha character name | TranzPayRequest.BillingNameFirst | |
BillingNameLast | String | Card Holder Last Name | Alpha character name | TranzPayRequest.BillingNameLast | |
BillingFullName | String | Full Business name | Alpha character name | TranzPayRequest.BillingFullName | |
BillingAddress | String | Billing street address for credit card | Any alphanumeric | TranzPayRequest.BillingAddress | |
BillingCity | String | Billing city for credit card | Any alphanumeric | TranzPayRequest.BillingCity | |
BillingState | String | Billing state for credit card | Any alphanumeric | TranzPayRequest.BillingState | |
BillingZipCode | String | Billing zip code for credit card | 5 digit zip code | TranzPayRequest.BillingZipCode | |
PhoneNumber | String | Phone number of account. | 10 digit phone number | TranzPayRequest.PhoneNumber | |
String | Account Holder Email | Any alphanumeric | TranzPayRequest.Email | ||
ReferenceNumber | Number | User supplied ReferenceNumber | Numeric id returned by TranzPay | TranzPayRequest.ReferenceNumber | |
PolicyNumber | String | Custom Policy or Account Number | Any alphanumeric | TranzPayRequest.PolicyNumber |
Fieldname | Description | Validate | Xpath | Note |
|---|---|---|---|---|
ProducerID | TranzPay producerID assigned to your merchant account. | Integer supplied by TranzPay | TranzPayResponse.ProducerID | Cell |
GatewayConnect | Connection to gateway was established | “Y” or “N” | TranzPayResponse.GatewayConnect | Cell |
PostedDate | Transaction date | Date/time formatted string | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
TransactionID | Merchant gateway returned unique transactionID | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
ReferenceNumber | User supplied ReferenceNumber | Numeric id returned by TranzPay | TranzPayResponse.ReferenceNumber | Cell |
TransactionAmount | Transaction amount in decimal format (ie. 99.99) | Decimal number greater than zero | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
AuthorizationCode | Merchant gateway authorization code | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
ResponseCode | Merchant gateway response code | “00” for successful transaction | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
ResponseMessage | Merchant gateway response message | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
CVV2ResponseCode | Merchant gateway cvv2 response code | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
CVV2ResponseMessage | Merchant gateway cvv2 response message | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
AVSResponseCode | Merchant gateway AVS response code | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
AVSResponseMessage | Merchant gateway AVS response message | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
CustomerName | Card holder full name = BillingFullName | Alpha character name | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
BillingNameFirst | Card Holder First Name | Alpha character name | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
BillingNameLast | Card Holder Last Name | Alpha character name | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
BillingAddress | Billing street address for credit card | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
BillingCity | Billing city for credit card | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
BillingState | Billing state for credit card | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
BillingZipCode | Billing zip code for credit card | 5 digit zip code | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
BillingEmail | Account Holder Email | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
Code | Validation Error Code | “V1001” | TranzPayResponse.Error.Code | Present if GatewayConnect = “N” |
Msg | Validation Error Message | Alpha character error msg | TranzPayResponse.Error.Msg | Present if GatewayConnect = “N” |
-
xML
-
JSON
<TranzPayRequest> <TransactionType>CreditCardAuthorization</TransactionType> <UserName>testprod</UserName> <Password>test</Password> <ProducerID>2</ProducerID> <CardNumber>4111111111111111</CardNumber> <ExpirationDateMMYY>1219</ExpirationDateMMYY> <CVV2>123</CVV2> <Description>Insurance Payment</Description> <TransactionAmount>37.99</TransactionAmount> <BillingNameFirst>Raymond</BillingNameFirst> <BillingNameLast>Henderson</BillingNameLast> <BillingAddress>399 Main St</BillingAddress> <BillingCity>Atlanta</BillingCity> <BillingState>GA</BillingState> <BillingZipCode>30505</BillingZipCode> <PhoneNumber>1231231234</PhoneNumber> <Email>[email protected]</Email> <ReferenceNumber>1896163851</ReferenceNumber> <PolicyNumber>PN23649876</PolicyNumber> </TranzPayRequest>
{
"TransactionType": "CreditCardAuthorization",
"UserName": "{{USERNAME}}",
"Password": "{{API_PASSWORD}}",
"ProducerID": "{{PRODUCERID}}",
"CardNumber": 4111111111111111,
"ExpirationDateMMYY": 1222,
"CVV2": 123,
"Description": "Insurance Payment",
"TransactionAmount": 105,
"BillingNameFirst": "Gary",
"BillingNameLast": "Postman",
"BillingAddress": "202 Tomas",
"BillingCity": "Rancho Santa Margarita",
"BillingState": "CA",
"BillingZipCode": 92688,
"ReferenceNumber": 1216988,
"Email": "[email protected]",
"Format": "JSON"
}
CreditCardSettle
Description:
This method captures (transfers to the merchant) a transaction previously authorized with the Authorize() method. Captured transactions are scheduled for settlement at the determined batch time.
-
Request
-
Response
-
Samples
Fieldname | Required | Type | Description | Validate | Xpath |
|---|---|---|---|---|---|
TransactionType | String | Transaction type to process. (“CreditCardSettle”) | CreditCardSettle | TranzPayRequest.TransactionType | |
ProducerID | Number | TranzPay producerID assigned to your merchant account. | Integer supplied by TranzPay | TranzPayRequest.ProducerID | |
UserName | String | TranzPay username. | Username supplied by TranzPay | TranzPayRequest.UserName | |
Password | String | TranzPay password. | Password supplied by TranzPay | TranzPayRequest.Password | |
TransactionID | Number | TransactionID returned by PreAuthorization command | Numeric id returned by TranzPay | TranzPayRequest.TransactionID | |
ReferenceNumber | Number | User supplied ReferenceNumber | Numeric id returned by TranzPay | TranzPayRequest.ReferenceNumber | |
TransactionAmount | Number | Transaction amount in decimal format (ie. 99.99) | Decimal number greater than zero | TranzPayRequest.TransactionAmount |
Fieldname | Description | Validate | Xpath | Note |
|---|---|---|---|---|
ProducerID | TranzPay producerID assigned to your merchant account. | Integer supplied by TranzPay | TranzPayResponse.ProducerID | Cell |
GatewayConnect | Connection to gateway was established | “Y” or “N” | TranzPayResponse.GatewayConnect | Cell |
PostedDate | Transaction date | Date/time formatted string | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
TransactionID | Merchant gateway returned unique transactionID | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
ReferenceNumber | User supplied ReferenceNumber | Numeric id returned by TranzPay | TranzPayResponse.ReferenceNumber | Cell |
TransactionAmount | Amount of transaction in decimal format (ie. 99.99) | Decimal number greater than zero | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
AuthorizationCode | Merchant gateway authorization code | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
ResponseCode | Merchant gateway response code | “00” for successful transaction | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
ResponseMessage | Merchant gateway response message | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
CVV2ResponseCode | Merchant gateway cvv2 response code | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
CVV2ResponseMessage | Merchant gateway cvv2 response message | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
AVSResponseCode | Merchant gateway AVS response code | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
AVSResponseMessage | Merchant gateway AVS response message | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
CustomerName | Card holder full name | Alpha character name | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
BillingNameFirst | Card Holder First Name | Alpha character name | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
BillingNameLast | Card Holder Last Name | Alpha character name | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
BillingAddress | Billing street address for credit card | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
BillingCity | Billing city for credit card | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
BillingState | Billing state for credit cardAny alphanumeric | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
BillingZipCode | Billing zip code for credit card | 5 digit zip code | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
BillingEmail | Account Holder Email | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
-
xML
-
JSON
<TranzPayRequest> <TransactionType>CreditCardSettle</TransactionType> <UserName>testprod</UserName> <Password>test</Password> <ProducerID>2</ProducerID> <TransactionID>99889988</TransactionID> <TransactionAmount>37.99</TransactionAmount> <ReferenceNumber>1896163851</ReferenceNumber> </TranzPayRequest>
{
"TransactionType": "CreditCardSettle",
"UserName": "{{USERNAME}}",
"Password": "{{API_PASSWORD}}",
"ProducerID": "{{PRODUCERID}}",
"ReferenceNumber": 1216988,
"TransactionID": 213303536,
"TransactionAmount": 108.67,
"Format": "JSON"
}
CreditCardVoid
Description:
This method cancels a previously completed Authorization or Charge transaction. A transaction that has already been settled using the CreditCardSettle() method cannot be voided, but instead perform a Credit on the account.
-
Request
-
Response
-
Samples
Fieldname | Required | Type | Description | Validate | Xpath |
|---|---|---|---|---|---|
TransactionType | String | Transaction type to process. (“CreditCardVoid”) | CreditCardVoid | TranzPayRequest.TransactionType | |
ProducerID | Number | TranzPay producerID assigned to your merchant account. | Integer supplied by TranzPay | TranzPayRequest.ProducerID | |
UserName | String | TranzPay username. | Username supplied by TranzPay | TranzPayRequest.UserName | |
Password | String | TranzPay password. | Password supplied by TranzPay | TranzPayRequest.Password | |
TransactionID | Number | TransactionID returned by PreAuthorization command | Numeric id returned by TranzPay | TranzPayRequest.TransactionID |
Fieldname | Description | Validate | Xpath | Note |
|---|---|---|---|---|
ProducerID | TranzPay producerID assigned to your merchant account. | Integer supplied by TranzPay | TranzPayResponse.ProducerID | Cell |
GatewayConnect | Connection to gateway was established | “Y” or “N” |