Message: Recurring Installment Failed
Description: Recurring orders bill automatically according to schedule, but billings are not always successful. This message will allow you to automate any processes which should be keyed off installment billing failure, such as suspension of login credentials.
This message will send the information based on the last successful installment billed, in other words, the invoice number is the last invoice successfully billed, installments_billed is not incremented, and date_next will often be a date in the past, indicating the original due date for the missed billing.
Recurring Installment Failed is an item level message; it will be sent once for each recurring item which fails to bill and will only contain information about that item.
Please note this message will be identical (except for dates) whether it is the first attempt or a retry.
Within each message section page, the parameters highlighted (like this *) are the parameters we believe will be most useful in updating your systems, or which are most relevant to that specific message.
NOTE: md5_hash values used in the following examples are NOT necessarily valid. MD5 is a data encryption algorithm which will help you validate that INS POSTs came from 2Checkout. >>More about MD5
| Ex. Recurring installment fails |
|---|
| message_type=RECURRING_INSTALLMENT_FAILED * |
| message_description=Recurring installment failed to bill |
| timestamp=2007-10-01 15:30:44 |
| md5_hash=99229B8BD0828FBC41CD0FE5DD80A7C0 |
| message_id=1 |
| key_count=50 |
| vendor_id=12345 |
| sale_id=2223334445 * |
| sale_date_placed=2007-01-01 15:30:44 |
| vendor_order_id= * |
| invoice_id=234567890 * |
| recurring=1 |
| payment_type=credit card |
| list_currency=GBP |
| cust_currency=JPY |
| customer_first_name=John |
| customer_last_name=Smith |
| customer_name=John Smith |
| customer_email=jsmith@yahoo.com |
| customer_phone=6149212450 |
| customer_ip=1.1.1.1 |
| customer_ip_country=United States |
| bill_street_address=55 Lane Ave. |
| bill_street_address2= |
| bill_city=Mytown |
| bill_state=NV |
| bill_postal_code=55555 |
| bill_country=USA |
| ship_status= |
| ship_tracking_number= |
| ship_name= |
| ship_street_address= |
| ship_street_address2= |
| ship_city= |
| ship_state= |
| ship_postal_code= |
| ship_country= |
| item_count=1 |
| item_name_1=t-shirt |
| item_id_1=12 * |
| item_list_amount_1=5.00 |
| item_usd_amount_1=2.50 |
| item_cust_amount_1=250 |
| item_type_1=bill |
| Item_duration_1=1 Year |
| item_recurrence_1=1 Month |
| item_rec_list_amount_1=5.00 |
| item_rec_status_1=live |
| item_rec_date_next_1=2007-11-01 * |
| item_rec_install_billed_1=10 * |