fetchPaymentInstructions

Navigation:  WebService Calls > Options for Growth >

fetchPaymentInstructions

 Previous pageReturn to chapter overviewNext page

Texte ein-/ausblenden

Beschreibung

Abfrage von Zahlungsinformationen zu Aufträgen. Aufruf wurde bisher nur für BillSAFE verwendet. Das Plugin wurde mittlerweile deaktiviert, der Call ist somit deprecated / veraltet.

Beispiel Request

Code

<request method="fetchPaymentInstructions" version="1.0.0">

   <filter>

      <mandator_id filter_method="=" filter_value="1"/>

      <payment_type_id filter_method="=" filter_value="12"/>

      <order_id filter_method="=" filter_value="891965"/>

   </filter>

</request>

Feldliste Request

Name

Beschreibung

Anz.

Typ

Sonstiges

request

Root-Element der Anfrage

1

Element

method

Attribut von request. Name der Webservice-Methode.

1

string

Fester Wert: "fetchPaymentInstructions"

version

Attribut von request. Legt die Version der Anfrage fest.

1

string

Fester Wert: "1.0.0"

filter

Legt Parameter fest nach denen die Ergebnismenge eingeschränkt wird. Mehrere Filter werden als ODER-Verknüpfung, Elemente innerhalb des Filters als UND-Verknüpfung behandelt.

1..N

Element

mandator

Schränkt die Ergebnismenge auf einen bestimmten Mandanten ein.

1

Element

filter_method

Attribut von mandator. Legt das Verhalten des Filters fest.

1

string

Fester Wert: "="

filter_value

Attribut von mandator. Legt den Filterwert fest.

1

integer

payment_type_id

Schränkt die Ergebnismenge auf eine bestimmte Zahlart ein.

0..1

Element

filter_method

Attribut von payment_type_id. Legt das Verhalten des Filters fest.

1

string

Fester Wert: "="

filter_value

Attribut von payment_type_id. Legt den Filterwert fest.

1

integer

order_id

Schränkt die Ergebnismenge auf einen bestimmten Auftrag ein.

0..1

Element

filter_method

Attribut von order_id. Legt das Verhalten des Filters fest.

1

string

Fester Wert: "="

filter_value

Attribut von order_id. Legt den Filterwert fest.

1

integer

Beispiel Response

Code

<response method="fetchPaymentInstructions" version="1.0.0">

    <report return_code="0">

        <total_number_of_pages>1</total_number_of_pages>

        <total_number_of_entries>1</total_number_of_entries>

    </report>

    <billsafe_payment_instruction>

        <order_id>891965</order_id>

        <recipient>PayPal</recipient>

        <bank_code>87654321</bank_code>

        <bank_account_number>654321</bank_account_number>

        <bank_name>Bankname</bank_name>

        <swift_code>GENODEF2WEO</swift_code>

        <iban_code>DE87876543210000654321</iban_code>

        <reference>BTN 12345678</reference>

        <amount>53.50</amount>

        <currency_code>EUR</currency_code>

        <payment_period>14</payment_period>

        <note>Bitte überweisen Sie den ausstehenden Betrag bis zum 02.08.2016.</note>

        <legal_note>Firma GmbH hat die Forderung gegen Sie im Rahmen...</legal_note>

    </billsafe_payment_instruction>

</response>

Feldliste Response

Name

Beschreibung

Anz.

Typ

Sonstiges

response

Root-Element der Antwort.

1

Element

method

Attribut von response. Name der Webservice-Methode.

1

string

Fester Wert: „fetchPaymentInstructions“

version

Attribut von response. Legt die Version der Anfrage fest.

1

string

Fester Wert:  „1.0.0“

report

Information über die ausgeführte Operation.

1

Element

return_code

Attribut von report. Gibt an ob in der durchgeführten Operation Fehler aufgetreten sind.

1

integer

0 = OK.

< 0 = Fehler

error_description

Falls bei der Durchführung der Operation Fehler aufgetreten sind wird in error_description eine Fehlerbeschreibung zurück geliefert.

1

string

total_number_of_pages

Gesamtseitenzahl der Einträge.

1

integer

total_number_of_entries

Anzahl der zurückgegebenen Einträge.

1

integer

billsafe_payment_instruction

Wrapper-Element, das die Zahlungsinformationen einer Zahlung beinhaltet.

0..N

Element

order_id

ID des Auftrags.

1

integer

recipient

Zahlungsempfänger

1

string

bank_code

Bankleitzahl

1

integer

bank_account_number

Kontonummer

1

integer

bank_name

Bezeichnung des Kreditinstitutes.

1

string

swift_code

Internationale Bankleitzahl

1

string

iban_code

IBAN

1

string

reference

Transaktionsnummer

1

string

amount

Betrag

1

decimal

currency_code

Währungsangabe

1

string

Siehe Wertetabelle.

payment_period

Zahlungsfrist in Tagen.

1

integer

note

Allgemeiner Zahlungshinweis.

1

string

legal_note

Rechtlicher Zahlungshinweis.

1

string

Wertetabelle(n)

Aufgeführte Werte gelten für die Felder map_unit, msrp_unit oder currency_code.

Wert

Beschreibung

AUD

Australischer Dollar

CAD

Kanadischer Dollar

EUR

Euro

GBP

Pfund Sterling

JPY

Yen

USD

US-Dollar

Änderungsübersicht

Version

Änderungsbeschreibung

3.4.42.1

Initiale Erstellung.

4.10.51

Als deprecated markiert.