Delivery Information Collection
Overview
The PayForIT scheme supports the collection of postal address information to allow the delivery of a physical product. This can apply to either a one-off charge or a subscription.
This page assumes you are already familiar with how to make charges or set up subscriptions using the Charge To Account Gateway API. For more information, see the sections on One-Off Charges and Subscriptions.
Contents
- Delivery information collection workflow
- Example of delivery information collection
- Provisioning delivery information collection
Delivery information collection workflow
The collection of delivery address information can be requested for a charge or subscription request either by setting the postConfirmationPage parameter to delivery, or by having your account configured to collect delivery information by default.
Where delivery information collection has been requested and after a successful one off charge or subscription request the following changes to the normal workflow take place:
- An email containing details of the purchase is sent to a pre-configured email address after the charge has been confirmed in addition to the normal HTTP notification. This email can be used to aid with customer care.
- A form for entering address details is shown on the purchase confirmation page.
- Optionally, a checkbox can be displayed allowing the user to choose to store their address details for future purchases. Where the user has previously ticked this box, the address details form is pre-populated.
- On successful entry of address details an email is sent that contains full purchase details including the given delivery address. This can be used to aid with the fulfilment process. A standard HTTP notification is also made, but with the address details included.
- Where delivery address collection has not been successfully completed within eight minutes, an SMS with further instructions is sent to the user.
- After address details have been collected, an SMS is sent to the user confirming their purchase.
Example of delivery information collection
In this example, the end user has purchased a DVD through PayForIT. Here is the initial one-off charge request made by the merchant application:
https://cta.mxtelecom.com/api?
A link to the shipping terms and conditions is displayed below the existing Terms and Conditions link on the initial confirmation page.
After the charge or subscription is confirmed and before address information is collected, you receive an email notification in the following format, in addition to the standard HTTP notification:
Subject: Order #54087074 for Merchant of Tiger Cubs DVD Date: Fri, 18 Apr 2008 16:15:05 +0100 (BST) From: auto@mxtelecom.com To: merchant@example.com A new order has been placed - Order Number: 54087074 Purchase Information: [value of the purchaseInformation parameter] MSISDN: 447700900999 Date/Time: 2008-04-18 16:14:09 +0100 Brand Name: [value of brand parameter] Product Name: Tiger Cubs DVD Price: £5.00 Shipping address has not yet been obtained
The HTTP notification you receive at this point would be similar to:
http://merchant.example.com/mxpay?
The presence of collectingDeliveryAddress=yes indicates that delivery address collection is in progress for the charge.
The following screen is displayed after the payment is confirmed:
Note the Save my delivery details for future purchases check-box.
If, on a subsequent purchase, the user indicates that they do not want their delivery information to be stored, their existing details will be deleted.
The information collected in this form is sent to you both through the Notification API and by e-mail (to the fulfilment e-mail address list you specified).
Once address information has been collected, you will receive an email in this format, as well as a further HTTP notification:
A new order has been placed -
Order Number: 54087074
Purchase Information: [value of the purchaseInformation parameter]
Date/Time: 2008-04-18 16:23:17 +0100
Brand Name: [value of brand parameter]
Product Name: Tiger Cubs DVD
Price: £5.00
Shipping address is -
Name: Tex Commel
Line 1: 389 Chiswick High Road
Line 2: Chiswick
Line 3:
Town/City: London
Postcode: W44AL
Contact Number: 447700900999
The address information is also supplied along with the marketing opt-in details in an HTTP notification.
http://merchant.example.com/mxpay?
If the customer fails to submit the delivery information collection form within eight minutes, they will be sent a link to the form via SMS so they can try again:
Thanks for your purchase of Tiger Cubs DVD. Please enter the delivery details at http://mxpay.net/vRJv...
Once delivery information has been successfully collected, the user will be sent an SMS confirming the order:
Thank you for your purchase of Tiger Cubs DVD from Merchant. Your order number is 54087074. For assistance with your order please call 0845 666 7778.
For a subscription with a delivery address, a standard subscription setup SMS confirmation is sent instead.
Provisioning delivery information collection
In order to set up delivery information collection, please contact your account manager with the following details:
- Fulfilment email address(es) to which delivery information should be sent
- Whether delivery information should be collected by default
- Delivery Terms and Conditions text
- Whether users should have the option to save their delivery details for future use
- Whether the check-box to save delivery details should be preselected
If you have multiple brands set up on your account, these options can be set differently for each one.

