Add Recurring - ccaddrecurring
This topic describes the message parameters for Credit Card Add Recurring transaction processing, which you can submit using the Hosted Payments, Checkout.js, and XML API integration methods. Refer to the Integration Methods section for more information.
ccaddrecurring transaction adds a credit card recurring record to the Converge recurring batch. Once added, the transaction will run automatically within the specified billing cycle on the scheduled payment day without the need to send it for authorization.
In this topic:
|Field name||Description||Required||Length||Data type|
Elavon-assigned Converge account ID.
|Converge user ID|
The user ID with Hosted Payment API user status that can send transaction requests through the terminal.
Unique identifier of the terminal that will process the transaction request and submit to the Converge gateway.
|[Card Data]||Use the appropriate card data parameters for the transaction.|
Card Number as it appears on the credit card.
Required when adding a recurring record using a card number.
|Card’s Expiry Date|
Date when the card becomes invalid.
|Credit Card Token|
Encrypted card data that can replace
- Required when adding a recurring record using a token.
- If token is stored in Card Manager, the expiration date, first name, last name, and AVS data on file are used.
- Use only if the terminal is set up with the Tokenization terminal option.
Unique identifier of the approved Sale (
Only applicable to XML API.
Required when adding a recurring record based on a previously approved transaction.
The recurring amount that includes the Net and Sales Tax amounts.
Format: Number with 2 decimals places
|Next Payment Date|
The date of the next scheduled payment for the recurring record.
|Half of the Month or Semimonthly Indicator|
Indicates when to process recurring payment transactions if
|End of Month Indicator|
Indicates whether to process the recurring transaction on the last day of the month.
Select Y to process the recurring transaction:
|Skip Payment Indicator|
|Address Line 1|
Commonly the house number and street name on the cardholder’s / customer’s account or billing address.
Address Verification Service (AVS) data compared with the address on the card issuer’s file.
|Postal or ZIP Code|
ZIP code on the cardholder’s account or billing address.
Address Verification Service (AVS) data compared with the postal or ZIP code on the card issuer’s file.
First name on the cardholder’s / customer’s account or billing address.
Last name on the cardholder’s / customer’s account or billing address.
|[Purchasing Cards]||Use only on terminals that are set up with the Purchasing Card 2 credit card payment option.|
|Customer Code or Purchase Order Number|
Customer ID or PO number specified in the billing statement of the cardholder.
Tax amount to add to the purchase or sales amount. For a tax exempt transaction, enter 0.00.
Format: Amount with 2 decimal places.
|[Invoice Number]||Returned only if Invoice Number parameters are sent in the request.|
The invoice number or ticket number sent in the original request.
|[Doing Business As]||Use only on terminals that are set up with the DBA Name terminal option.|
|Doing Business As Name|
Merchant-defined descriptors that replace the merchant’s business name on credit card statements.
Length: Prefix = 3, 7, or 12, Asterisk = 1, Descriptor = 21 - (Prefix + Asterisk)
Example: MANYMAG*BAKERS MONTHLY
|Transaction Result Message|
A result of SUCCESS indicates that the recurring record was added.
A result of ERROR indicates that the recurring record was not added.
|Converge User ID|
|Masked Card Number|
Converge only returns the first 2 or last 4 digits of the regular PAN, or the last 4 digits of the actual card number if it is an association token (example, ApplePay).
|Card’s Expiry Date|
Returned based on merchant setup.
Unique identifier of the added recurring record.
Returned only if
|Next Payment Due Date|
|Payment Start Date|
The date when the first payment started. If recently added, the start date is the same as the next payment due date.
|Recurring Batch Count|
The current number of transactions sitting in the recurring batch after the recurring transaction has been added.
|[Error]||Returned only if an error occurs. Refer to the Error Codes section for more information.|
Typically, when the transaction failed validation or the request is incorrect. This will prevent the transaction from going to authorization. This is a numeric field.
Detailed explanation of the error. This field may be changed based on merchant configuration in the user interface.
Error name or reason for the error.
- In this example, you will have to change the data values, such as
my_pin, and transaction data to match your Converge account and meet the needs of your website.
- Code samples provided are for demonstration only and should not be used for live transactions. All sensitive merchant data, including transaction amounts and your Converge credentials, should be placed in server side code.
xmldata=<txn> <ssl_merchant_id>my_merchant_id</ssl_merchant_id> <ssl_user_id>my_user_id</ssl_user_id> <ssl_pin>my_pin</ssl_pin> <ssl_test_mode>False</ssl_test_mode> <ssl_transaction_type>ccaddrecurring</ssl_transaction_type> <ssl_card_number>0000000000000000</ssl_card_number> <ssl_exp_date>1212</ssl_exp_date> <ssl_amount>10.36</ssl_amount> <ssl_billing_cycle>MONTHLY</ssl_billing_cycle> <ssl_next_payment_date>01/31/2012</ssl_next_payment_date> <ssl_end_of_month>Y</ssl_end_of_month> <ssl_invoice_number>1111</ssl_invoice_number> </txn>
<txn> <ssl_start_payment_date>01/31/2012</ssl_start_payment_date> <ssl_transaction_type>CCADDRECURRING</ssl_transaction_type> <ssl_card_number>00**********00000</ssl_card_number> <ssl_exp_date>1212</ssl_exp_date> <ssl_amount>10.36</ssl_amount> <ssl_next_payment_date>01/31/2012</ssl_next_payment_date> <ssl_billing_cycle>MONTHLY</ssl_billing_cycle> <ssl_result_message>SUCCESS</ssl_result_message> <ssl_recurring_id>AA484C3-8E5D1201-A05E-824D-9DAD-E3534E83F078</ssl_recurring_id> <ssl_number_of_payments>0</ssl_number_of_payments> <ssl_skip_payment>N</ssl_skip_payment> <ssl_recurring_batch_count>65</ssl_recurring_batch_count> </txn>