ACH Method
ACH Charge
Description:
Use these functions to create new ACH transactions. Below are the parameters for this method.
-
Request
-
Response
-
Samples
Fieldname | Required | Type | Description | Validate | Xpath |
|---|---|---|---|---|---|
TransactionType | String | Transaction type to process. (“ACHCharge”) | ACHCharge | 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 | |
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 | “ch” = Checking | TranzPayRequest.BankAccountType | |
CheckType | String | Personal or Business Check | “ps” = Business to consumer transaction | TranzPayRequest.CheckType | |
Description | String | Desription of the payment transaction. | Any alphanumeric | TranzPayRequest.Description | |
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 | String | Account holder email | TranzPayRequest.Email | ||
PolicyNumber | String | Custom Policy 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” |
StatusID | 1 = Success | Numeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
TransactionType | ACHCharge | Type of Transaction. | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
PaymentType | ACH | Any alphanumeric | 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 | Decimal number greater than zero | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
ResponseMessage | Merchant gateway response message | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
BankRoutingNumberResponse | Merchant gateway Bank Routing Number response | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
BankAccountNumberResponse | Merchant gateway Bank Account Number response | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
CustomerName | Acount holder full name | Alpha character name | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
BillingNameFirst | Account holder first name | Alpha character name | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
BillingNameLast | Account 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 | 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>ACHCharge</TransactionType> <UserName>testprod</UserName> <Password>test</Password> <ProducerID>2</ProducerID> <BankRoutingNumber>325070760</BankRoutingNumber> <BankAccountNumber>1234567890</BankAccountNumber> <BankAccountType>ch</BankAccountType> <CheckType>bu</CheckType> <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> <Email>[email protected]</Email> <PolicyNumber>PN692384</PolicyNumber> <CustomField1>Sara Henderson</CustomField1> <CustomField2>Nissan Sentra</CustomField2> <CustomField3>986654332FRT566</CustomField3> <CustomField4>92677</CustomField4> </TranzPayRequest>
{
"TransactionType":"ACHCharge",
"UserName": "{{USERNAME}}",
"Password": "{{API_PASSWORD}}",
"ProducerID": "{{PRODUCERID}}",
"BankRoutingNumber":"121042882",
"BankAccountNumber":"1234567890",
"BankAccountType":"ch",
"CheckType":"ps",
"Description":"Insurance Payment",
"TransactionAmount":"71.82",
"BillingFullName":"Jessie Jones",
"BillingNameFirst":"Jessie",
"BillingNameLast":"Jones",
"BillingAddress":"280 Via Amaposa",
"BillingCity":"Rancho Santa Margarita",
"BillingState":"CA",
"BillingZipCode":"92688",
"PhoneNumber":"8888888888",
"PolicyNumber":"1234567",
"Email":"in[email protected]",
"Format":"JSON"
}
ACHVOID
Description:
Use the function to void an unsettled ACH transaction. Below are the parameters for this method.
-
Request
-
Response
-
Samples
Fieldname | Required | Type | Description | Validate | Xpath |
|---|---|---|---|---|---|
TransactionType | String | Transaction type to process. (“ACHVoid”) | ACHVoid | 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 | String | TransactionID returned by API | Numeric id returned by TranzPay | TranzPayRequest.TransactionID |
Fieldname | Description | Validate | Xpath | Note |
|---|---|---|---|---|
CustomerID | Previously Created Customer ID | String Unique | TranzPayResponse.CustomerID | 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. | Cell |
Status | Merchant gateway status response message | Any alphanumeric | TranzPayResponse.Transaction. | Cell |
CustomerName | Account holder full name | Alpha character name | TranzPayResponse.Transaction. | Cell |
BillingNameFirst | Account holder first name | Alpha character name | TranzPayResponse.Transaction. | Cell |
BillingNameLast | Account holder last name | Alpha character name | TranzPayResponse.Transaction. | Cell |
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” |
-
xML
-
JSON
<TranzPayRequest> <TransactionType>ACHVoid</TransactionType> <ProducerID>1</ProducerID> <UserName>testprod</UserName> <Password>test</Password> <TransactionID>95958202</TransactionID> </TranzPayRequest>
{
"TransactionType": "ACHVoid",
"UserName": "{{USERNAME}}",
"Password": "{{API_PASSWORD}}",
"ProducerID": "{{PRODUCERID}}",
"TransactionID": "15010536",
"Format": "JSON"
}
ACHRefund
Description:
Use these functions to refund a settled ACH transaction. Below are the parameters for this method.
-
Request
-
Response
-
Samples
Fieldname | Required | Type | Description | Validate | Xpath |
|---|---|---|---|---|---|
TransactionType | String | Transaction type to process. (“ACHRefund”) | ACHRefund | 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 API | Numeric id returned by TranzPay | TranzPayRequest.TransactionID | |
TransactionAmount | Number | Amount of transaction in decimal format (ie. 99.99) | Decimal number greater than zero | TranzPayRequest.TransactionAmount |
Fieldname | Description | Validate | Xpath | Note |
|---|---|---|---|---|
CustomerID | Previously Created Customer ID | String Unique | TranzPayResponse.CustomerID | 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. | Cell |
StatusID | 1 = Success | Numeric | TranzPayResponse.Transaction. | Cell |
CustomerName | Account holder full name | Alpha character name | TranzPayResponse.Transaction. | Cell |
BillingNameFirst | Account holder first name | Alpha character name | TranzPayResponse.Transaction. | Cell |
BillingNameLast | Account holder last name | Alpha character name | TranzPayResponse.Transaction. | Cell |
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” |
-
xML
-
JSON
<TranzPayRequest> <TransactionType>ACHRefund</TransactionType> <ProducerID>1</ProducerID> <UserName>testprod</UserName> <Password>test</Password> <TransactionID>95958202</TransactionID> <TransactionAmount>160.00</TransactionAmount> </TranzPayRequest>
{
"TransactionType": "ACHRefund",
"UserName": "{{USERNAME}}",
"Password": "{{API_PASSWORD}}",
"ProducerID": "{{PRODUCERID}}",
"TransactionID": "12455877",
"TransactionAmount": "480.61",
"Format":"JSON"
}
ACHCredit
Description:
Use this function to create a new ACH Credit transaction. This transaction type requires special underwriting approval. Below are the parameters for this method.
-
Request
-
Response
-
Samples
Fieldname | Required | Type | Description | Validate | Xpath |
|---|---|---|---|---|---|
TransactionType | String | Transaction type to process. (“ACHCredit”) | ACHCredit | 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 | |
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 | “ch” = Checking | TranzPayRequest.BankAccountType | |
CheckType | String | Personal or Business Check | “ps” = Business to consumer transaction | TranzPayRequest.CheckType | |
Description | String | Desription of the payment transaction. | Any alphanumeric | TranzPayRequest.Description | |
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 | ||
PolicyNumber | String | Custom Policy 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” |
StatusID | 1 = Success | Numeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
TransactionType | ACHCharge | Type of Transaction. | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
PaymentType | ACH | Any alphanumeric | 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” |
ResponseMessage | Merchant gateway response message | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
BankRoutingNumberResponse | Merchant gateway Bank Routing Number response | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
BankAccountNumberResponse | Merchant gateway Bank Account Number response | Any alphanumeric | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
CustomerName | Account holder full name | Alpha character name | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
BillingNameFirst | Account holder first name | Alpha character name | TranzPayResponse.Transaction. | Present if GatewayConnect = “Y” |
BillingNameLast | Account 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 | 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>ACHCredit</TransactionType> <UserName>testprod</UserName> <Password>test</Password> <ProducerID>2</ProducerID> <BankRoutingNumber>325070760</BankRoutingNumber> <BankAccountNumber>1234567890</BankAccountNumber> <BankAccountType>ch</BankAccountType> <CheckType>bu</CheckType> <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> <Email>