Paywire Developer Guide Developer... · OSBP Developer Guide ... error occurs. Paywire provided sample…

  • View
    217

  • Download
    1

Embed Size (px)

Transcript

  • Paywire Developer Guide Version 3

    May 4, 2018

    Copyright 2018. Paywire, Incorporated. All Rights Reserved.

  • 2

    Table of ContentsOverview .........................................................................................................................................................3OSBP Developer Guide .................................................................................................................................4

    Security Considerations ............................................................................................................................5XML Transaction Specification .................................................................................................................6

    Transaction Response ......................................................................................................................11Sample Token Sales ...............................................................................................................................14Service Availability Ping ........................................................................................................................17Sample Transactions .............................................................................................................................18

    SALE .................................................................................................................................................19CREDIT .............................................................................................................................................21VOID .................................................................................................................................................22

    OSBP Recurring Setup ..........................................................................................................................23Sample Source Code .............................................................................................................................24OSBP Designer Page .............................................................................................................................27Flow Chart ..............................................................................................................................................29

    Checkout Options .........................................................................................................................................30API XML Developer Guide ...........................................................................................................................32

    API XML Specification ............................................................................................................................33Sample Transactions ..............................................................................................................................37

    SALE .................................................................................................................................................38Credit Card Sale .........................................................................................................................39E-Check Sale ..............................................................................................................................41Recurring Payment Setup ..........................................................................................................43Recurring Payment Delete .........................................................................................................44

    VOID .................................................................................................................................................45CREDIT .............................................................................................................................................46FORCE ..............................................................................................................................................48PREAUTH .........................................................................................................................................49GETCASHDISCOUNT ......................................................................................................................50STORETOKEN ..................................................................................................................................51TOKENSALE .....................................................................................................................................52REMOVETOKEN ..............................................................................................................................53BATCHINQUIRY ...............................................................................................................................54CLOSE ..............................................................................................................................................55SEARCHTRANS ...............................................................................................................................56

  • 3

    Overview

    Paywire offers implementations of many specific payment gateways that are as simplistic as possible and aredesigned to be very approachable. The three options that Paywire offers are OSBP (Off Site Buy Page), API(Application Programming Interface), and the checkout page. The Off Site Buy Page tends to be the more commonly used option amongst merchants and developers incomparison to the checkout page and API options. For more information regarding OSBP, please refer to thePaywire OSBP developer guide. The checkout page is the second option to be offered amongst clients by developers. The checkout page is asimplistic way to complete a transaction. A checkout button can even be generated by Paywire by easily contactingsupport@paywire.com. For more information regarding the checkout, please refer to the Checkout Options. The API option allows the developer to use tools strictly to build upon their own personal software application orwebsite page. While API is not used often, it can be of great use if a personal design is wanted to be included by thedeveloper in their software and applications. For more information regarding the structure of API and its information,please refer to the API developer guide.

  • 4

    OSBP Developer Guide

    Introduction "Off Site Buy Page" and "OSBP" are the terms used to describe the global approach to payments made viaecommerce applications. The goal is to collect all credit cards and web ACH information on an externally hostedpage, rather then allowing every department to develop their own unique approach. The goal is to have morestandardization and better security. Paywire is charged with developing a consistent standard that meets many of the disparate needs of the web sitepayment processing needs. Accordingly, Paywire has developed the following XML specification for the OSBPinterface. Overview The goal is this specification is to make implementation as simple as possible, as many payment gatewayspecifications suffer from over complication. The approach is to use XML imbedded in hidden from fields that aretransmitted using SSL. Once this XML is posted to the OSBP server, a page is displayed for the customer to inputtheir credit card information, and the result is returned to the web application that originates the transaction, also viaXML. Since the OSBP and the Virtual Point of Sale share the same database, transactions originating from the OSBP canbe reported on and reversed from the VPOS.

  • 5

    Security Considerations

    Credit card and payment transaction security practices are appropriate here. No system in and of itself can ensurethat all data is absolutely secure, especially because users can do many things to bypass even the best securitysystem or policy. The following is a list of user practices to consider when using this system:

    Keep all passwords and keys used to access the system in a safe location. Train users of the system not to retain written records of card data unless absolutely necessary, and if it isnecessary to retain such written documentation, store it in safe location. No card data should be stored in a digital format under any circumstances. Good anti-virus and anti-spyware should be installed on each work station and this should be monitoredand updated on a regular basis. Good network segmentation practices should be followed such that card data is being input in as small anetwork infrastructure as feasible. All sensitive data such as keys, user names and passwords transmitted to the OSBP should be generatedserver side, such that no sensitive information is ever visible in plain text in the pages content.

    The Paywire OSBP system does not store any card data. All the card data is represented in the system using uniquetokens or identifiers derived from the credit card gateway. All subsequent credits, voids, reports, or anything elserequiring actions on previously entered card data, use the token or a masked card number. The OSBP is therefore not a payment gateway, but rather a standardized and secure interface to a paymentgateway.

  • 6

    XML Transaction Specification

    Paywire provides a website to test, create, and/or generate XML. You can either fill in each box or use the samplebuttons shown below. Click Generate XML and Direct Send when you are done. This will post your XML to ourstaging URL. Once the 4 credentials authenticate, you will be redirected to the payment entry page. After a paymenthas been entered and you click process, response XML is posted back to t