EPayment.performPurchase

With this service a payment is executed via a payment provider. This can only be done when a billing agreement id exists with which the customer agreed to this.

Object: /net/dsb/commons/EPayment
Method: performPurchase
Version: 1.0.0

Parameter

Name	Type / Length	Mandatory / Optional	Description
purchase-request	XML	m	XML Element with all the needed information.

Request

Structure

<message system="AVS/3" version="1.0">
  <header>
    <client>355</client>
    <avs3-service-provider>999</avs3-service-provider>
    <service-object>/net/dsb/commons/EPayment</service-object>
    <service-method>performPurchase</service-method>
    <service-version>1.0.0</service-version>
  </header>
  <body>
    <epayment-transaction>
      <purchase-request>
        <payment-provider>AMWS</payment-provider>
        <merchant-transaction-id>myInvoiceID</merchant-transaction-id>
        <billing-agreement-id>C02-5198887-64554320</billing-agreement-id>
        <amount>10.00</amount>
        <curreny-code>EUR</curreny-code>
        <invoice-id>DSB-I0815</invoice-id>
        <memo>thank you</memo>
        <payment-item>
          <name>Abo</name>
          <amount>7.50</amount>
          <item-number>42</item-number>
          <item-description>next year’s subscription</item-description>
        </payment-item>
        <merchant-request-id>lalala</merchant-request-id>
        <store-name>MySuperStore</store-name>
      </purchase-request>
    </epayment-transaction>
  </body>
</message>

Definition

Element	Mandatory	Length	Type	Description
payment-provider	M	6	AN
merchant-id		36	AN	ID of the merchant / shop; This filed is mandatory if this client has more than one id.
merchant-transaction-id	M		AN	ID of this transaction in the merchant's system
billing-agreement-id	M		AN	Billing Agreement ID
amount	M		N	Transaction amount. Value with two decimals.
currency-code	M	3	AN	Currency Code; see ISO 4217.
invoice-id	M		AN	invoice number
memo			AN	text that is displayed on customer's receipt.
payment-item			XML	the order postions
name			AN	Name of position, i.e. subscription title or number
amount	M		N	Amount of the position.
item-number	M		N	Number of the position, i.e subscription number or counter
item-description			AN	Description
merchant-request-id			AN	Unique ID of this request in client's system
store-name			AN	Shop name.

Request Struktur

Aufbau

<?xml version="1.0" encoding="UTF-8"?>
<message version="1.0" system="VHS/3">
  <header>
    <client>9999</client>
    <service-provider>999</service-provider>
  </header>
  <body>
    <purchase-response>
      <payment-result>Success</payment-result>
      <transaction-id>786769</transaction-id>
      <fee-amount>1.00</fee-amount>
      <gross-amount>10.00</gross-amount>
      <payment-date></payment-date>
      <error>
        <error-code>543644</error-code>
        <error-message>too much money</error-message>
      </error>
      <dsb-transaction-id>F486B9BB-F15D-6FBE-D43E-BEC165003A4D</dsb-transaction-id>
    </purchase-response>
  </body>
</message>

Elementdefinition

Feld	Mandatory	Länge	Art	Beschreibung
purchase-response	X	-	XML	XML Element
request-id		36	AN	Eine eindeutige ID, die diesen Request identifiziert. Bei mehrteiligen Zahlungen muss diese ID vorhanden und bei allen Teilen gleich sein.
notify-type			AN	Art der übermittelten Transaktionsdaten: NOTIFY-PREAUTHORIZE, NOTIFY-PURCHASE (Default)
external-transaction-id	X	36	AN	Externe ID der Transaktion (d.h. ID des Zahlungsdienstleisters)
external-payment-timestamp	X		D	Zeitpunkt der Transaktion im Format “yyyy-MM-dd’T‘HH:mm:ss”
amount	X	7	N	Betrag der Transaktion. Achtung: Ganzzahliger Wert in der kleinsten Einheit der in der Anfrage angegebenen Währung (z.B. EUR 10,00 ⇒ 1000).
currency-code	X	3	AN	Transaktionswährung nach ISO 4217.
merchant-id	X		AN	ID des Händlers beim Zahlungsdienstleister
payment-provider	X	6	AN	Art des Zahlungsdienstleisters: siehe Anhang
details				XML Element mit beliebigen weiteren Werten. Diese werden gespeichert und beim getTrxDetails zurückgeliefert, aber sonst nicht verwendet.