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, supplied by Merchant.

Any

alphanumeric, Max Len (45) Min Len (6)

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
“SA” = Savings

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

Email

String

Account holder email

Any alphanumeric

TranzPayRequest.Email


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.

Any

alphanumeric, Max Len (45) Min Len (6)

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
“SA” = Savings

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

Email

String

Account holder email

Any alphanumeric

TranzPayRequest.Email


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.

Any

alphanumeric, Max Len (45) Min Len (6)

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


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.

Any

alphanumeric, Max Len (45) Min Len (6)

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


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.

Any

alphanumeric, Max Len (45) Min Len (6)

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