Recurring
AddPaymentPlan
Description:
Use this method to set up a customer with payment information saved in the vault on a recurring payment plan.
-
Request
-
Samples
-
Response
-
Samples
Fieldname | Required | Type | Description | Validate | Xpath | Note |
|---|---|---|---|---|---|---|
TransactionType | String | Transaction type to process. ("AddPaymentPlan") | AddPaymentPlan | TranzPayRequest.TransactionType | Cell | |
UserName | String | TranzPay username. | Username supplied by TranzPay. | TranzPayRequest.UserName | Cell | |
Password | String | TranzPay password. | Password supplied by TranzPay. | TranzPayRequest.Password | Cell | |
ProducerID | Number | TranzPay producerID assigned to your merchant account. | Integer supplied by TranzPay. | TranzPayRequest.ProducerID | Cell | |
CustomerID | String | CustomerID: The customer that will pay the plan. | Any alphanumeric string. Must be a valid CustomerID. | TranzPayResponse.Transaction.GatewayResponse.CustomerID | CustomerID can be made up and referenced with Get Customer | |
BillingCycles | String | The type of the billing cycles. | Can only be one of three values: auto, manual or fixed | TranzPayRequest.BillingCycles | Cell | |
ProductID | String | The product or products IDs that will represent the total payment amount. | Any combination of 5 to 10 consecutive alphanumeric characters. | TranzPayRequest.ProductID | Can be more than one. In case of 2 or more, must be comma separeted. | |
Amount | Number | Amount of payment plane in decimal format (ie. 99.99) | Decimal number greater than zero | TranzPayRequest.Amount | Is required if ProductID is empty | |
Type | String | Recurring payment type. (ex: CK) | Any string | TranzPayRequest.Type | Cell | |
RecurNote | String | Recurring payment note. | Any alphanumeric | TranzPayRequest.RecurNote | Cell | |
Interval | Integer | Represents the frecuency of the payments. | Must be one of them: daily, weekly, monthly, quarterly, semi-anually, yearly | TranzPayRequest.Interval | Cell | |
StartDate | Date/Time | Start date of the payment plan. | Date/time formatted string. | TranzPayRequest.StartDate | Cell | |
Occurences | Integer | Occurences of the payment plan. | Amount of payments of the plan. | TranzPayRequest.Occurences | Required if a fixed billing cycle is selected | |
EndDate | Date/Time | End date of the payment plan. | Date/time formatted string. | TranzPayRequest.EndDate | Required if a manual billing cycle is selected |
-
xML
-
JSON
<TranzPayRequest>
<TransactionType>AddPaymentPlan</TransactionType>
<UserName>testprod</UserName>
<Password>test</Password>
<ProducerID>2</ProducerID>
<ProductID>xqljjX86</ProductID>
<RecurNote>Testing</RecurNote>
<CustomerID>devtester_yz10033</CustomerID>
<BillingCycles>auto</BillingCycles>
<StartDate>2/1/2022</StartDate>
<Type>CK</Type>
<Interval>monthly</Interval>
</TranzPayRequest>
Fieldname | Required | Type | Description | Validate | Xpath | Note |
|---|---|---|---|---|---|---|
ProducerID | Number | TranzPay producerID assigned to your merchant account. | Integer supplied by TranzPay. | TranzPayResponse.ProducerID | ||
GatewayConnect | String | Connection to gateway was established. | "Y" or "N" | TranzPayResponse.GatewayConnect | Cell | |
TransactionType | String | Transaction type to process. ("AddPaymentPlan") | AddPaymentPlan | TranzPayResponse.Transaction.GatewayResponse.TransactionType | Present if GatewayConnect = "Y" | |
RecurringPlanID | Integer | RecurringPlanID: Plan ID auto generated by Tranzpay. | Integer greater than zero. | TranzPayResponse.Transaction.GatewayResponse.RecurringPlanID | Present if GatewayConnect = "Y" | |
CustomerID | String | CustomerID: The customer that will pay the plan. | Any alphanumeric string. Must be a valid CustomerID. | TranzPayResponse.Transaction.GatewayResponse.CustomerID | Present if GatewayConnect = "Y" | |
RecurNote | String | Recurring payment note. | Any alphanumeric | TranzPayResponse.Transaction.GatewayResponse.RecurNote | Present if GatewayConnect = "Y" | |
Active | String | Confirmation reagarding active status | "Y" for active or "N" for non active | TranzPayResponse.Transaction.GatewayResponse.Active | Present if GatewayConnect = "Y" | |
Amount | Number | Amount of payment plane in decimal format (ie. 99.99) | Decimal number greater than zero | TranzPayResponse.Transaction.GatewayResponse.Amount | Present if GatewayConnect = "Y" | |
BillingCycles | String | The type of the billing cycles. | Can only be one of three values: auto, manual or fixed | TranzPayResponse.Transaction.GatewayResponse.BillingCycles | Present if GatewayConnect = "Y" | |
LastPaymentDate | Date/Time | Last date when the payment occurance was proccesed. | Date/time formatted string. | TranzPayResponse.Transaction.GatewayResponse.LastPaymentDate | Present if GatewayConnect = "Y" | |
NextChargeDate | Date/Time | Next date when the payment occurance will be proccesed. | Date/time formatted string. | TranzPayResponse.Transaction.GatewayResponse.NextChargeDate | Present if GatewayConnect = "Y" | |
CreationDate | Date/Time | Recurring payment plan creation date | Date/time formatted string | TranzPayResponse.Transaction.GatewayResponse.CreationDate | Present if GatewayConnect = "Y" | |
PaymentType | String | Recurring payment plan type | Cell | TranzPayResponse.Transaction.GatewayResponse.PaymentType | Present if GatewayConnect = "Y" | |
Type | String | Recurring payment plan type. | Cell | TranzPayResponse.Transaction.GatewayResponse.Type | Present if GatewayConnect = "Y" |
-
xML
-
JSON
<TranzPayResponse> <ProducerID>2</ProducerID> <GatewayConnect>Y</GatewayConnect> <Transaction> <GatewayResponse> <TransactionType>AddPaymentPlan</TransactionType> <RecurringPlanID>52</RecurringPlanID> <CustomerID>devtester_yz10033</CustomerID> <RecurNote>Testing</RecurNote> <Active>Yes</Active> <Amount>25.00</Amount> <BillingCycles>auto</BillingCycles> <LastPaymentDate></LastPaymentDate> <NextChargeDate></NextChargeDate> <CreationDate>2022-01-17 16:59:39</CreationDate> <PaymentType></PaymentType> <Schedule>2023-01-01, 2022-12-01 2022-11-01, 2022-10-01, 2022-09-01, 2022-08-01, 2022-07-01, 2022-06-01, 2022-05-01, 2022-04-01, 2022-03-01, 2022-02-01</Schedule> </GatewayResponse> </Transaction> </TranzPayResponse>
UpdatePaymentPlan
Description:
Use this method to modify an existing recurring payment plan.
-
Request
-
Samples
-
Response
-
Samples
Fieldname | Required | Type | Description | Validate | Xpath | Note |
|---|---|---|---|---|---|---|
TransactionType | String | Transaction type to process. ("UpdatePaymentPlan") | UpdatePaymentPlan | TranzPayRequest.TransactionType | Cell | |
UserName | String | TranzPay username. | Username supplied by TranzPay. | TranzPayRequest.UserName | Cell | |
Password | String | TranzPay password. | Password supplied by TranzPay. | TranzPayRequest.Password | Cell | |
ProducerID | Number | TranzPay producerID assigned to your merchant account. | Integer supplied by TranzPay. | TranzPayRequest.ProducerID | Cell | |
CustomerID | String | CustomerID: The customer that will pay the plan. | Any alphanumeric string. Must be a valid CustomerID. | TranzPayResponse.Transaction.GatewayResponse.CustomerID | CustomerID can be made up and referenced with Get Customer | |
BillingCycles | String | The type of the billing cycles. | Can only be one of three values: auto, manual or fixed | TranzPayRequest.BillingCycles | Cell | |
ProductID | String | The product or products IDs that will represent the total payment amount. | Any combination of 5 to 10 consecutive alphanumeric characters. | TranzPayRequest.ProductID | Can be more than one. In case of 2 or more, must be comma separeted. | |
Amount | Number | Amount of payment plane in decimal format (ie. 99.99) | Decimal number greater than zero | TranzPayRequest.Amount | Is required if ProductID is empty | |
Type | String | Recurring payment type. (ex: CK) | Any string | TranzPayRequest.Type | Cell | |
RecurNote | String | Recurring payment note. | Any alphanumeric | TranzPayRequest.RecurNote | Cell | |
Interval | Integer | Represents the frecuency of the payments. | Must be one of them: daily, weekly, monthly, quarterly, semi-anually, yearly | TranzPayRequest.Interval | Cell | |
StartDate | Date/Time | Start date of the payment plan. | Date/time formatted string. | TranzPayRequest.StartDate | Cell | |
Occurences | Integer | Occurences of the payment plan. | Amount of payments of the plan. | TranzPayRequest.Occurences | Required if a fixed billing cycle is selected | |
EndDate | Date/Time | End date of the payment plan. | Date/time formatted string. | TranzPayRequest.EndDate | Required if a manual billing cycle is selected |
-
xML
-
JSON
<TranzPayRequest>
<TransactionType>UpdatePaymentPlan</TransactionType>
<UserName>testprod</UserName>
<Password>test</Password>
<ProducerID>2</ProducerID>
<ProductID>xqljjX86</ProductID>
<RecurNote>Testing</RecurNote>
<CustomerID>devtester_yz10033</CustomerID>
<BillingCycles>auto</BillingCycles>
<StartDate>2/1/2022</StartDate>
<Type>CK</Type>
<Interval>monthly</Interval>
</TranzPayRequest>
'Status' => string 'FAILED' 'TransactionType' => string ' ThirdParty' 'ResponseMessage' => string 'DECLINED' 'ResponseCode' => string '605' 'CVV2ResponseCode' => string 'M' 'ThirdPartyCallID'=> string '12351256' 'AddVault'=> string 'N' 'CustomerID'=> string '124367' 'PolicyNum'=> string '13513123' 'Error'=> string 'Customer ID already exists' (note error can change) 'StatusMessage' => string 'DUPLICATE TRANSACTION'
Fieldname | Required | Type | Description | Validate | Xpath | Note |
|---|---|---|---|---|---|---|
ProducerID | Number | TranzPay producerID assigned to your merchant account. | Integer supplied by TranzPay. | TranzPayResponse.ProducerID | Cell | |
GatewayConnect | String | Connection to gateway was established. | "Y" or "N" | TranzPayResponse.GatewayConnect | Cell | |
TransactionType | String | Transaction type to process. ("UpdatePaymentPlan") | UpdatePaymentPlan | TranzPayResponse.Transaction.GatewayResponse.TransactionType | Present if GatewayConnect = "Y"ecurringPlanID | |
RecurringPlanID | Integer | RecurringPlanID: Plan ID auto generated by Tranzpay. | Integer greater than zero. | TranzPayResponse.Transaction.GatewayResponse.RecurringPlanID | Present if GatewayConnect = "Y" | |
CustomerID | String | CustomerID: The customer that will pay the plan. | Any alphanumeric string. Must be a valid CustomerID. | TranzPayResponse.Transaction.GatewayResponse.CustomerID | Present if GatewayConnect = "Y" | |
RecurNote | String | Recurring payment note. | Any alphanumeric | TranzPayResponse.Transaction.GatewayResponse.RecurNote | Present if GatewayConnect = "Y" | |
Active | String | Confirmation reagarding active status | "Y" for active or "N" for non active | TranzPayResponse.Transaction.GatewayResponse.Active | Present if GatewayConnect = "Y" | |
Amount | Number | Amount of payment plane in decimal format (ie. 99.99) | Decimal number greater than zero | TranzPayResponse.Transaction.GatewayResponse.Amount | Present if GatewayConnect = "Y" | |
BillingCycles | String | The type of the billing cycles. | Can only be one of three values: auto, manual or fixed | TranzPayResponse.Transaction.GatewayResponse.BillingCycles | Present if GatewayConnect = "Y" | |
LastPaymentDate | Date/Time | Last date when the payment occurance was proccesed. | Date/time formatted string. | TranzPayResponse.Transaction.GatewayResponse.LastPaymentDate | Present if GatewayConnect = "Y" | |
NextChargeDate | Date/Time | Next date when the payment occurance will be proccesed. | Date/time formatted string. | TranzPayResponse.Transaction.GatewayResponse.NextChargeDate | Present if GatewayConnect = "Y" | |
CreationDate | Date/Time | Recurring payment plan creation date | Date/time formatted string | TranzPayResponse.Transaction.GatewayResponse.CreationDate | Present if GatewayConnect = "Y" | |
PaymentType | String | Recurring payment plan type | Cell | TranzPayResponse.Transaction.GatewayResponse.PaymentType | Present if GatewayConnect = "Y" | |
Type | String | Recurring payment plan type. | Cell | TranzPayResponse.Transaction.GatewayResponse.Type | Present if GatewayConnect = "Y" |
-
xML
-
JSON
<TranzPayResponse> <ProducerID>2</ProducerID> <GatewayConnect>Y</GatewayConnect> <Transaction> <GatewayResponse> <TransactionType>UpdatePaymentPlan</TransactionType> <RecurringPlanID>52</RecurringPlanID> <CustomerID>devtester_yz10033</CustomerID> <RecurNote>Testing</RecurNote> <Active>Yes</Active> <Amount>25.00</Amount> <BillingCycles>auto</BillingCycles> <LastPaymentDate></LastPaymentDate> <NextChargeDate></NextChargeDate> <CreationDate>2022-01-17 16:59:39</CreationDate> <PaymentType></PaymentType> <Schedule>2023-01-01, 2022-12-01 2022-11-01, 2022-10-01, 2022-09-01, 2022-08-01, 2022-07-01, 2022-06-01, 2022-05-01, 2022-04-01, 2022-03-01, 2022-02-01</Schedule> </GatewayResponse> </Transaction> </TranzPayResponse>
'Status' => string 'FAILED' 'TransactionType' => string ' ThirdParty' 'ResponseMessage' => string 'DECLINED' 'ResponseCode' => string '605' 'CVV2ResponseCode' => string 'M' 'ThirdPartyCallID'=> string '12351256' 'AddVault'=> string 'N' 'CustomerID'=> string '124367' 'PolicyNum'=> string '13513123' 'Error'=> string 'Customer ID already exists' (note error can change) 'StatusMessage' => string 'DUPLICATE TRANSACTION'
CancelPaymentPlan
Description:
Use this API Request to cancel an existing recurring payment plan.
-
Request
-
Samples
-
Response
-
Samples
Fieldname | Required | Type | Description | Validate | Xpath | Note |
|---|---|---|---|---|---|---|
TransactionType | String | Transaction type to process. ("CancelPaymentPlan") | CancelPaymentPlan | TranzPayRequest.TransactionType | Cell | |
UserName | String | TranzPay username. | Username supplied by TranzPay. | TranzPayRequest.UserName | Cell | |
Password | String | TranzPay password. | Password supplied by TranzPay. | TranzPayRequest.Password | Cell | |
ProducerID | Number | TranzPay producerID assigned to your merchant account. | Integer supplied by TranzPay. | TranzPayRequest.ProducerID | Cell | |
RecurringPlanID | Integer | RecurringPlanID: ID of the Recurring Plan. | Integer greater than zero. | TranzPayRequest.RecurringPlanID | Cell |
-
xML
-
JSON
<TranzPayRequest>
<TransactionType>CancelPaymentPlan</TransactionType>
<UserName>testprod</UserName>
<Password>test</Password>
<ProducerID>2</ProducerID>
<RecurringPlanID>2</RecurringPlanID>
</TranzPayRequest>
'Status' => string 'FAILED' 'TransactionType' => string ' ThirdParty' 'ResponseMessage' => string 'DECLINED' 'ResponseCode' => string '605' 'CVV2ResponseCode' => string 'M' 'ThirdPartyCallID'=> string '12351256' 'AddVault'=> string 'N' 'CustomerID'=> string '124367' 'PolicyNum'=> string '13513123' 'Error'=> string 'Customer ID already exists' (note error can change) 'StatusMessage' => string 'DUPLICATE TRANSACTION'
Fieldname | Required | Type | Description | Validate | Xpath | Note |
|---|---|---|---|---|---|---|
ProducerID | Number | TranzPay producerID assigned to your merchant account. | Integer supplied by TranzPay. | TranzPayResponse.ProducerID | Cell | |
GatewayConnect | String | Connection to gateway was established. | "Y" or "N" | TranzPayResponse.GatewayConnect | Cell | |
RecurringPlanID | Integer | RecurringPlanID: Plan ID auto generated by Tranzpay. | Integer greater than zero. | TranzPayResponse.Transaction.GatewayResponse.RecurringPlanID | Present if GatewayConnect = "Y" | |
Active | String | Recurring payment plan status. | TranzPayResponse.Transaction.GatewayResponse.Active | Present if GatewayConnect = "Y" |
-
xML
-
JSON
<TranzPayResponse> <ProducerID>2</ProducerID> <GatewayConnect>Y</GatewayConnect> <Transaction> <GatewayResponse> <TransactionType>CancelPaymentPlan</TransactionType> <RecurringPlanID>52</RecurringPlanID> <Active>Yes</Active> </GatewayResponse> </Transaction> </TranzPayResponse>
'Status' => string 'FAILED' 'TransactionType' => string ' ThirdParty' 'ResponseMessage' => string 'DECLINED' 'ResponseCode' => string '605' 'CVV2ResponseCode' => string 'M' 'ThirdPartyCallID'=> string '12351256' 'AddVault'=> string 'N' 'CustomerID'=> string '124367' 'PolicyNum'=> string '13513123' 'Error'=> string 'Customer ID already exists' (note error can change) 'StatusMessage' => string 'DUPLICATE TRANSACTION'