Payment response parameters

Details of all possible parameters that are posted to you in the body of the Payment Message:

Parameter nameDescription
Parameters generated by the Purchase Token
instIdID for the installation.
cartIdYour own reference number for the order.
descA textual description of the payment (up to 255 characters). Note that for recurring payment response the desc parameter includes the word FuturePay as well as the payment number and FuturePay Agreement ID.
For examples that show how the desc parameter is formatted for a one-time payment and a payment made within a FuturePay agreement, seeCallback examples.
costA decimal number giving the cost of the purchase in terms of the major currency unit e.g. 12.56 would mean 12 pounds and 56 pence if the currency were GBP (Pounds Sterling).

Note:This is a legacy parameter. Do not use this parameter in server-side scripts.

amountA decimal number giving the cost of the purchase in terms of the major currency unit e.g. 12.56 would mean 12 pounds and 56 pence if the currency were GBP (Pounds Sterling).
amountStringAn HTML string produced from the amount and currency that is submitted to initiate the payment.
currency3 letter ISO code for the currency of this payment.
authModeSpecifies the authorisation mode used. The values are "A" for a full auth, or "E" for a pre-auth.
testModeA value of 100 specifies a test payment and a value of 0 (zero) specifies a live payment.
Specify the test result you want by entering REFUSED, AUTHORISED, ERROR or CAPTURED in the name parameter.
nameThe Shopper's full name, including any title, personal name and family name. Note that if your purchase token does not contain a name value, the name that the cardholder enters on the payment page is returned to you.
address1The first line of the shopper's address. Separators (including new line) used in this parameter are encoded as ASCII characters.
address2The second line of the shopper's address.
address3The third line of the shopper's address.
townShopper’s city or town.
regionShopper’s country/ region/ state or area.
postcodeShopper's postcode.
countryShopper's country, as 2 character ISO code, upper case.
countryStringThe full name of the country, derived from the country code submitted or supplied by the shopper in the language used by the shopper on the payment page.
telShopper's telephone number.
faxShopper's fax number.
emailShopper's email address.
delvNameShopper's delivery name.

Note:The parameter withDeliverymust be submitted in the purchase token for you to receive this parameter in the Payment Message.

delvAddress1Shopper's delivery address1.

Note:The withDelivery parameter must be submitted in the purchase token for you to receive this parameter in the Payment Message.

delvAddress2Shopper's delivery address 2.

Note: The withDelivery parameter must be submitted in the purchase token for you to receive this parameter in the Payment Message.

delvAddress3Shopper's delivery address 3.

Note: The withDelivery parameter must be submitted in the purchase token for you to receive this parameter in the Payment Message.

delvTownShopper's delivery town or city.

Note: The withDelivery parameter must be submitted in the purchase token for you to receive this parameter in the Payment Message.

delvRegionShopper's delivery county/state/region.

Note: The withDelivery parameter must be submitted in the purchase token for you to receive this parameter in the Payment Message.

delvPostcodeShopper's delivery postcode.

Note: The withDelivery parameter must be submitted in the purchase token for you to receive this parameter in the Payment Message.

delvCountryShopper's delivery country, as 2 character ISO code, uppercase.

Note:The withDelivery parameter must be submitted in the purchase token for you to receive this parameter in the Payment Message.

delvCountryStringThe full name of the country, derived from the country code submitted or supplied by the shopper for the delivery address in the language used by the shopper on the payment page.

Note:The withDelivery parameter must be submitted in the purchase token for you to receive this parameter in the Payment Message.

compNameName of the company associated with this installation.
Payment Response parameters
transIdID for the transaction.
transStatusResult of the transaction - "Y" for a successful payment authorisation, "C" for a cancelled payment.

Note:There is also a value "N", which indicates a declined recurring payment (FuturePay) transaction.

transTimeTime of the transaction in milliseconds since the start of 1970 GMT. This is the standard system date in Java, and is also 1000x the standard C time_t time.
authAmountAmount that the transaction is authorised for, in the currency given as authCurrency.
authCostAmount that the transaction is authorised for, in the currency given as authCurrency.

Note:This is a legacy parameter. Do not use this parameter in any server-side scripts.

authCurrencyCurrency used for authorisation.
authAmountStringHTML string produced from authorisation amount and currency.
rawAuthMessageThe text received from the bank summarising the different states listed below:
  • cardbe.msg.authorised - Make Payment (test or live)
  • trans.cancelled - Cancel Purchase (test or live)
rawAuthCodeA single-character bank authorisation code. This is retained for backward compatibility. 'A' means 'authorised' and is directly equivalent to transStatus='Y'.
callbackPWPayment Response password set in the Merchant Interface.
cardTypeType of payment method used by the shopper.
countryMatchA single character describing the result of the comparison of the cardholder country and the issue country of the card used by the shopper (where available). Note that this parameter is retained for backward compatibility - equivalent information is now provided as part of the AVS results. The result possible values are:
  • Y - match
  • N - no match (i.e. mismatch)
  • B - comparison not available
  • I - contact country not supplied
  • S - card issue country not available
AVSA 4-character string giving the results of 4 internal fraud-related checks. The characters respectively give the results of the following checks:
  • 1st character - Card Verification Value check
  • 2nd character - postcode AVS check
  • 3rd character - address AVS check
  • 4th character - country comparison check (see also countryMatch)
The possible values for each result character are:
  • 0 - Not supported
  • 1 - Not checked
  • 2 - Matched
  • 4 - Not matched
  • 8 - Partially matched
wafMerchMessageIf you have Risk Management enabled, you receive one of the fraud messages listed below:
  • waf.warning = Warning
  • waf.caution = Caution
For more detailed explanation about the fraud message, refer to the Risk Management Service Guide.
authenticationIf you enrolled to the Verified By Visa, MasterCard SecureCode or American Express SafeKey authentication schemes you receive one of the authentication messages listed below:
  • ARespH.card.authentication.0 = Cardholder authenticated
  • ARespH.card.authentication.1 = Cardholder/Issuing bank not enrolled for authentication
  • ARespH.card.authentication.6 = Cardholder authentication not available
  • ARespH.card.authentication.7 = Cardholder did not complete authentication
  • ARespH.card.authentication.9 = Cardholder authentication failed
For more detailed explanation about the authentication messages, refer to the Card Authentication Guide.
ipAddressThe IP address from which the purchase token was submitted.
charencThe character encoding used to display the payment page to the shopper.
_SP.charEncAs charenc.
Recurring Payment parameters
futurePayIdID for the Recurring Payments agreement.
futurePayStatusChangeThe status of the agreement, set to either Merchant Cancelled or Customer Cancelled depending if the merchant or the shopper has cancelled the agreement.

Note: These are not included in the payment message: MD5 signature and signatureFields. Optional parameters authValidFrom and authValidTo. Any of your own variables labelled with the prefix C_. Any payment page appearance parameters including: fixContact, hideContact, lang, noLanguageMenu, withDelivery, subst.

Examples

Example: One-time payment

The following callback example shows a message returned for an authorised one-time payment.

Copied!
POST /fail?installation=XXXXXX&msgType=authResult HTTP/1.0Content-Type: application/x-www-form-urlencoded; charset=UTF-8Host: www.worldpay.comContent-Length: 973User-Agent: WJHRO/1.0 (WorldPay Java HTTP Request Object)region=new+format+region&authAmountString=%26%23163%3B10.00&_SP.charEnc=UTF-8&desc=&tel=&address1=new+format+address1&countryMatch=N&cartId=15615166165&address2=new+format+address2&address3=new+format+address3&town=city&region=county&callbackPW=&lang=en&rawAuthCode=A&transStatus=Y&amountString=%26%23163%3B10.00&authCost=10.00&currency=GBP&installation=205844&amount=10.00&wafMerchMessage=waf.warning&countryString=United+Kingdom&displayAddress=new+format+address1%0Anew+format+address2%0Anew+format+address3%0Anew+format+town%0Anew+format+region&transTime=1313762603546&name=AUTHORISED&testMode=0&ipAddress=192.168.90.15&fax=&rawAuthMessage=cardbe.msg.authorised&instId=205844&AVS=2004&compName=BG+Address+change&authAmount=10.00&postcode=postcode&cardType=Visa&cost=10.00&authCurrency=GBP&country=GB&charenc=UTF-8&email=test%40test.worldpay.com&address=new+format+address1%0Anew+format+address2%0Anew+format+address3&transId=1300002227&msgType=authResult&town=new+format+town&authMode=A

Example: Payment made within a FuturePay agreement

For an authorised payment made within a FuturePay agreement, the desc parameter includes the following:

  • The Payment X of FuturePay agreement ID XXXXXXX string, where:

  • X is the payment number made within the agreement.

  • XXXXXXX is the FuturePay Agreement Id.

  • The &futurePayId= parameter.

The example below shows a FuturePay callback message, with the sensitive data removed:

Copied!
POST /fail?installation=XXXXXX&msgType=authResult HTTP/1.0Content-Type: application/x-www-form-urlencoded; charset=UTF-8Host: www.website.co.ukContent-Length: 800User-Agent: WJHRO/1.0 (WorldPay Java HTTP Request Object)region=&authAmountString=%26%23163%3B59.99&_SP.charEnc=UTF-8&desc=Payment+X+of+FuturePay+agreement+ID+XXXXXXX&tel=0770+XXX+XXXX&address1=&countryMatch=S&cartId=CartId&address2=&address3=&lang=en&callbackPW=&rawAuthCode=A&amountString=%26%23163%3B59.99&transStatus=Y&authCost=59.99&currency=GBP&installation=XXXXXX&amount=59.99&countryString=United+Kingdom&displayAddress=20+Test+Road&name=Mr+Smith&testMode=0&transTime=1343438417376&routeKey=ECMC-SSL&ipAddress=&fax=&rawAuthMessage=cardbe.msg.authorised&instId=XXXXXX&AVS=0111&compName=Company+Ltd&futurePayId=XXXXXXX&authAmount=59.99&postcode=XXXXXX&cardType=MasterCard&cost=59.99&authCurrency=GBP&country=GB&charenc=UTF-8&email=mail%40test.com&address=20+Test+Road&transId=XXXXXX&msgType=authResult&town=&authMode=A