Access Worldpay
/
Integration

Requests and Responses

After you have completed the necessary tests you can begin using the API.

Using FTP

  1. Submit an Account Updater request

  2. Receive an acknowledgement response from us

    • If the response indicates any errors, you must resolve them and re-submit a new request

  3. Visa and MasterCard send a file to us containing the requested information

  4. We send a completion response

  5. Retrieve your files using FTP

Batch requests

The first step of the process is submitting an Account Updater batch request.

Request XML structure

When submitting a request, you can use either card or token information. You must use the following structure:

<cnpRequest  version="12.0" xmlns="http://www.vantiv.cnp.com/schema&quot; id="requestId" numBatchRequests="1">
 <authentication>
 	<user>JohnSmith</user>
 	<password>Password1234</password>
 </authentication>
 <batchRequest  id="batchId" numAccountUpdates="2" merchantId="testMerchant01">
 	<accountUpdate  id=”1234” reportGroup"merchant01ReportGrpoup">
 	<orderId >123456</orderId>
 	<card>
 		<type>Visa</type>
 		<number>123412312345123</number>
 		<expDate>0721</expDate>
 	</card>
 	</accountUpdate>
 	<accountUpdate id=”1235” reportGroup="merchant01ReportGrpoup">
 		<orderId>123456</orderId>
 		<token>
 			<cnpToken >12345678912345</cnpToken>
 			<expDate>0721</expDate>
 		</token>
 	</accountUpdate>
 </batchRequest>
</cnpRequest>

For more details about our Account Updater elements click here.

Acknowledgement response

When you submit a request, Worldpay returns an acknowledgement response. This response confirms the request was received and contains validation information.

Acknowledgement response XML structure

<cnpResponse  version= "11.2" response="0" message="Valid Format" cnpSessionId="1700000128">
 <batchResponse  cnpBatchId="1700000136" merchantId="TestMerchant01">
 <accountUpdateResponse  id=”1234” reportGroup="MerchantReportGroup01">
 <cnpTxnId>123456789</cnpTxnId>
 <orderId>123456</orderId>
 <response>000</response>
 <responseTime>2009-12-21T11:37:04</responseTime>
 <message>Approved</message>
 </accountUpdateResponse>
 </batchResponse>
</cnpResponse>

For more details about our Account Updater elements click here.

Acknowledgement response codes

We notify you when we receive the request. If the response file indicates any errors, you must resolve the issues and submit corrected account information in a new Account Updater request.

Response CodeResponse MessageResolution
000ApprovedWe forward these accounts to Visa and MasterCard.
301Invalid account numberThe card number is not valid. Correct the account number and resubmit the data.
320Invalid Expiration DateThe expiration date is not valid. Correct the expiration date and resubmit the card data.
821Merchant is not authorized for tokensYou are not authorized to use tokens.
822Token was not foundThe submitted token was not found in the system. Correct the token number and resubmit.
823Token was invalidThe submitted token failed validation. Correct the token number and resubmit.
899Generic token use errorThere is an unspecified token use error; contact Customer Service.

Completion response

We return the completion response, which includes updated customer account information and reason codes supplied by the network. You can use this information to update customer account information.

Typically, we generate this file five days after you first submit your batch request.

Completion response format

The following examples show a tree structure view of the acknowledgement response and a completion response.

Info

information. The response, however, does not contain the updatedCard or updatedToken child elements.

Completion response XML structure

<cnpResponse  version= "11.2" response="0" message="Merchant Fiscal Day: 06102010" cnpSessionId="1700000128">
    <batchResponse  cnpBatchId="1700000136" merchantId="TestMerchant01">
        <accountUpdateResponse  id=”1234” reportGroup= "MerchantReportGroup01">
            <cnpTxnId >123456789</cnpTxnId>
            <orderId >123456</orderId>
            <response >000</response>
            <responseTime >2009-12-21T11:37:04</responseTime>
            <message >Approved</message>
            <originalCard >
                <type >Visa</type>
                <number >123412312345123</number>
                <expDate >0721</expDate>
            </originalCard>
            <updatedCard >
                <type >Visa</type>
                <number >1234123123451224</number>
                <expDate >0725</expDate>
            </updatedCard>
        </accountUpdateResponse>
            <accountUpdateResponse  id=”1235” reportGroup= "MerchantReportGroup01">
            <cnpTxnId>123456789</cnpTxnId>
            <response>000</response>
            <responseTime>2009-12-21T11:37:04</responseTime>
            <message>Approved</message>
            <originalToken>
                <cnpToken>12345678912345</cnpToken>
                <expDate>0721</expDate>
                <type>Visa</type>
                <bin>123456</bin>
            </originalToken>
            <updatedToken>
                <cnpToken>12345622912345</cnpToken>
                <expDate>0725</expDate>
                <type>Visa</type>
                <bin>123456</bin>
            </updatedToken>
            </accountUpdateResponse>
    </batchResponse>
</cnpResponse>

For more details about our Account Updater elements click here.

Completion response codes

The Account Updater completion response code and its associated message (as shown in Account Updater Completion Response Codes) specify whether or not an account number has been changed and what type of change occurred, if any.

  • The Response Code value appears in the <response> element.
  • The Response Message value appears in the <message> element.
  • The Resolution column provides a recommended action.
Response CodeResponse MessageResolution
191The merchant is not registered in the update programEscalate this to your Customer Experience Manager. This indicates a set-up problem that must be resolved prior to submitting another request file.
500The account number was changedSubmit the account number returned in the completion response. The response may also indicate that both the account number and expiration date changed.
501The account was closedContact the cardholder for updated information.
502The expiration date was changedSubmit the expiration date returned in the completion response.
503The issuing bank does not participate in the update program.The Issuer does not participate in the Account Updater program. Submit original card information.
504Contact the cardholder for updated informationContact the cardholder for updated information.
505No match foundThere was no match found in the updated information. Submit the original card information.
506No changes foundSubmit the original card information.