Customer Vault
This section describes integration requirements for storing customer details in our PCI secure Customer Vault and calling on the Customer Vault to process transactions utilizing stored account information.
Add Customer
Description:
Use this function to add a new customer record. Below are the parameters for this method.
-
Request
-
Response
-
Samples
Fieldname | Required | Type | Description | Validate | Xpath |
|---|---|---|---|---|---|
CustomerID | String | Unique Customer Identifier, min of 6 characters, supplied by Merchant. | String Unique | TranzPayRequest.CustomerID | |
TransactionType | String | Transaction type to process. (“AddCustomer”) | AddCustomer | 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 | |
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 | |
BankRoutingNumber | Number | 9 digit Bank Routing Number | Numeric only | TranzPayRequest.BankRoutingNumber | |
BankAccountNumber | Number | 4 to 17 digit Bank Account Number | Numeric only | TranzPayRequest.BankAccountNumber | |
BankAccountType | String | Bank Account to Charge | “CK” = Checking | TranzPayRequest.BankAccountType | |
BillingNameFirst | String | Account Holder First Name | Alpha character name | TranzPayRequest.BillingNameFirst | |
BillingNameLast | String | Account Holder Last Name | Alpha character name | TranzPayRequest.BillingNameLast | |
BillingFullName | String | Full Business NameAlpha character 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 | |
String | Account holder email | Any alphanumeric | TranzPayRequest.Email |
Fieldname | Description | Validate | Xpath |
|---|---|---|---|
CustomerID | Previously Created CustomerID | String Unique | TranzPayResponse.CustomerID |
ProducerID | TranzPay producerID assigned to your merchant account. | Integer supplied by TranzPay | TranzPayResponse.ProducerID |
GatewayConnect | Connection to gateway was established | “Y” or “N” | TranzPayResponse.GatewayConnect |
PostedDate | Transaction date | Date/time formatted string | TranzPayResponse.Transaction. |
Status | Merchant gateway status response message | “APPROVED” or “CANCEL” | TranzPayResponse.Transaction. |
CustomerName | Card holder full name | Alpha character name | TranzPayResponse.Transaction. |
BillingNameFirst | Account holder first name | Alpha character name | TranzPayResponse.Transaction. |
BillingNameLast | Account holder last name | Alpha character name | TranzPayResponse.Transaction. |
BillingAddress | Billing street address for credit card | Any alphanumeric | TranzPayResponse.Transaction. |
BillingCity | Billing city for credit card | Any alphanumeric | TranzPayResponse.Transaction. |
BillingState | Billing state for credit card | Any alphanumeric | TranzPayResponse.Transaction. |
BillingZipCode | Billing zip code for credit card | 5 digit zip code | TranzPayResponse.Transaction. |
BillingEmail | Account holder email | Any alphanumeric | TranzPayResponse.Transaction. |
Msg | Validation Error Message | Alpha character error msg | TranzPayResponse.Error.Msg |
-
xML
-
JSON
<TranzPayRequest> <TransactionType>AddCustomer</TransactionType> <CustomerID>TranzPay_0151638</CustomerID> <ProducerID>1</ProducerID> <UserName>testprod</UserName> <Password>test</Password> <CardNumber>4111111111111111</CardNumber> <ExpirationDateMMYY>0321</ExpirationDateMMYY> <BankRoutingNumber>325070760</BankRoutingNumber> <BankAccountNumber>1234567890</BankAccountNumber> <BankAccountType>CK</BankAccountType> <BillingNameFirst>Raymond</BillingNameFirst> <BillingNameLast>Henderson</BillingNameLast> <BillingAddress>399 Main St</BillingAddress> <BillingCity>Atlanta</BillingCity> <BillingState>GA</BillingState> <BillingZipCode>30505</BillingZipCode> <Email>cus[email protected]</Email> </TranzPayRequest>
{
"CustomerID": "Jocelyn59TF",
"TransactionType": "AddCustomer",
"UserName": "{{USERNAME}}",
"Password": "{{API_PASSWORD}}",
"ProducerID": "{{PRODUCERID}}",
"CardNumber": "4747474747474747",
"ExpirationDateMMYY": "1224",
"BankRoutingNumber": "121042882",
"BankAccountNumber": "24853692",
"BankAccountType": "CK",
"BillingFullName": "Jocelyn Duncan",
"BillingNameFirst": "Jocelyn",
"BillingNameLast": "Duncan",
"BillingAddress": "399 Main St",
"BillingCity": "Atlanta",
"BillingState": "GA",
"BillingZipCode": "30505",
"PhoneNumber": "8885551212",
"Email": "[email protected]",
"Format":"JSON"
}
UpdateCustomer
Description:
Use this function to update a new customer record. Below are the parameters for this method. Pass only the parameters you wish to update.
-
Request
-
Response
-
Samples
Fieldname | Required | Type | Description | Validate | Xpath |
|---|---|---|---|---|---|
CustomerID | String | CustomerID of previously added customer. | String Unique | TranzPayRequest.CustomerID | |
TransactionType | String | Transaction type to process. (“UpdateCustomer”) | UpdateCustomer | 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 | |
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 | |
BankRoutingNumber | Number | 9 digit Bank Routing Number | Numeric only | TranzPayRequest.BankRoutingNumber | |
BankAccountNumber | Number | 4 to 17 digit Bank Account Number | Numeric only | TranzPayRequest.BankAccountNumber | |
BankAccountType | String | Bank Account to Charge | “CK” = Checking | TranzPayRequest.BankAccountType | |
BillingNameFirst | String | Account Holder First Name | Alpha character name | TranzPayRequest.BillingNameFirst | |
BillingNameLast | String | Account 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 | |
String | Account holder email | Any alphanumeric | TranzPayRequest.Email |
Fieldname | Description | Validate | Xpath |
|---|---|---|---|
CustomerID | Previously Created Customer ID | String Unique | TranzPayResponse.CustomerID |
ProducerID | TranzPay producerID assigned to your merchant account. | Integer supplied by TranzPay | TranzPayResponse.ProducerID |
GatewayConnect | Connection to gateway was established | “Y” or “N” | TranzPayResponse.GatewayConnect |
PostedDate | Transaction date | Date/time formatted string | TranzPayResponse.Transaction. |
Status | Merchant gateway status response message | Any alphanumeric | TranzPayResponse.Transaction. |
CustomerName | Account holder full name | Alpha character name | TranzPayResponse.Transaction. |
BillingNameFirst | Account holder first name | Alpha character name | TranzPayResponse.Transaction. |
BillingNameLast | Account holder last name | Alpha character name | TranzPayResponse.Transaction. |
BillingAddress | Billing street address for credit card | Any alphanumeric | TranzPayResponse.Transaction. |
BillingCity | Billing city for credit card | Any alphanumeric | TranzPayResponse.Transaction. |
BillingState | Billing state for credit card | Any alphanumeric | TranzPayResponse.Transaction. |
BillingZipCode | Billing zip code for credit card | 5 digit zip code | TranzPayResponse.Transaction. |
BillingEmail | Account holder email | Any alphanumeric | TranzPayResponse.Transaction. |
Msg | Validation Error Message | Alpha character error msg | TranzPayResponse.Error.Msg |
-
xML
-
JSON
<TranzPayRequest> <TransactionType>UpdateCustomer</TransactionType> <CustomerID>TranzPay_0151638</CustomerID> <ProducerID>1</ProducerID> <UserName>testprod</UserName> <Password>test</Password> <CardNumber>4111111111111111</CardNumber> <ExpirationDateMMYY>0321</ExpirationDateMMYY> <BankRoutingNumber>325070760</BankRoutingNumber> <BankAccountNumber>1234567890</BankAccountNumber> <BankAccountType>CK</BankAccountType> <BillingNameFirst>Raymond</BillingNameFirst> <BillingNameLast>Henderson</BillingNameLast> <BillingAddress>399 Main St</BillingAddress> <BillingCity>Atlanta</BillingCity> <BillingState>GA</BillingState> <BillingZipCode>30505</BillingZipCode> <Email>cus[email protected]</Email> </TranzPayRequest>
{
"TransactionType": "UpdateCustomer",
"UserName": "{{USERNAME}}",
"Password": "{{API_PASSWORD}}",
"ProducerID": "{{PRODUCERID}}",
"CustomerID": "385PPOYTT",
"CardNumber": "4747474747474747",
"ExpirationDateMMYY": "0721",
"BankRoutingNumber": "325070760",
"BankAccountNumber": "1234567890",
"BankAccountType": "CK",
"BillingFullName": "Tara Duncan",
"BillingAddress": "399 Main St",
"BillingCity": "Atlanta",
"BillingState": "GA",
"BillingZipCode": "30505",
"Email": "[email protected]",
"PolicyNumber": "XYZ11111",
"PhoneNumber": "8885551212",
"Format":"JSON"
}
GetCustomer
Description:
Use this method to retrieve a Customer record from the Customer Vault Database.
-
Request
-
Response
-
Samples
Fieldname | Required | Type | Description | Validate | Xpath |
|---|---|---|---|---|---|
CustomerID | String | CustomerID of previously created customer. | String Unique | TranzPayRequest.CustomerID | |
TransactionType | String | Transaction type to process. (“GetCustomer”) | GetCustomer | 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 |
Fieldname | Description | Validate | Xpath |
|---|---|---|---|
CustomerID | Previously Created CustomerID | String Unique | TranzPayResponse.CustomerID |
ProducerID | TranzPay producerID assigned to your merchant account. | Integer supplied by TranzPay | TranzPayResponse.ProducerID |
GatewayConnect | Connection to gateway was established | “Y” or “N” | TranzPayResponse.GatewayConnect |
PostedDate | Transaction date | Date/time formatted string | TranzPayResponse.Transaction. |
Status | Merchant gateway status response message | Any alphanumeric | TranzPayResponse.Transaction. |
CustomerName | Account holder full name | Alpha character name | TranzPayResponse.Transaction. |
BillingNameFirst | Account holder first name | Alpha character name | TranzPayResponse.Transaction. |
BillingNameLast | Account holder last name | Alpha character name | TranzPayResponse.Transaction. |
BillingAddress | Billing street address for credit card | Any alphanumeric | TranzPayResponse.Transaction. |
BillingCity | Billing city for credit card | Any alphanumeric | TranzPayResponse.Transaction. |
BillingState | Billing state for credit card | Any alphanumeric | TranzPayResponse.Transaction. |
BillingZipCode | Billing zip code for credit card | 5 digit zip code | TranzPayResponse.Transaction. |
BillingEmail | Account holder email | Any alphanumeric | TranzPayResponse.Transaction. |
Msg | Validation Error Message | Alpha character error msg | TranzPayResponse.Error.Msg |
-
xML
-
JSON
<TranzPayRequest> <TransactionType>GetCustomer</TransactionType> <ProducerID>1</ProducerID> <UserName>testprod</UserName> <Password>test</Password> <CustomerID>TranzPay_0151638</CustomerID> </TranzPayRequest>
{
"TransactionType": "GetCustomer",
"UserName": "{{USERNAME}}",
"Password": "{{API_PASSWORD}}",
"ProducerID": "{{PRODUCERID}}",
"CustomerID":"JYW89REW7",
"Format": "JSON"
}
AddCustomerCCCharge
Description:
This method creates a credit card charge transaction from a customer record.
-
Request
-
Response
-
Samples
Fieldname | Required | Type | Description | Validate | Xpath |
|---|---|---|---|---|---|
TransactionType | String | Transaction type to process. (“AddCustomerCCCharge”) | AddCustomerCCCharge | 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 | |
CustomerID | String | CustomerID of previously created customer. | String Unique | TranzPayRequest.CustomerID | |
TransactionAmount | Number | Amount of transaction in decimal format (ie. 99.99) | Decimal number greater than zero | TranzPayRequest.TransactionAmount | |
CVV2 | Number | 3 digit security code (4 digit amex) | Numeric only | TranzPayRequest.CVV2 | |
PolicyNumber | String | Custom Policy or Account Number | Any alphanumeric | TranzPayRequest.PolicyNumber |
Fieldname | Description | Validate | Xpath |
|---|---|---|---|
CustomerID | Previously Created Customer ID used for this Credit Card Transaction. | String Unique | TranzPayResponse.CustomerID |
ProducerID | TranzPay producerID assigned to your merchant account. | Integer supplied by TranzPay | TranzPayResponse.ProducerID |
GatewayConnect | Connection to gateway was established | “Y” or “N” | TranzPayResponse.GatewayConnect |
PostedDate | Transaction date | Date/time formatted string | TranzPayResponse.Transaction. |
TransactionID | Merchant gateway returned unique transactionID | Any alphanumeric | TranzPayResponse.Transaction. |
TransactionAmount | Amount of transaction in decimal format (ie. 99.99) | Decimal number greater than zero | TranzPayResponse.Transaction. |
AuthorizationCode | Merchant gateway authorization code | Any alphanumeric | TranzPayResponse.Transaction. |
ResponseCode | Merchant gateway response code | “00” for successful transaction | TranzPayResponse.Transaction. |
ResponseMessage | Merchant gateway response message | Any alphanumeric | TranzPayResponse.Transaction. |
CVV2ResponseCode | Merchant gateway cvv2 response code | Any alphanumeric | TranzPayResponse.Transaction. |
CVV2ResponseMessage | Merchant gateway cvv2 response message | Any alphanumeric | TranzPayResponse.Transaction. |
AVSResponseCode | Merchant gateway AVS response code | Any alphanumeric | TranzPayResponse.Transaction. |
AVSResponseMessage | Merchant gateway AVS response message | Any alphanumeric | TranzPayResponse.Transaction. |
CustomerName | Account holder full name = BillingFullName | Alpha character name | TranzPayResponse.Transaction. |
BillingNameFirst | Account holder first name | Alpha character name | TranzPayResponse.Transaction. |
BillingNameLast | Account holder last name | Alpha character name | TranzPayResponse.Transaction. |
BillingAddress | Billing street address for credit card | Any alphanumeric | TranzPayResponse.Transaction. |
BillingCity | Billing city for credit card | Any alphanumeric | TranzPayResponse.Transaction. |
BillingState | Billing state for credit card | Any alphanumeric | TranzPayResponse.Transaction. |
BillingZipCode | Billing zip code for credit card | 5 digit zip code | TranzPayResponse.Transaction. |
BillingEmail | Account holder email | Any alphanumeric | TranzPayResponse.Transaction. |
Code | Validation Error Code | “V1001” | TranzPayResponse.Error.Code |
Msg | Validation Error Message | Alpha character error msg | TranzPayResponse.Error.Msg |
-
xML
-
JSON
<TranzPayRequest> <TransactionType>AddCustomerCCCharge</TransactionType> <UserName>testprod</UserName> <Password>test</Password> <ProducerID>2</ProducerID> <CustomerID>TranzPay_0151638</CustomerID> <TransactionAmount>37.99</TransactionAmount> </TranzPayRequest>
{
"TransactionType": "AddCustomerCCCharge",
"UserName": "{{USERNAME}}",
"Password": "{{API_PASSWORD}}",
"ProducerID": "{{PRODUCERID}}",
"CustomerID": "KJHG45663",
"TransactionAmount": "100",
"Format":"JSON"
}
AddCustomerACHDebit
Description:
This method creates an ACH debit transaction from a customer record.
-
Request
-
Response
-
Samples
Fieldname | Required | Type | Description | Validate | Xpath |
|---|---|---|---|---|---|
TransactionType | String | Transaction type to process. (“AddCustomerACHDebit”) | AddCustomerACHDebit | TranzPayRequest.TransactionType | |
ProducerID | Number | TranzPay producerID assigned to your merchant account. | Integer supplied by TranzPay | TranzPayRequest.ProducerID | |
CustomerID | String | CustomerID of previously created customer. | String Unique | TranzPayRequest.CustomerID | |
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 | |
PolicyNumber | String | Custom Policy or Account Number | Any alphanumeric | TranzPayRequest.PolicyNumber |
Fieldname | Description | Validate | Xpath |
|---|---|---|---|
ProducerID | TranzPay producerID assigned to your merchant account. | Integer supplied by TranzPay | TranzPayResponse.ProducerID |
CustomerID | Previously Created Customer ID used for this Credit Card Transaction. | String Unique | TranzPayResponse.CustomerID |
GatewayConnect | Connection to gateway was established | “Y” or “N” | TranzPayResponse.GatewayConnect |
PostedDate | Transaction date | Date/time formatted string | TranzPayResponse.Transaction. |
TransactionID | Merchant gateway returned unique transactionID | Any alphanumeric | TranzPayResponse.Transaction. |
TransactionAmount | Amount of transaction in decimal format (ie. 99.99) | Decimal number greater than zero | TranzPayResponse.Transaction. |
Status | Merchant gateway status response message | Any alphanumeric | TranzPayResponse.Transaction. |
Code | Validation Error Code | “V1001” | TranzPayResponse.Error.Code |
Msg | Validation Error Message | Alpha character error msg | TranzPayResponse.Error.Msg |
-
xML
-
JSON
<TranzPayRequest> <TransactionType>AddCustomerACHDebit</TransactionType> <UserName>testprod</UserName> <Password>test</Password> <ProducerID>2</ProducerID> <CustomerID>TranzPay_0151638</CustomerID> <TransactionAmount>10.00</TransactionAmount> </TranzPayRequest>
{
"TransactionType": "AddCustomerACHDebit",
"UserName": "{{USERNAME}}",
"Password": "{{API_PASSWORD}}",
"ProducerID": "{{PRODUCERID}}",
"CustomerID": "SD47859TF",
"TransactionAmount": "45",
"Format":"JSON"
}