DOCSLIB.ORG

Optimal Payments Hosted Payments API Reference Guide

Total Page：16

File Type：pdf, Size：1020Kb

Download full-text PDF Read full-text
Optimal Payments Hosted Payments API Reference Guide Optimal Payments Hosted Payments API Reference Guide December 2014 1.3.4 This manual and accompanying electronic media are proprietary products of Optimal Payments plc. They are to be used only by licensed users of the product. © 1999–2015 Optimal Payments plc. All rights reserved. The information within this document is subject to change without notice. The software described in this document is provid- ed under a license agreement, and may be used or copied only in accordance with this agreement. No part of this manual may be reproduced or transferred in any form or by any means without the express written consent of Optimal Payments plc. All other names, trademarks, and registered trademarks are the property of their respective owners. Optimal Payments plc makes no warranty, either express or implied, with respect to this product, its merchantability or fitness for a particular purpose, other than as expressly provided in the license agreement of this product. For further information, please contact Optimal Payments plc. International Head Office 3500 de Maisonneuve W., Suite 700 Montreal, Quebec H3Z 3C1 Canada Tel.: (514) 380-2700 Fax: (514) 380-2760 Email: [email protected] Technical support: [email protected] Web: www.optimalpayments.com U.K. Office Compass House, Vision Park Chivers Way, Histon Cambridge CB24 9AD United Kingdom Email: [email protected] Technical Support: [email protected] Web: www.optimalpayments.com U.S. Office 1209 Orange Street Wilmington, DE 19801 Gatineau Office 75 Promenade du Portage Gatineau, Quebec J8X 2J9 Canada Release Notes Release Notes Version Date Details 1.3.4 December 2014 • Added Pingit functionality 1.3.3 October 2014 • Added accordD functionality for select merchants 1.3.2 May 2014 • Added authCode parameter to order status response table and to Return Keys appendix • Updated HTML example in ThreatMetrix appendix • Added functionality for Giropay, NETELLER, PayPal, Sofort Banking and Ukash • Updated extended options key/value pairs table • Updated values for transaction.status parameter 1.3.1 February 2014 • Added MasterPass functionality • Updated extended options key/value pairs table 1.3 October 2013 • Updated extended options key/value pairs table • Added section for rebilling with a profile • Added silent post for prepaid cards • Added ThreatMetrix appendix. • Add optional delimiter for redirects and callbacks • Corrected rebill examples to include currencyCode • Added error message for updating a transaction • Added orderTimeout extended option and error message 1.2 May 2013 • Updated Return Keys appendix • Added Test and Production URLs section • Added section for updating an order • Removed Order/Response Examples appendix • Added section for rebilling • Added parameters to shipping details table • Added parameters to order status response table • Updated error response table • Added four appendices • Updated extended options key/value pairs table 1.1 March 20, 2013 • Added customer profiles • Added mobile functionality • Added return keys table • Added key/value pairs 1.0 January 1, 2013 Document release Optimal Payments Hosted Payments API Reference Guide 1.3.4 III December 2014 IV Contents 1 Hosted Payments API Overview . 1-1 API key. 1-1 URLs . 1-2 Test URL . 1-2 Production URL . 1-2 Workflow overview . 1-2 Mobile capability . 1-2 Operations supported. 1-3 Using this guide . 1-3 Audience . 1-3 Functionality. 1-3 Symbols . 1-3 Setting up an order. 1-4 Adding details to your order request . 1-5 Customer profiles . 1-5 Profile object example 1 . 1-6 Profile object example 2 . 1-6 Profile object example 3 . 1-7 Shopping cart information . 1-7 Ancillary fee information. 1-8 Billing detail information. 1-8 Shipping details . 1-9 Callbacks . 1-11 Redirects . 1-12 Links. 1-13 Payment methods. 1-14 Payment method notes . .1-15 Addendum data . 1-16 addendumData for MasterPass. 1-17 Localisation . 1-17 Finance plan. 1-18 Order response . 1-18 Making a payment . 1-20 Optimal Payments Hosted Payments API Reference Guide 1.3.4 V December 2014 Making a payment using a silent post . 1-21 Silent post for prepaid cards. 1-21 Silent post for credit cards . 1-22 Silent post for Giropay . 1-23 Silent post for iDEAL . 1-23 Silent post for NETELLER . 1-24 Silent post for Sofort Banking . .1-24 Silent post for Ukash . 1-24 Silent post for other supported payment methods . 1-24 Making a payment using customer profile . 1-25 Making a payment using a Hosted Payments customer profile . 1-25 Making a silent post payment using a customer profile . 1-26 Rebilling . 1-26 Rebilling with a profile . 1-27 Rebill request response. 1-27 Cancelling an order . 1-27 Cancel order response . ..
Load more

Recommended publications
  • Secure Online Bank Transfers Giropay Was Introduced in 2006 and Is Supported by More Than 1,500 German Banks
    WL Online Payment Acceptance giropay secure online bank transfers giropay was introduced in 2006 and is supported by more than 1,500 German banks. It is a popular acceptance method for merchants, because it gives their customers a quick, easy to use and secure online method to pay for goods and services via their own bank account. With giropay merchants are guaranteed their funds and they will greatly benefit from not having to deal with chargebacks. In addition, giropay is an excellent alternative payment method that can be offered to those shoppers that do not have or desire to use their credit card online. Shoppers feel comfortable and secure because their payment is facilitated by their own bank, which eliminates the risk of fraud or default. Furthermore, a giropay transaction is free of charge for the shopper, and their transaction history and payment details can be viewed in their own banking reports. With a population size of over 82 million people, giropay represents a significant portion of Germany’s online payment traffic (35 million potential shoppers). Germany is ranked 5th in the world in terms of online sales, with alternative payments being strongly preferred to card payments. 60% of the population (48.5 million) shop online, of which 14.1 million shop cross-border. giropay offers high level of security, real-time confirmation of payment authorization and possibility of immediate shipping of goods. Features • Payment method type: Internet Bank Payment (IBP) • Solution type: Full ServicePremium • Presentment/Settlement currency: € • Supported Integration: Payment Page, Web Service API • Recurring Payments: No • Chargebacks: No • Refunds: No.
    [Show full text]
  • Sparkassen-Internetkasse Giropay Connection for Traders and Integrators Sparkassen-Internetkasse Giropay Connection for Traders and Integrators
    Internetkasse Title Page Sparkassen-Internetkasse giropay Connection for traders and integrators Sparkassen-Internetkasse giropay Connection for traders and integrators This document relates to Sparkassen-Internetkasse version 1.2. Revision: 1.4 Date of issue: 13/04/2016 Section “Initialisation”, p. 14 and Section “Online bank transfer initiali- sation”, p. 26: bankcode and bic are optional. Section “Refund”, p. 17: added note which bank account details are required. Removed obsolete chapter “Bank code/BIC search”. Revision: 1.3.6 Date of issue: 13/05/2015 Section “Refund”, p. 17: accountholder is mandatory. Revision: 1.3.4 Date of issue: 14/04/2014 Section “Bank code/BIC check”, p. 15: removed rc=2 and obsolete text. Section “Initialisation”, p. 14 and Section “Online bank transfer initiali- sation”, p. 26: submitting account or accountnumber respectively and bankcode is still possible after 31/01/2014. Revision: 1.3.3 Date of issue: 04/02/2014 Section “Bank code/BIC check”, p. 15: correction: bankcode is possible after 01/02/2014. Section “Test data”, p. 38: updated some of the IBANs. Revision: 1.3.2 Date of issue: 28/11/2013 Section “Bank code/BIC check”, p. 15: added note that giropay transac- tions might only be possible with account number and bank code. Revision: 1.3.1 Date of issue: 15/10/2013 Section “Function description”, p. 8: added note that only German bank accounts are accepted. Section “Test data”, p. 38: corrected some of the IBANs. Revision: 1.3 Date of issue: 24/09/2013 Added age verification, add-ons and modifications for SEPA payments in Section “Initialisation”, p.
    [Show full text]
  • How People Pay Australia to Brazil
    HowA BrandedPay™ StudyPeople of Multinational Attitudes Pay Around Shopping, Payments, Gifts and Rewards Contents 01 Introduction 03 United States 15 Canada 27 Mexico 39 Brazil 51 United Kingdom 63 Germany 75 Netherlands 87 Australia 99 Changes Due to COVID-19 This ebook reflects the findings of online surveys completed by 12,009 adults between February 12 and March 17, 2020. For the COVID-19 addendum section, 1,096 adults completed a separate online survey on May 21, 2020. Copyright © 2020 Blackhawk Network. There are also some trends that are impossible to ignore. Shopping and making payments through entirely digital channels is universal and growing, from How People Pay Australia to Brazil. A majority of respondents in every region say that they shop online more often than they shop in stores. This trend is most pronounced in younger generations and in Latin American countries, but it’s an essential fact Our shopping behaviors are transforming. How people shop, where they shop and across all demographic groups and in every region. how they pay are constantly in flux—and the trends and patterns in those changes reveal a lot about people. After all, behind all of the numbers and graphs are the In the rest of this BrandedPay report, you’ll find a summary and analysis of trends people. People whose varied tastes, daily lives and specific motivations come in each of our eight surveyed regions. We also included a detailed breakdown of together to form patterns and trends that shape global industries. how people in that region answered the survey, including any traits specific to that region.
    [Show full text]
  • Terms and Conditions
    Terms and Conditions April 3 2018 _EN 3 0 - 4 0 - 8 GMBH_TER_0008_201 EVO Terms and Conditions I. General Terms and Conditions Table of Contents I. General Terms and Conditions ........................................................................................................................................................................................................ 3 II. Definitions ......................................................................................................................................................................................................................................... 9 III. Service-Related Terms and Conditions ...................................................................................................................................................................................... 13 i. Card Acceptance ...................................................................................................................................................................................................................................................... 13 a. General ...................................................................................................................................................................................................................................................................... 13 b. Remote Business, Card-not-present (CNP) .....................................................................................................................................................................................................
    [Show full text]
  • Paypipe Integration
    Grillparzerstraße 18 81675 Munich Germany P +49 (89) 45 230 - 291 F +49 (89) 45 230 – 099 [email protected] PAY.ON Platform Documentation PayPipe Integration Release 1.5.5 PayPipe Documentation – XML Integrator 1 Grillparzerstraße 18 81675 Munich Germany P +49 (89) 45 230 - 291 F +49 (89) 45 230 – 099 [email protected] Release History Release Description Date Changes 0.9.0 Alpha Version 0.9.1 Beta Version 0.9.2 Minor Release 0.9.3 Minor Release 2009-01-27 Return codes, brands, changes in request and response messages 0.9.4 Minor Release 2009-02-05 Recurring Payment, Connection to PayPipe, Certification process 0.9.5 Minor Release 2009-04-04 Recurring Payment changes, XML samples changes 1.0.0 Major Release 2009-05-01 Changes to Certification Process 1.0.1 Minor Release 2009-05-23 Changes to Customer Required Field Definiitions 1.0.2 Minor Release 2009-06-22 Extensions to AVS Support 1.0.3 Minor Release 2009-07-13 Added new certification tests for swiss francs (CHF) 1.1.0 Major Release 2009-08-01 New Return Codes 1.1.1 Minor Release 2009-09-30 New TransactionCategories: MAIL_ORDER and TELEPHONE_ORDER as required by several acquirers 1.1.2 Minor Release 2009-10-20 New Brand MILESANDMORE 1.1.3 Minor Release 2009-10-29 Better description of common used terms 1.1.4 Minor Release 2009-11-08 More information on payment types 1.2.0 Major Release 2009-11-12 Added new certification tests for currencies, recurring and 3DSecure 1.2.1 Minor Release 2010-01-25 Added PayPipe HTTP Access error codes Appendix A.4 1.2.2 Minor Release 2010-04-21 Changes
    [Show full text]
  • Skrill Quick Checkout Integration Guide
    Skrill Quick Checkout Integration Guide For use by Skrill eCommerce merchants using Quick Checkout This guide describes how to integrate with Skrill Quick Checkout. www.skrill.com Version 7.9 Skrill Limited, 25 Canada Square, Canary Wharf, London, E14 5LQ, UK Copyright © 2017. Skrill Ltd. All rights reserved. The material contained in this guide is copyrighted and owned by Skrill Ltd together with any other intellectual property in such material. Except for personal and non-commercial use, no part of this guide may be copied, republished, performed in public, broadcast, uploaded, transmitted, distributed, modified or dealt with in any manner at all, without the prior written permission of Skrill Ltd, and, then, only in such a way that the source and intellectual property rights are acknowledged. To the maximum extent permitted by law, Skrill Ltd shall not be liable to any person or organisation, in any manner whatsoever from the use, construction or interpretation of, or the reliance upon, all or any of the information or materials contained in this guide. The information in these materials is subject to change without notice and Skrill Ltd. assumes no responsibility for any errors. Skrill Ltd. Registered office: Skrill Limited, 25 Canada Square, Canary Wharf, London, E14 5LQ, UK. Version Control Table Date Version Description September 2013 6.2 New guide template and updated content, including new Quick Checkout pages. October 2013 6.3 Changes to description of Payment Method Codes appendix. November 2013 6.4 Removal of Latvian currency. December 2013 6.5 Addition of credit card brands when passing payment methods, plus new screenshots.
    [Show full text]
  • Online Bank Transfers Using the Simple Order
    Title Page Online Bank Transfers Using the Simple Order API Cybersource Contact Information For general information about our company, products, and services, go to http://www.cybersource.com. For sales questions about any Cybersource service, email [email protected] or call 650-432-7350 or 888- 330-2300 (toll free in the United States). For support information about any Cybersource service, visit the Support Center: http://www.cybersource.com/support Copyright © 2020. Cybersource Corporation. All rights reserved. Cybersource Corporation ("Cybersource") furnishes this document and the software described in this document under the applicable agreement between the reader of this document ("You") and Cybersource ("Agreement"). You may use this document and/or software only in accordance with the terms of the Agreement. Except as expressly set forth in the Agreement, the information contained in this document is subject to change without notice and therefore should not be interpreted in any way as a guarantee or warranty by Cybersource. Cybersource assumes no responsibility or liability for any errors that may appear in this document. The copyrighted software that accompanies this document is licensed to You for use only in strict accordance with the Agreement. You should read the Agreement carefully before using the software. Except as permitted by the Agreement, You may not reproduce any part of this document, store this document in a retrieval system, or transmit this document, in any form or by any means, electronic, mechanical, recording, or otherwise, without the prior written consent of Cybersource. Restricted Rights Legends For Government or defense agencies: Use, duplication, or disclosure by the Government or defense agencies is subject to restrictions as set forth the Rights in Technical Data and Computer Software clause at DFARS 252.227-7013 and in similar clauses in the FAR and NASA FAR Supplement.
    [Show full text]
  • Alternative Payment Methods
    ALTERNATIVE PAYMENT METHODS A Det a i l e d Ha n d b o o k An introduction Welcome to Payyo’s handbook for alternative payment methods! Here you will find everything you need to know about payment methods apart from Credit Cards. We explain why using alternative payment methods is beneficial for your business and we introduce you in detail to all payment methods Payyo offers. Payyo is constantly working on expanding the range of different APM, according to the needs of clients. Did you know that approximately 6% of customers end an online transaction because their preferred payment method is not available? Some sources even claim that this percentage is higher if only credit cards are offered as a payment method. As a payment partner for platforms, SaaS and marketplaces in the travel and leisure industry, we are aware how important an online payment flow of high quality and the resulting conversion Why using for a merchant is. Conversion means the ratio when a website visitor turns into a customer, in this case, in successfully completing a payment. alternative There are different factors related to higher conversion rates. Looking at the mere checkout process, there are a lot of technical payment aspects that drive or decrease conversion. But also, the number of available payment methods is an important asset for a merchant’s turnover. It is even possible to access new markets with additional methods? local payment methods in the checkout. To help their clients grow, Payyo considered this topic and solved the problem of an insufficient conversion rate by adding relevant payment methods for merchants and their customers.
    [Show full text]
  • Payment, Clearing and Settlement Systems in Germany
    Payment, clearing and settlement systems in Germany CPSS – Red Book – 2012 159 Germany Contents List of abbreviations ........................................................................................................... 163 Introduction – main recent developments ........................................................................... 165 Large-value payment systems .................................................................................. 165 Retail payment systems ............................................................................................ 165 Securities trading, clearing and settlement................................................................ 165 1. Institutional aspects .................................................................................................. 166 1.1 The general institutional framework ................................................................. 166 1.1.1 Legal requirements ................................................................................. 166 1.1.2 Rules governing payment services ......................................................... 167 1.2 The role of the Deutsche Bundesbank ............................................................. 167 1.2.1 Cooperative nature of payment systems policy ....................................... 168 1.2.2 Oversight function regarding payment and securities settlement systems .................................................................................................. 169 1.2.3 Payment systems of the Bundesbank
    [Show full text]
  • A Guide to Payment Methods
    A guide to payment methods Businesses can use this guide to discover, understand, and select the right payment methods for them to reach a broader audience. By Gabriel Hubert Last updated on June 20, 2017 Introduction Supported by widespread access to high speed internet and the insatiable appetite of customers for convenience, online commerce is progressing rapidly around the world and estimated to reach $4T (Source: eMarketer) in 2020. But when it comes to payments online, businesses expanding internationally and taking advantage of the increased reach that online commerce provides them with are met with widely varying customer preferences. Not only can delivery terms be quite different (pay after delivery, for example, common in Europe and Asia, requires businesses to only expect payment once they’ve shipped goods) but the payment methods used for online transactions themselves vary too. Credit and debit cards, not always the most trusted option, only account for half of online transactions globally. Bank payments, digital wallets, and cash are in strong customer demand, and can even offer additional benefits to businesses such as lower risks and transaction costs. To fully realize the potential of online commerce, businesses must adapt to an eclectic audience and harness this diversity of payment preferences. This guide underlines the characteristics of payment methods that intrinsically determine their relevance to a given business model, helps identify questions that businesses should ask when considering adding payment methods to their checkout, and provides an overview of the payment methods Stripe supports. 1. Deciding on the right payment methods As businesses seek to increase their audience, robust payment method coverage can play the role of a catalyst.
    [Show full text]
  • CCV Ultimate Guide to Online Payments 1 Table of Contents
    CCV Ultimate Guide to Online Payments 1 Table of Contents 03 Introduction 04 Online Payments: Everything You Need to Know 05 Popular Payment Methods for Your eCommerce Store 08 How Exactly Does Online Payment Work? 09 What is a Payment Service Provider (PSP)? 10 What are the Benefits of Online Payment? 13 How Much Does Online Payment Cost? 15 CCV as your payment partner 2 CCV Ultimate Guide to Online Payments Introduction iDEAL, credit card, Apple Pay or PayPal. There are numerous online payment methods. In the past, an online payment was only possible with a credit card. Now, new payment methods are springing up like mushrooms. This is great for consumers, because they can pay as they please. But it is also confusing for you as an entrepreneur, because which payment methods do you offer in your webshop? CCV Ultimate Guide to Online Payments 3 Online Payments: Everything You Need to Know Online payment was once limited to credit and debit cards alone. Today, however, there are literally hundreds of ways for consumers to pay online. These include Apple Pay, Google Pay, PayPal, iDEAL (in the Netherlands), Bancontact (in Belgium), Giropay (in Germany and Austria), and more – plus a multitude of gift card schemes and vouchers. In this section, we’ll look at some of these options in more detail, before explaining how online payment works, the benefits of accepting payment online, and how much it costs to start selling on the web. 4 CCV Ultimate Guide to Online Payments Popular Payment Methods for Your eCommerce Store Visa Visa is the largest global card network in the world.
    [Show full text]
  • Alternative Payment Methods
    Alternative Payment Methods Global Coverage September 28th, 2021 Global Coverage Alternative Payment Methods International Payment Methods The International Payment Methods overview lists the brands for each type of payment method that is available in more than one region. Brands that are only available in one region are listed in the Alternative Payment Methods by Region section. PAYMENT METHODS BRANDS Credit Card American Express JCB China UnionPay Mastercard Diners/Discover Visa Debit Card China UnionPay Debit Visa Debit Maestro Visa Electron MasterCard Debit VPay Prepaid Card paysafecard Wallet AliPay PayPal CashU Qiwi Neteller Skrill OneCard TenPay Virtual Currency Bitcoin Mobile Payment DaoPay (all network operators connected via DaoPay) Kanzaroo Cash Payments dLocal Online Transfer dLocal Online Transfer Miles Lufthansa Miles and More © September 28th, 2021 ACI Worldwide. All rights reserved. _|_ globalcoverage.aciworldwide.com Page 2 of 22 Global Coverage Alternative Payment Methods Alternative Payment Methods by Region The Alternative Payment Methods by Region section lists every brand available for each payment method, grouped by region. Brands that are available in more than one region are listed in the International Payment Methods section. Africa PAYMENT METHODS BRANDS Virtual Currency Bitcoin Wallet AliPay PayPal OneCard Skrill ETHIOPIA PAYMENT METHODS BRANDS Wallet CBE Wallet SWAZILAND PAYMENT METHODS BRANDS Wallet MasterPass Asia PAYMENT METHODS BRANDS Virtual Currency Bitcoin Wallet AliPay Skrill OneCard TenPay PayPal
    [Show full text]