CreditCardRecurringCharge
Description: This method schedules a credit card charge via a recurring payment. In most cases, CreditCardRebill() Method is preferred.
Resource Url: https://webservice.paymentxp.com/wh/WebHost.aspx
Method: POST
Content-Type: application/x-www-form-urlencoded
Notes
- Parameters in bold are required in the request for example, BillingNameFirst
Request
| Parameter | Is Required | Data Type | Max Length | Description |
|---|---|---|---|---|
BillingAddress |
No | String | 50 | The billing address of the cardholder. Used to check for AVS identification. |
BillingCity |
No | String | 50 | The billing city of the cardholder. |
BillingCountry |
No | String | 50 | The billing country of the cardholder. |
BillingMethod |
No | String | 50 | Values: 'initial_recurring' or 'recurring' |
BillingNameFirst |
Yes | String | 50 | The first name of the cardholder. Note: Required if BillingFullName not present |
BillingNameLast |
Yes | String | 50 | The last name of the cardholder. Note: Required if BillingFullName not present |
BillingState |
No | String | 25 | The billing state of the cardholder. |
BillingZipCode |
No | String | 10 | The billing zip code of the cardholder. Used to check for AVS identification. |
CardNumber |
Yes | String | 76 | Identifies the cardholder’s credit card number. For swiped transaction, if track 2 data exists, then use track2. Otherwise, use track 1 data. Not required if using a KORT Payments Token |
ClerkID |
No | String | 15 | The cashier/clerk who initiated the transaction. |
CustomInfo1 |
No | String | 255 | For merchant use. |
CustomInfo2 |
No | String | 255 | For merchant use. |
CustomInfo3 |
No | String | 255 | For merchant use. |
DayOfMonthOption |
Yes | Number | 1 | 0=None, 1, 2, 3, 4, 5, 6,7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31 |
EmailAddress |
No | String | 50 | The e-mail address of the cardholder. |
EndDate |
No | Number | 8 | End date for recurring payment. Format MMddyyyy. Leaveblank if there is no end date. |
ExpirationDateMMYY |
Yes | String | 4 | Identifies the cardholder’s account expiration date (format
Note |
FaxNumber |
No | String | 10 | The fax number of the cardholder. |
MerchantID |
Yes | Number | 9 | The identification that is assigned to the merchant. |
MerchantKey |
Yes | String | 36 | A unique identification that is assigned to the merchant id. |
MonthlyOption |
Yes | Number | 1 | 0=None, 1= Set day of month option (MonthOfYearOption and DayOfMonthOption are required), 2= Set the advanced option per month (WeekOption, WeekdayOption, and MonthofYearOption are required) |
MonthOfYearOption |
No | Number | 1 | 0=None, 1=One, 2=Two, 3=Three, 4=Four, 5=Five, 6=Six, 7=Seven, 8=Eight, 9=Nine, 10=Ten, 11=Eleven, 12=Twelve Only applicable when MonthlyOption=2 |
OccurenceOption |
Yes | Number | 1 | 1=Daily, 2=Monthly |
PaymentMemo |
No | String | 50 | Additional payment memo. |
PhoneNumber |
No | String | 10 | The phone number of the cardholder. |
ReferenceNumber |
No | String | 50 | The merchant/customer transaction identifier. |
ShippingAddress |
No | String | 50 | The shipping address for the product(s) purchased in the transaction. |
ShippingCity |
No | String | 50 | The shipping city for the product(s) purchased in the transaction. |
ShippingCountry |
No | String | 50 | The shipping country for the product(s) purchased in the transaction. |
ShippingNameFirst |
No | String | 50 | The first name of the recipient. |
ShippingNameLast |
No | String | 50 | The last name of the recipient. |
ShippingState |
No | String | 25 | The shipping state for the product(s) purchased in the transaction. |
ShippingZipCode |
No | String | 10 | The shipping zip code for the product(s) purchased in the transaction. |
StartDate |
Yes | Number | 8 | Start date for recurring payment. Format MMddyyyy. |
Token |
No | String | 36 | KORT Payments Token |
TransactionAmount |
Yes | Number | 9 | Identifies the transaction’s total amount in US dollars. |
TransactionType |
Yes | String | 25 | CreditCardRecurringCharge |
WeekdayOption |
No | Number | 1 | 0=None, 1=Monday, 2=Tuesday, 3=Wednesday, 4=Thursday, 5=Friday, 6=Saturday, 7=Sunday Only applicable when MonthlyOption=2 |
WeekOption |
No | Number | 1 | 0=None, 1=First, 2=Second, 3=Third, 4=Fourth, 5=Last week of the month. Only applicable when MonthlyOption=2 |
Response
| Field Name | Description |
|---|---|
PostedDate |
The date and time the transaction was posted. |
StatusID |
The result of the transaction. Status 0 indicates an approved transaction. |
RecurID |
The number that identifies the transaction in the KORT Payments system. |
ReferenceNumber |
The merchant/customer transaction identifier that was sent in the initial request. |
TransactionAmount |
Identifies the transaction amount that was sent in the initial request. |
ScheduleDescription |
A text description of the recurring payment schedule. |
ScheduleDate |
The date the recurring payment charge will be processed. |
ResponseMessage |
The approval or decline message from the processor. |
