PDF Export

EPayment.performRefund

  • Objekt: /net/dsb/commons/EPayment
  • Methode: performRefund
  • Version: 1.0.0

Mit dieser Methode wird eine Rückzahlung über einen Zahlungsdienstleister abgewickelt.

Dies kann auf zwei Arten geschehen:

  1. Erstattung einer vorherigen Zahlung. In diesem Fall muss die transaction-id der zu erstattenden Zahlung angegeben werden. Die Erstattung kann maximal den gezahlten Betrag umfassen.
  2. Erstattung / Zahlung eines Betrages ohne Bezug auf eine vorherige Zahlung. In diesem Fall muss die Paypal ID oder die Emailadresse des Empfängers angegeben werden. Es kann ein beliebiger Betrag gezahlt werden. In diesem Fall sollte der Händler eine merchant-request-id übergeben, damit später auf diese Zahlung referenziert werden kann.

Es hängt vom jeweiligen Dienstleister ab, welche Methode unterstützte wird.

Momentan sind dies:

Dienstleister Rückzahlung mit Bezug zu einer Transaktion Rückzahlung ohne Bezug zu einer Transaktion
PayPal X X
Amazon X -

Parameter

Name Typ / LängeKann / MussBeschreibung
refund-requestXML m XML-Fragment welches die vom Backend zur Weiterarbeitung der Transaction benötigten Daten enthält.
Request Struktur
Aufbau
<message version="1.0" system="VHS/3">
  <header>
    <client>9999</client>
    <service-provider>999</service-provider>
    <service-object>/net/dsb/commons/EPayment</service-object>
    <service-method>performRefund</service-method>
    <service-version>1.0.0</service-version>
  </header>
  <body>
    <epayment-transaction>
      <refund-request>
        <payment-provider>PAYPAL</payment-provider>
        <transaction-id>0123456789123456789</transaction-id>
        <amount>10.00</amount>
        <curreny-code>EUR</curreny-code>
        <memo>a refund for you</memo>
      </refund-request>
    </epayment-transaction>
  </body>
</message>
Elementdefinition
Feld MandatoryLängeArtBeschreibung
epayment-transaction X - XMLXML Element
refund-request X - XMLXML Element
transaction-id 19 AN TransactionID der zu erstattenden Transaktion.
payerID AN ID des Empfängers. Bei Rückzahlung ohne Bezug zu einer Transaktion (nur Paypal) wird der Empfänger über die ID oder die Email-Adresse ausgewählt.
payerEmail AN Email-Adresse des Empfängers. Bei Rückzahlung ohne Bezug zu einer Transaktion (nur Paypal) wird der Empfänger über die ID oder die Email-Adresse ausgewählt.
merchant-id 36 AN ID des Händlers (Pflichtfeld, wenn bei dem Mandanten mehrere Händler existieren)
amount 12 N Betrag der Transaktion. Wert mit zwei Nachkommastellen. (kann entfallen, wenn Transaktion komplett erstattet wird. )
currency-code 3 AN Transaktionswährung nach ISO 4217. (mandatory, wenn amount angegeben wird)
memo 255 AN Zusatztext
merchant-request-id 128 AN ID des Requests im System des Händlers (bei PayPal max. 30 Stellen)
Response Struktur
Aufbau
<message version="1.0" system="VHS/3">
  <header>
    <client>9999</client>
    <service-provider>999</service-provider>
  </header>
  <body>
    <refund-response>
      <transaction-id >asdfasdfasdf</transaction-id>
      <fee-amount>0.37</fee-amount>
      <gross-amount>10.00</gross-amount>
      <net-amount>9.63</net-amount>
    </refund-response>
  </body>
</message>
Elementdefinition
Feld LängeArtBeschreibung
refund-response - XMLXML Element
transaction-id 19 AN TransactionID des Refund. Fehlt im Fehlerfall.
fee-amount 12 N Gebühr. Wert mit zwei Nachkommastellen
gross-amount 12 N Gesamtsumme. Wert mit zwei Nachkommastellen
net-amount 12 N Nettobetrag. Wert mit zwei Nachkommastellen
error XMLim Fehlerfall
error-code N Errorcode
error-message N Errormessage
Cookies helfen bei der Bereitstellung von Inhalten. Durch die Nutzung dieser Seiten erklären Sie sich damit einverstanden, dass Cookies auf Ihrem Rechner gespeichert werden. Weitere Information