Subscriptions



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


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


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