Docstoc

Payvision Payment Gateway - Advanced Integration

Document Sample
Payvision Payment Gateway - Advanced Integration Powered By Docstoc
					Payvision
 Payment
Processor



Reports API
Rights of use:

COMPLYING WITH ALL APPLICABLE COPYRIGHT LAWS IS THE
RESPONSABILITY OF THE USER. WITHOUT LIMITING THE RIGHTS
UNDER COPYRIGHT, NO PART OF THIS DOCUMENT MAY BE
REPRODUCED, STORED IN INTO A RETRIEVAL SYSTEM, OR
TRANSMITTED IN ANY FORM OR BY ANY MEANS (ELECTRONIC,
MECHANICAL, PHOTOCOPYING, RECORDING, OR OTHERWISE), OR FOR
ANY PURPOSE, WITHOUT THE EXPRESS WRITTEN PERMISSION OF
PAYVISION.


PAYVISION   MAY    HAVE    PATENTS,   PATENT   APPLICATIONS,
TRADEMARKS, COPYRIGHTS, OR OTHER INTELLECTUAL PROPERTY
RIGHTS COVERING SUBJECT MATTER IN THIS DOCUMENT. EXCEPT AS
EXPRESSLY PROVIDED IN ANY WRITTEN LICENSE AGREEMENT FROM
PAYVISION, THE FURNISHING OF THIS DOCUMENT DOES NOT GIVE
YOU ANY LICENSE TO THESE PATENTS, TRADEMARKS, COPYRIGHTS, OR
OTHER INTELLECTUAL PROPERTY.
Payvision


Project:                  Payvision 2.0
Title:                    Payvision Payment Processor – Reports API
Reference code:           PVES PV2 PPRA
Version:                  1.0
Creation Date:            2007-04-03
Authors:                  Payvision Spain, S.L.
File History:
2007-10-10    Jose Fco Bonnin   File Creation
2010-06-09    Adolfo Gabriel    Format changes. New chargeback types
                                added.
  1 INTRODUCTION .................................................................................................................... 5
     1.1 ABSTRACT ........................................................................................................................... 5
     1.2 AUDIENCE ............................................................................................................................ 5
     1.3 CONTACT INFORMATION ...................................................................................................... 5
  2 REPORTS API ......................................................................................................................... 6
     2.1 PROTOCOLS SUPPORTED ...................................................................................................... 6
     2.2 WEB SERVICES EXPOSED ..................................................................................................... 7
        2.2.1 Transactions ................................................................................................................ 7
             2.2.1.1 GetReconciliation................................................................................................................ 7
         2.2.2 Declines ..................................................................................................................... 13
             2.2.2.1 GetDeclinedRatios ............................................................................................................ 13
             2.2.2.2 GetDeclinedTransactions .................................................................................................. 14
             2.2.2.3 GetDeclinedTransaction .................................................................................................... 15
             2.2.2.4 GetDeclinedTransactionByMemberCode ......................................................................... 16
         2.2.3 Chargebacks .............................................................................................................. 17
             2.2.3.1 GetChargebackRatios ........................................................................................................ 17
             2.2.3.2 GetChargebacks ................................................................................................................ 19
             2.2.3.3 GetChargebacksByCaseId ................................................................................................. 20
             2.2.3.4 GetChargebacksByTransactionId ...................................................................................... 21




Payvision                          Ref PVES PV2 PPRA v.1.1                                                                           Page    4
      Payvision Payment Processor
                                                                        Reports API




                                           1    INTRODUCTION

1.1   Abstract
        This document provides a detailed description about the methods exposed
      by the Reports API.


1.2   Audience
        This paper provides a starting point for technology professionals or
      developers who are looking for technical information about how to use the
      Reports API to query information about the transactions processed through
      the Payvision Payment Gateway or build their own backend or reports.
      Familiarity with web development techniques is assumed.


1.3   Contact Information

      Payvision Spain, S.L.
      Cañada Real de Merinas, 17. Edificio 5-4D
      28042 Madrid
      Spain
      http://www.payvision.com


      Financial questions: FinancialSupport@payvision.com
      Technical questions: TechnicalSupport@payvision.com
      Sales questions:        SalesSupport@payvision.com


        If you have any suggestions or remarks about this document please contact
      the author of the document.




      Payvision              Ref PVES PV2 PPRA v.1.1                  Page   5
      Payvision Payment Processor
                                                                           Reports API




                                             2    REPORTS API

        The Reports API consists of different interoperable web services that group
      several methods by related business logic.
        This section describes exactly how to make use of these web services and
      the information provided by them.


        The Reports API is open to be extended with more web services and
      methods. If you do not find the information you need, please feel free to
      contact SalesSupport@payvision.com in order they coordinate with the
      product department the inclusion of your feature request in future versions.


        The main URL for the Reports API is:
        https://report.payvisionservices.com/ReportsApi


      NOTE: Payvision has tried to reduce to the minimum the time that is
      necessary to make available, in the Reports API, the information present in
      the live environment. Nevertheless the systems are independent and you
      might notice small synchronization delays in both systems.



2.1   Protocols Supported
        The Reports API Web Services can be accessed using the next protocols:
            Soap 1.1
            Soap 1.2

        All the communications done between customers and Payvision are
      encrypted with SSL.


        Payvision encourages the use of any SOAP toolkit, due to they dramatically
      reduce the development from a front-end perspective. Making use of a toolkit
      you don’t need to deal with XML or HTTP, but just instantiate objects and call
      methods on them. More information about SOAP can be found at:

            Full SOAP specification W3 - http://www.w3.org/TR/soap/
            Microsoft Web Services - http://msdn2.microsoft.com/webservices
            Java Toolkit - http://ws.apache.org/soap/index.html
            Perl Toolkit - http://www.soaplite.com/




      Payvision            Ref PVES PV2 PPRA v.1.1                       Page   6
          Payvision Payment Processor
                                                                                     Reports API




   2.2    Web Services Exposed
            The Reports API currently exposes the next Web Services:
                  Transactions
                  Declines
                  Chargebacks
            All the web services organize the information following the next pattern.


          Name                    Type            Description

          Code                    Int             Numeric code indicating the result of the
                                                  request operation. 0 means ok.

          Message                 String          Description indicating the result of the
                                                  request operation.

          Data                    [Different on   This   node   contains  the  specific
                                  each Method]    information retrieved by each web
                                                  method.




 2.2.1    Transactions
            This web service provides the information             regarding   the processed
          transactions.


            The starting point for this Web Service is to navigate to its URL:
            https://report.payvisionservices.com/ReportsApi/Transactions.asmx


            The page displays a list of the available methods that can be called and also
          provides a link to the WSDL description of the Web Service.



2.2.1.1   GetReconciliation
            This web method provides you reconciliation information for the given
          member. The reconciliation is frequently used to match the information
          processed at Payvision with the information that the customer stores on their
          side.


            Description about how to build requests for this method using the different
          protocols         supported          can          be        found          at
          https://report.payvisionservices.com/ReportsApi/Transactions.asmx?op=GetR
          econciliation




          Payvision             Ref PVES PV2 PPRA v.1.1                             Page   7
Payvision Payment Processor
                                                                            Reports API




 The next table describes the request parameters to use with the method
GetReconciliation.


Name                     Type           Description
credentialsMemberId      Int            Member Id provided by Payvision to get
                                        access to the system. The value is the
                                        same used to process transactions.
credentialsMemberGuid    String         Member Guid provided by Payvision to
                                        get access to the system. The value is the
                                        same used to process transactions.
memberId                 Int            Member Id for which you want to retrieve
                                        the information. If you have a reseller or
                                        PSP account, introduce here the member
                                        id of the customer you want to query. If
                                        not this value must be the same as the
                                        one used in credentialsMemberId.

startDate                DateTime       Start date to delimit the range of time
                                        you want to query. The date must be
                                        expressed as UTC.
endDate                  DateTime       End date to delimit the range of time you
                                        want to query. The date must be
                                        expressed as UTC.



  Below you can see a schema about how the information is structured.




Payvision             Ref PVES PV2 PPRA v.1.1                             Page   8
Payvision Payment Processor
                                                                   Reports API




                  Data                               Authorizes



         MerchantAccountsIncluded                    Count
         StartDate                                   TotalAmount
         EndDate
         MerchantAcounts
                                                      Captures



      ReconciliationMerchantAccount                  Count
                                                     TotalAmount


         MerchantAccountId
         SettlementCurrency                            Voids
         Authorizes
         Captures
         Voids                                       Count
         Payments                                    TotalAmount
         Refunds
         ReferralApproval
         Transactions
                                                     Payments



      ReconciliationTransaction                      Count
                                                     TotalAmount


         TransactionId
         TransactionGuid                              Refunds
         TrackingMemberCode
         OriginalAmount
         OriginalCurrencyId                          Count
         MerchantAmount                              TotalAmount
         CurrencyRate
         CardId
         CardGuid                                  ReferralApproval
         CardTypeId
         TransactionDate
         TransactionType
         CountryId                                   Count
         BatchDate                                   TotalAmount




Payvision              Ref PVES PV2 PPRA v.1.1                   Page   9
Payvision Payment Processor
                                                                            Reports API




  The next table describes the fields contained in the Data element.


Name                    Type             Description
MerchantAccounts        Int              Indicates the number of merchant
Included                                 accounts that have been included. This
                                         value    tells   you     the   number  of
                                         “ReconciliationMerchantAccount”     nodes
                                         that you will find in the response.
StartDate               DateTime         Echoes back the start date      sent     as
                                         parameter in the request.
EndDate                 DateTime         Echoes back the end date        sent     as
                                         parameter in the request.
MerchantAccounts        Array            This     node      groups     all    the
                                         ReconciliationMerchantAccount nodes.




 ReconciliationMerchantAccount description.


Name                    Type               Description
MerchantAccountId       Int               Identifier of the merchant account.
SettlementCurrency      Int               ISO 4217 Currency code (numeric) that
                                          indicates the settlement currency of the
                                          merchant account.
Authorizes              Reconciliation    Contains the number of authorizes and
                        Total             the total amount processed through the
                                          account for the given date range.
Captures                Reconciliation    Contains the number of captures and
                        Total             the total amount processed through the
                                          account for the given date range.
Voids                   Reconciliation    Contains the number of voids and the
                        Total             total amount processed through the
                                          account for the given date range.
Payments                Reconciliation    Contains the number of payments and
                        Total             the total amount processed through the
                                          account for the given date range.
Refunds                 Reconciliation    Contains the number of refunds and the
                        Total             total amount processed through the
                                          account for the given date range.
ReferralApproval        Reconciliation    Contains the number of referral
                        Total             approvals and the total amount
                                          processed through the account for the
                                          given date range.
Transactions            Reconciliation    Contains a detailed list with all the
                        Transaction       transactions processed through the
                                          account.




Payvision            Ref PVES PV2 PPRA v.1.1                                  Page   10
Payvision Payment Processor
                                                                               Reports API




 ReconciliationTransaction description.


Name                    Type              Description
TransactionId           Int              Transaction Identifier obtained when
                                         the transaction was processed.
TransactionGuid         Guid             Transaction GUID obtained when the
                                         transaction was processed.
TrackingMemberCode      String           Tracking code      sent   to   identify    the
                                         transaction.
OriginalAmount          Decimal          Amount of the transaction.
OriginalCurrencyId      Int              Currency of the transaction.
MerchantAmount          Decimal          Amount resulting of the conversion to
                                         the settlement currency.
CurrencyRate            Decimal          Rate applied to calculate the merchant
                                         amount.
CardId                  Int              Card identifier.
CardGuid                Guid             Card GUID.
CardTypeId              String           Card type.
TransactionDate         DateTime         DateTime in UTC in which                   the
                                         transaction was processed.
CountryId               Int              Country from which the transaction was
                                         sent.
BatchDate               String           Date in which the transaction was
                                         batched formatted as YYYYMMDD (UTC
                                         based). If the value is empty the
                                         transaction has not been batched yet.



  Next you can see as example an excerpt of the information retrieved.


<?xml version="1.0" encoding="utf-8" ?>
<ReconciliationResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-
instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="http://payvision.com/gateway/ReportsApi">
  <Code>0</Code>
  <Message>Successfully processed.</Message>
  <Data>
    <MerchantAccountsIncluded>1</MerchantAccountsIncluded>
    <StartDate>2007-10-01T00:00:00Z</StartDate>
    <EndDate>2007-10-11T00:00:00Z</EndDate>
    <MerchantAccounts>
      <ReconciliationMerchantAccount>
        <MerchantAccountId>XX</MerchantAccountId>
        <SettlementCurrency>978</SettlementCurrency>
        <Authorizes>
          <Count>1406</Count>
          <TotalAmount>34495.14</TotalAmount>
        </Authorizes>
        <Captures>




Payvision            Ref PVES PV2 PPRA v.1.1                                     Page   11
Payvision Payment Processor
                                                            Reports API




           <Count>1396</Count>
           <TotalAmount>35033.98</TotalAmount>
         </Captures>
         <Voids>
           <Count>89</Count>
           <TotalAmount>1673.90</TotalAmount>
         </Voids>
         <Payments>
           <Count>0</Count>
           <TotalAmount>0</TotalAmount>
         </Payments>
         <Refunds>
           <Count>1</Count>
           <TotalAmount>27.00</TotalAmount>
         </Refunds>
         <ReferralApprovals>
           <Count>0</Count>
           <TotalAmount>0</TotalAmount>
         </ReferralApprovals>
         <Transactions>
           <ReconciliationTransaction>
             <TransactionId>XXXXXX</TransactionId>
             <TransactionGuid>XXXXXX</TransactionGuid>
             <TrackingMemberCode>X</TrackingMemberCode>
             <OriginalAmount>20.000000</OriginalAmount>
             <OriginalCurrencyId>978</OriginalCurrencyId>
             <MerchantAmount>20.000000</MerchantAmount>
             <CurrencyRate>1.000000</CurrencyRate>
             <CardId>XXXXXX</CardId>
             <CardGuid>XXXXXX</CardGuid>
             <CardTypeId>EurocardMastercard</CardTypeId>
             <TransactionDate>
               2007-10-
               10T13:17:43.14Z
             </TransactionDate>
             <TransactionType>Authorize</TransactionType>
             <CountryId>276</CountryId>
             <BatchDate />
           </ReconciliationTransaction>
           <ReconciliationTransaction>
             <TransactionId>XXXXXX</TransactionId>
             <TransactionGuid>XXXXXX</TransactionGuid>
             <TrackingMemberCode>XXX</TrackingMemberCode>
             <OriginalAmount>27.000000</OriginalAmount>
             <OriginalCurrencyId>978</OriginalCurrencyId>
             <MerchantAmount>27.000000</MerchantAmount>
             <CurrencyRate>1.000000</CurrencyRate>
             <CardId>XXXXXX</CardId>
             <CardGuid>XXXXXX</CardGuid>
             <CardTypeId>Visa</CardTypeId>
             <TransactionDate>
               2007-10-
               10T13:09:30.703Z
             </TransactionDate>
             <TransactionType>Authorize</TransactionType>
             <CountryId>276</CountryId>
             <BatchDate />
              </ReconciliationTransaction>



               […………………………]




Payvision            Ref PVES PV2 PPRA v.1.1              Page   12
          Payvision Payment Processor
                                                                                       Reports API




 2.2.2    Declines
            This web service provides the information regarding the transactions that
          have been declined.
            The starting point for this Web Service is to navigate to its URL:
            https://report.payvisionservices.com/ReportsApi/Declines.asmx


            The page displays a list of the available methods that can be called and also
          provides a link to the WSDL description of the Web Service.


            The next points describe          all   the   methods    supported    through       the
          BasicOperations Web Service.



2.2.2.1   GetDeclinedRatios
            This web method provides the decline ratios based on the volume and the
          number of declines for the given member, the results are grouped by
          merchant account id and card type. The response includes the values used to
          calculate the ratios.


            Description about how to build requests for this method using the different
          protocols         supported          can          be        found          at
          https://report.payvisionservices.com/ReportsApi/Declines.asmx?op=GetDeclin
          edRatios


            The next table describes the request parameters to use.


          Name                     Type               Description
          credentialsMemberId      Int               Member Id provided by Payvision to get
                                                     access to the system. The value is the
                                                     same used to process transactions.
          credentialsMemberGuid    String            Member Guid provided by Payvision to
                                                     get access to the system. The value is
                                                     the same used to process transactions.
          memberId                 Int               Member Id for which you want to
                                                     retrieve the information. If you have a
                                                     reseller or PSP account, introduce here
                                                     the member id of the customer you
                                                     want to query. If not this value must be
                                                     the same as the one used in
                                                     credentialsMemberId.
          startDate                DateTime          Start date to delimit the range of time
                                                     you want to query.




          Payvision             Ref PVES PV2 PPRA v.1.1                              Page   13
          Payvision Payment Processor
                                                                                     Reports API




          endDate                 DateTime         End date to delimit the range of time
                                                   you want to query.



            The response provides you with an array of “DeclineRatio”, which length will
          vary depending on the number of merchant accounts and card types the
          member has. Below you can see the values that are contained in each
          “DeclineRatio” node.


          Name                           Type       Description
          MerchantAccountId              Int        Merchant account identifier.
          CardType                       String     Card type name.
          CurrencyId                     Int        Currency of the given amounts.
          TransactionsCount              Int        Total number of transactions included
                                                    for the ratio calculation.
          DeclinedTransactionsCount      Int        Total number of declined transactions
                                                    included for the ratio calculation.
          DeclinesRatio                  Decimal    Ratio based on the number of
                                                    transactions and declines. The formula
                                                    applied is: (# of Declined Transactions
                                                    / # of Transactions) * 100.
          TransactionsVolume             Decimal    Total amount of transactions included
                                                    for the ratio calculation.
          DeclinedTransactionsVolume     Decimal    Total amount of declined transactions
                                                    included for the ratio calculation.
          DeclinesVolumeRatio            Decimal    Ratio based on the volume of
                                                    transactions processed. The formula
                                                    applied is: (Total Amount of Declined
                                                    Transactions / Total Amount of
                                                    Transactions) * 100.




2.2.2.2   GetDeclinedTransactions
            This web method allows retrieving the list of declined transactions based on
          the parameters sent, which are the same as the previous method.


            Description about how to build requests for this method using the different
          protocols         supported          can          be        found          at
          https://report.payvisionservices.com/ReportsApi/Declines.asmx?op=GetDeclin
          edTransactions




          Payvision            Ref PVES PV2 PPRA v.1.1                             Page   14
          Payvision Payment Processor
                                                                                             Reports API




            The next table provides information about the information retrieved.


          Name                             Type         Description
          ProcessedTransactionId           Int          Transaction Id obtained when the
                                                        transaction was processed.
          ProcessedTransactionGuid         Guid         Transaction Guid obtained when the
                                                        transaction was processed.
          TrackingMemberCode               String       Tracking code provided by the
                                                        merchant when the transaction was
                                                        processed.
          OriginalAmount                   Decimal      Amount as sent originally.
          OriginalCurrencyId               Int          Currency id of the amount sent.
          MerchantAmount                   Decimal      Amount after convert         it    to    the
                                                        settlement currency.
          MerchantCurrencyRate             Decimal      Rate   applied   to   perform   the
                                                        conversion    to   the   settlement
                                                        currency.
          RequestDate                      DateTime     Date time in which                Payvision
                                                        received the request.
          Date                             DateTime     Date time in which                Payvision
                                                        processed the request.
          TransactionType                  String       Transaction type.
          CardId                           Int          Card id to identify the card used to
                                                        process the transaction.
          CardGuid                         Guid         Card guid to identify the card used
                                                        to process the transaction.
          CardTypeId                       String       Card type.
          MerchantAccountId                Int          Merchant account identifier.
          CountryId                        Int          Country from which the transaction
                                                        was originated.
          BankCode                         String       Code provided by the              bank    to
                                                        decline the transaction.
          BankMessage                      String       Message provided by the bank to
                                                        decline the transaction.




2.2.2.3   GetDeclinedTransaction
            With this web method you can retrieve the information regarding a
          transaction declined.


            Description about how to build requests for this method using the different
          protocols         supported          can          be        found          at
          https://report.payvisionservices.com/ReportsApi/Declines.asmx?op=GetDeclin
          edTransactions




          Payvision              Ref PVES PV2 PPRA v.1.1                                      Page   15
          Payvision Payment Processor
                                                                                       Reports API




            The next table describes the request parameters to use.


          Name                          Type          Description
          credentialsMemberId           Int          Member Id provided by Payvision to get
                                                     access to the system. The value is the
                                                     same used to process transactions.
          credentialsMemberGuid         String       Member Guid provided by Payvision to
                                                     get access to the system. The value is
                                                     the same used to process transactions.
          memberId                      Int          Member Id for which you want to
                                                     retrieve the information. If you have a
                                                     reseller or PSP account, introduce here
                                                     the member id of the customer you
                                                     want to query. If not this value must be
                                                     the same as the one used in
                                                     credentialsMemberId.
          processedTransactionId        Int          Id of the transaction you want to query
                                                     information.
          processedTransactionGuid      Guid         Guid of the transaction you want to
                                                     query information.



            The response is formatted in the same way as the previous method. The
          difference is that you will only have one decline in the list.



2.2.2.4   GetDeclinedTransactionByMemberCode
            With this web method you can retrieve the information regarding a
          transaction declined based on the tracking member code that was sent.


            Description about how to build requests for this method using the different
          protocols         supported          can          be        found          at
          https://report.payvisionservices.com/ReportsApi/Declines.asmx?op=GetDeclin
          edTransactions




          Payvision              Ref PVES PV2 PPRA v.1.1                             Page   16
          Payvision Payment Processor
                                                                                      Reports API




            The next table describes the request parameters to use.


          Name                      Type             Description
          credentialsMemberId       Int             Member Id provided by Payvision to get
                                                    access to the system. The value is the
                                                    same used to process transactions.
          credentialsMemberGuid     String          Member Guid provided by Payvision to
                                                    get access to the system. The value is
                                                    the same used to process transactions.
          memberId                  Int             Member Id for which you want to
                                                    retrieve the information. If you have a
                                                    reseller or PSP account, introduce here
                                                    the member id of the customer you
                                                    want to query. If not this value must be
                                                    the same as the one used in
                                                    credentialsMemberId.
          trackingMemberCode        String          Tracking Member Code sent along with
                                                    the transaction.
          Date                      DateTime        UTC date in which the transaction was
                                                    sent.



            The response is formatted in the same way as the GetDeclinedTransactions
          and GetDeclinedTransaction previous method. The difference is that you will
          only have one decline in the list.



 2.2.3    Chargebacks
            Chargebacks web service provides methods to retrieve information related
          to the chargeback received. The starting URL for this Web Service is:
          https://report.payvisionservices.com/ReportsApi/Chargebacks.asmx



2.2.3.1   GetChargebackRatios
           The information provided by this web method is equivalent to the method
          GetDeclinesRatios but based on the chargeback details.


            Examples about how to build requests for this method using the different
          protocols         supported          can         be        found        at
          https://report.payvisionservices.com/ReportsApi/Chargebacks.asmx?op=GetC
          hargebackRatios




          Payvision             Ref PVES PV2 PPRA v.1.1                             Page   17
Payvision Payment Processor
                                                                              Reports API




  The next table describes the request parameters to use.


Name                      Type             Description
credentialsMemberId       Int             Member Id provided by Payvision to get
                                          access to the system. The value is the
                                          same used to process transactions.
credentialsMemberGuid     String          Member Guid provided by Payvision to
                                          get access to the system. The value is
                                          the same used to process transactions.
memberId                  Int             Member Id for which you want to
                                          retrieve the information. If you have a
                                          reseller or PSP account, introduce here
                                          the member id of the customer you
                                          want to query. If not this value must be
                                          the same as the one used in
                                          credentialsMemberId.
startDate                 String          Start date to delimit the range of time
                                          you want to query.
endDate                   DateTime        End date to delimit the range of time
                                          you want to query.



  The response provides you with an array of “ChargebackRatio”. The number
of elements will be different depending on the number of merchant accounts
and card types the member has. Below you can see the values that are
contained in each “ChargebackRatio” node.


Name                        Type           Description
MerchantAccountId           Int           Merchant account identifier.
CardType                    String        Card type name.
CurrencyId                  Int           Currency of the given amounts.
TransactionsCount           Int           Total number of transactions included
                                          for the ratio calculation.
ChargebacksCount            Int           Total number of chargebacks included
                                          for the ratio calculation.
TransactionsVolume          Decimal       Total amount of the transactions
                                          included for the ratio calculation.
ChargebacksVolume           Decimal       Total amount of the chargebacks
                                          included for the ratio calculation.
ChargebackRatio             Decimal       Ratio based on the number               of
                                          transactions and chargebacks.
ChargebackVolumeRatio       Decimal       Ratio based on the             volume   of
                                          transactions processed.




Payvision             Ref PVES PV2 PPRA v.1.1                               Page   18
            Payvision Payment Processor
                                                                                        Reports API




2.2.3.1.1   How to interpret the information:
              The formulas applied for all cards except Mastercard are:
              ChargebackRatio = (# of Chargebacks / # of Transactions) * 100
              ChargebackVolumeRatio = Total Amount of CB / Total Amount of
            Transact.) * 100


              In the case of MasterCard cards you must consider that the number of
            transactions and total amount of transactions are based on the previous
            month. This means that date range to obtain the chargebacks is the same as
            provided in the request, but the date range to obtain the transactions will be
            from startDate – 1 month to endDate - 1 month. Therefore the formulas are:
             ChargebackRatio = (# of CB given month / # of Transact. previous
            month) * 100
             ChargebackVolumeRatio = Total Amount of CB given month / Total
            Amount of Transactions previous month) * 100



 2.2.3.2    GetChargebacks
              Returns a list of chargeback based on the parameters provided. The
            parameters needed to perform a request are the same as the method
            GetChargebackRatios.


              Below you can see the information retrieved for each chargeback contained
            in the list.


            Name                     Type             Description
            ChargebackId             Int               Payvision identifier of the chargeback.
            CaseId                   String            Case Id assigned by the bank.
            ChargebackTypeId         Int               Identifier of the chargeback type.
                                                       Please note that not all the banks
                                                       provide     Payvision     with    this
                                                       information, due to that it is common
                                                       that the types are only Reversal and
                                                       First Chargeback.
                                                             1. Retrieval
                                                             2. First Chargeback
                                                             3. Second Chargeback
                                                             4. First Reversal
                                                             5. Second Reversal
                                                             6. Incoming Collection
                                                             7. Outgoing Collection




            Payvision            Ref PVES PV2 PPRA v.1.1                              Page   19
          Payvision Payment Processor
                                                                                            Reports API




                                                              8. Incoming Compliance
                                                              9. Outgoing Compliance
                                                              10. Incoming PreArbitration
                                                              11. Chargeback cancellation
                                                              12. Soft chargeback
          Amount                      Decimal           Amount of the chargeback.
          CurrencyId                  Int               Currency identifier.
          ProcessedDate               DateTime          Date Time in which the chargeback
                                                        was processed in the Payvision
                                                        system.
          ReasonCode                  String            Reason     code   about   why         the
                                                        transaction was charged back.
          CardId                      Int               Identifier of the card used to perform
                                                        the transaction.
          CardGuid                    Guid              Guid of the card used to perform the
                                                        transaction.
          MerchantAccountId           Int               Identifier of the merchant account.
          OriginalTransactionDate     DateTime          Date in which the transaction was
                                                        processed.
          TransactionId               Int               Transaction identifier.
          AdditionalInfo              Array       of    Array of class CdcEntryItem with any
                                      CdcEntryItem      extra information the bank provided
                                                        us.



            The CdcEntryItem has the next properties.


          Name                        Type             Description
          Key                         String           Key/Name of the extra        information
                                                       provided. i.e “DeadLine”.
          Value                       String           Value associated to the key. i.e. “2007-
                                                       10-03”.




2.2.3.3   GetChargebacksByCaseId
            This method provides a list with all the chargeback that have the given case
          id.


            The necessary parameters to build the request are:


          Name                        Type             Description
          credentialsMemberId         Int              Member Id provided by Payvision to get
                                                       access to the system. The value is the




          Payvision               Ref PVES PV2 PPRA v.1.1                                 Page   20
          Payvision Payment Processor
                                                                                      Reports API




                                                    same used to process transactions.
          credentialsMemberGuid     String          Member Guid provided by Payvision to
                                                    get access to the system. The value is
                                                    the same used to process transactions.
          memberId                  Int             Member Id for which you want to
                                                    retrieve the information. If you have a
                                                    reseller or PSP account, introduce here
                                                    the member id of the customer you
                                                    want to query. If not this value must be
                                                    the same as the one used in
                                                    credentialsMemberId.
          caseId                    String          Case Id of the chargeback.



            The result is formatted exactly as the method GetChargebacks.



2.2.3.4   GetChargebacksByTransactionId
            This method provides a list with all the chargeback associated to the given
          transaction id.


            The necessary parameters to build the request are:


          Name                      Type             Description
          credentialsMemberId       Int       Member Id provided by Payvision to get
                                              access to the system. The value is the same
                                              used to process transactions.
          credentialsMemberGuid     String    Member Guid provided by Payvision to get
                                              access to the system. The value is the same
                                              used to process transactions.
          memberId                  Int       Member Id for which you want to retrieve the
                                              information. If you have a reseller or PSP
                                              account, introduce here the member id of the
                                              customer you want to query. If not this value
                                              must be the same as the one used in
                                              credentialsMemberId.
          transactionId             Int       Transaction    id    that   has    associated
                                              chargebacks.

            The result is formatted exactly as the method GetChargebacks.




          Payvision             Ref PVES PV2 PPRA v.1.1                             Page   21

				
DOCUMENT INFO
Shared By:
Categories:
Tags:
Stats:
views:177
posted:9/21/2011
language:English
pages:21