Adyen – Open Invoice Version 1.04 Adyen B.V.
Table of Contents Introduction............................................................................................................................................................. 3 Audience............................................................................................................................................................ 3 Changelog..................................................................................................................................................
Introduction Introduction The purpose of this manual is to enable you to submit payments to the Adyen Payment System using the Open Invoice payment method. Audience This is a technical manual aimed at IT personnel involved in integrating merchants' systems with those at Adyen. Changelog Version Date Changes 1.
The Open Invoice Process 1 The Open Invoice Process There are two main options for accepting Open Invoice by the merchant: full risk take over by Adyen , in cooperation with an invoicing partner; or only invoice administration & communication by Adyen, in cooperation with an invoicing partner. In the remainder of this document we will refer to the combination of Adyen and the invoicing partner simply as “Adyen”.
Providing the Personal Shopper Information 2 Providing the Personal Shopper Information For the first step the Merchant has to submit additional data to the Hosted Payment Pages (HPPs) along with the normal payment setup. If the optional additional data is not submitted the shopper can enter this on the HPPs. If it is submitted it will pre-populated. Address Data Supplying the billing address is described in the “Billing Address Pre-Population and AVS” section of the Adyen Merchant Integration Manual.
Providing the Personal Shopper Information Most of these extra fields can be pre-populated by submitting the following fields with the payment request: ● shopper.firstName The first name of the shopper. ● shopper.infix The infix of the shoppers name.. ● shopper.lastName The last name of the shopper. ● shopper.gender The gender of the shopper. Value must be MALE or FEMALE. ● shopper.dateOfBirthDayOfMonth The day value of the date of birth of the shopper. ● shopper.
Providing the Personal Shopper Information SOAP Line Specification Request by Adyen The line specification request contains the following fields: ● merchantAccount The merchant account the payment was processed with. ● amount The original amount that was authorised. ● reference The original reference specified by the merchant when initiating this payment. See Example 1 for an example SOAP request.
Providing the Personal Shopper Information The value in the retrieveDetail request must be equal to the following calculation from the retrieveDetailResponse (in pseudo code): value = 0; for each (InvoiceLine in lines) { value += (itemPrice + itemVAT) * numberOfItems ; } totalValue = value; Figure 2: Pseudo Code for Calculating the Total Value of the Invoice Lines Please note that if the total value of the retrieved invoice lines is not equal to the amount that was requested an error will be displayed to
Sending Capture Modification 3 Sending Capture Modification When the transaction is authorised, and the goods are sent/delivered to the shopper, a capture modification must be submitted to Adyen. This modification triggers the invoice to be sent to the shopper. The merchant is expected to send a capture modification as soon as the goods are shipped. There is no time limit on the time between the authorisation and capture event.
Other Modifications 4 Other Modifications Depending on the selected open-invoicing partner there are several modifications applicable on a open invoice transaction: ● Cancel Cancels the payment before money is collected. This needs to be sent pre-capture. Refund If the money is already collected but the shopper should be credited the refund option refunds (part of) the transaction amount. For example when the shopper returns (part of) his order.
Example Open Invoice Order 5 Example Open Invoice Order Below an example of an open invoice payment of EUR19.50. After the payment is authorised and captured the shopper returns part of the order. Therefore a refund of EUR3.50 must be initiated as well. Authorisation After the shopper has filled in their details on the HPP a call to the Merchants Open Invoice Details Service is done before the payment is processed. See Example 1 for an example of a request.
Example Open Invoice Order Capture When the payment is authorised, and after the goods are sent to the shopper, a Capture Modification for the payment must be sent for the payment amount (EUR19.50). How a Capture Modification request looks like, and where it must be submitted, is described in the Adyen Merchant Integration Manual. When the capture request is processed the same retrieveDetail request is submitted to the Merchants Open Invoice Details Service as with the authorisation (see Example 1).
Example Open Invoice Order PAGE 14Example Open Invoice Order PAGE 15Example Open Invoice Order PAGE 16Appendix A: Production and Test URLs Appendix A: Production and Test URLs Test URLs Open Invoice Detail SOAP Service WSDL https://ca-test.adyen.com/ca/services/OpenInvoiceDetail?wsdl Production URLs Open Invoice Detail SOAP Service WSDL 16 https://ca-live.adyen.com/ca/services/OpenInvoiceDetail?wsdl Copyright © Adyen B.V.
