Credit Request for a Worldpay Processed Transaction

You must specify the Credit request for a Worldpay processed transaction as follows. The structure of the request is identical for either an Online or a Batch submission.

<credit id="Credit Id" reportGroup="iQ Report Group" customerId="Customer Id">

<cnpTxnId>Transaction Id</cnpTxnId>

<orderId>New order Id</orderId>

<amount>Authorization Amount</amount>

<secondaryAmount>Secondary Amount</secondaryAmount>

<surchargeAmount>Amount of Surcharge</surchargeAmount>

<additionalCOFData>

<customBilling>

<processingInstructions>

<actionReason>SUSPECT_FRAUD</actionReason>

<businessIndicator>consumerBillPayment</businessIndicator>

</credit>

Example: Batch Credit Request for a Worldpay Processed Transaction

To request a Credit against a sale settled by us, you only need to specify the <cnpTxnId> element. The application uses the <cnpTxnId> to look-up the Capture referenced and obtain all the necessary information including the amount.

Although it is not required, if you choose to include <amount> elements in your Credit transaction, you must include the total amount in the creditAmount attribute of the <batchrequest>. If you do not specify amounts, set the creditAmount attribute to 0.

<cnpRequest version="12.0" xmlns="http://www.vantivcnp.com/schema" id="123" numBatchRequests="1">

<authentication>

<user>userName</user>

<password>password</password>

</authentication>

<batchRequest id="01234567" numAuths="0" authAmount="0" numCaptures="0" captureAmount="0" numCredits="1" creditAmount="10000" numSales="0" saleAmount="0" merchantId="100">

<credit id="AX54321678" reportGroup="RG27">

<cnpTxnId>84568456</cnpTxnId>

<amount>10000</amount>

<enhancedData>

<customerReference>PO12345</customerReference>

<salesTax>125</salesTax>

<taxExempt>false</taxExempt>

<discountAmount>0</discountAmount>

<shippingAmount>3017</shippingAmount>

<dutyAmount>0</dutyAmount>

<shipFromPostalCode>01851</shipFromPostalCode>

<destinationPostalCode>01851</destinationPostalCode>

<destinationCountryCode>USA</destinationCountryCode>

<invoiceReferenceNumber>123456</invoiceReferenceNumber>

<orderDate>2016-09-14</orderDate>

<detailTax>

<taxIncludedInTotal>true</taxIncludedInTotal>

<taxAmount>55</taxAmount>

<taxRate>0.0059</taxRate>

<taxTypeIdentifier>00</taxTypeIdentifier>

<cardAcceptorTaxId>011234567</cardAcceptorTaxId>

</detailTax>

<lineItemData>

<itemSequenceNumber>1</itemSequenceNumber>

<itemDescription>chair</itemDescription>

<productCode>CH123</productCode>

<quantity>1</quantity>

<unitOfMeasure>EACH</unitOfMeasure>

<taxAmount>125</taxAmount>

<lineItemTotal>9380</lineItemTotal>

<lineItemTotalWithTax>9505</lineItemTotalWithTax>

<itemDiscountAmount>0</itemDiscountAmount>

<commodityCode>300</commodityCode>

<unitCost>93.80</unitCost>

<detailTax>

<taxIncludedInTotal>true</taxIncludedInTotal>

<taxAmount>55</taxAmount>

<taxRate>0.0059</taxRate>

<taxTypeIdentifier>03</taxTypeIdentifier>

<cardAcceptorTaxId>011234567</cardAcceptorTaxId>

</detailTax>

</lineItemData>

</enhancedData>

</credit>

</batchRequest>

</cnpRequest>

Example: Online Credit Request for a Worldpay Processed Transaction

To request a Credit against a sale settled by us, you need only specify the <cnpTxnId> element. The application uses the <cnpTxnId> to look up the Capture referenced and obtain all the necessary information including the amount. The example below includes the optional <customBilling> and <enhancedData> elements.

<cnpOnlineRequest version="12.0" xmlns="http://www.vantivcnp.com/schema" merchantId="100">

<authentication>

<user>User Name</user>

<password>password</password>

</authentication>

<credit id="2" reportGroup="ABC Division" customerId="038945">

<cnpTxnId>13254123434</cnpTxnId>

<customBilling>

<phone>8888888888</phone>

<descriptor>descriptor</descriptor>

</customBilling>

<enhancedData>

<customerReference>PO12345</customerReference>

<salesTax>125</salesTax>

<taxExempt>false</taxExempt>

<discountAmount>0</discountAmount>

<shippingAmount>495</shippingAmount>

<dutyAmount>0</dutyAmount>

<shipFromPostalCode>01851</shipFromPostalCode>

<destinationPostalCode>01851</destinationPostalCode>

<destinationCountryCode>USA</destinationCountryCode>

<invoiceReferenceNumber>123456</invoiceReferenceNumber>

<orderDate>2016-07-14</orderDate>

<detailTax>

<taxIncludedInTotal>true</taxIncludedInTotal>

<taxAmount>55</taxAmount>

<taxRate>0.0059</taxRate>

<taxTypeIdentifier>00</taxTypeIdentifier>

<cardAcceptorTaxId>011234567</cardAcceptorTaxId>

</detailTax>

<lineItemData>

<itemSequenceNumber>1</itemSequenceNumber>

<itemDescription>chair</itemDescription>

<productCode>CH123</productCode>

<quantity>1</quantity>

<unitOfMeasure>EACH</unitOfMeasure>

<taxAmount>125</taxAmount>

<lineItemTotal>9380</lineItemTotal>

<lineItemTotalWithTax>9505</lineItemTotalWithTax>

<itemDiscountAmount>0</itemDiscountAmount>

<commodityCode>300</commodityCode>

<unitCost>93.80</unitCost>

<detailTax>

<taxIncludedInTotal>true</taxIncludedInTotal>

<taxAmount>55</taxAmount>

<taxRate>0.0059</taxRate>

<taxTypeIdentifier>03</taxTypeIdentifier>

<cardAcceptorTaxId>011234567</cardAcceptorTaxId>

</detailTax>

</lineItemData>

<lineItemData>

<itemSequenceNumber>2</itemSequenceNumber>

<itemDescription>table</itemDescription>

<productCode>TB123</productCode>

<quantity>1</quantity>

<unitOfMeasure>EACH</unitOfMeasure>

<lineItemTotal>30000</lineItemTotal>

<itemDiscountAmount>0</itemDiscountAmount>

<commodityCode>300</commodityCode>

<unitCost>300.00</unitCost>

</lineItemData>

</enhancedData>

</credit>

</cnpOnlineRequest>