pixiPayGetInvoicesToCapture

Liefert unbezahlte, ausgelieferte Rechnungen einer Zahlungsart, die zur Abbuchung anstehen, mit Auftrags-, Betrags-, Adress- und Kartendaten.

Ermittelt die Rechnungen, die eine Zahlungsanbindung (z. B. ein Kreditkartenanbieter) als Nächstes abbuchen soll, und liefert sie mit allen für die Abbuchung nötigen Daten.

Eine Rechnung wird gewählt, wenn alle folgenden Bedingungen gelten:

• Payment entspricht @PaymentCode.
• Es wurde noch nichts bezahlt (PayedSum = 0) und Total > 0.
• Die Abbuchung ist nicht als erledigt markiert (CCPPaymentDone ist N oder NULL).
• Die Rechnung wurde ausgescannt (ScanOutDate ist gesetzt).
• InvoiceKey ist größer als @FromInvoiceId.
• Eine der Wiederholungsbedingungen trifft zu:
  • noch kein Abbuchungsversuch (CCPNumOfTries = 0), oder
  • eine erneute Belastung ist angefordert (CCPRecharge = 'Y'), oder
  • 1 bis 3 Fehlversuche (ccpSetFailTries) und der letzte Fehlversuch (ccpSetFailLastTime) liegt mehr als 10 Minuten zurück, oder
  • @ShowAll = 1, wodurch die Wiederholungsbedingungen vollständig entfallen.

Es werden höchstens @RowCount Rechnungen gewählt, aufsteigend sortiert nach InvoiceKey. Je Rechnung werden Rechnungsnummer, die kommagetrennte Liste der externen Auftragsnummern, Gesamtbetrag, bezahlter Betrag, abzubuchender Betrag (Total - PayedSum), die Summe der verknüpften Auftragspositionen im Status ANG, Währungscode, Shop (CustomerOf des Kunden), Karten- und Adressdaten der Rechnungsadresse sowie die Abbuchungsstatusfelder geliefert.

Paging: Die InvoiceId der letzten gelieferten Zeile als @FromInvoiceId übergeben, um den nächsten Block zu erhalten.

Parameter

Antwort

Result-Set 1 · Immer (kann leer sein).

Eine Zeile je abzubuchender Rechnung, aufsteigend sortiert nach InvoiceId.

<SqlRowSet1>
  <row>
    <InvoiceNr>RE2024001234</InvoiceNr>
    <OrderNrExternal>100045678,100045679</OrderNrExternal>
    <Total>149.90</Total>
    <OrderLinesTotalANG>0.00</OrderLinesTotalANG>
    <PayedSum>0.00</PayedSum>
    <TotalToCapture>149.90</TotalToCapture>
    <Total_OrderCurr>149.90</Total_OrderCurr>
    <OrderCurrency>EUR</OrderCurrency>
    <ShopID>SHOP1</ShopID>
    <CardOwner>Max Mustermann</CardOwner>
    <CardNumber>411111******1111</CardNumber>
    <CardExpiration>12/27</CardExpiration>
    <CardCVC/>
    <Anrede>Herr</Anrede>
    <CareOf/>
    <FirstName>Max</FirstName>
    <LastName>Mustermann</LastName>
    <Address>Musterstr. 1</Address>
    <City>Berlin</City>
    <ZIP>10115</ZIP>
    <Country>DE</Country>
    <Phone>030123456</Phone>
    <eMail>max@example.com</eMail>
    <CCPNumOfTries>0</CCPNumOfTries>
    <CCPRecharge>N</CCPRecharge>
    <ccpPayID>PAY-88231</ccpPayID>
    <ccpSetFailTries>0</ccpSetFailTries>
    <InvoiceId>58231</InvoiceId>
  </row>
</SqlRowSet1>

Beispiele

POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
Authorization: Basic BASE64(USERNAME:PASSWORD)

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://apigateway.descartes.com/tms/pixi/">
  <SOAP-ENV:Body>
    <ns1:pixiPayGetInvoicesToCapture>
      <PaymentCode>C</PaymentCode>
      <!-- <ShowAll>0</ShowAll> -->
      <!-- <RowCount>30</RowCount> -->
      <!-- <FromInvoiceId>0</FromInvoiceId> -->
    </ns1:pixiPayGetInvoicesToCapture>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

curl -X POST 'https://apigateway.descartes.com/tms/pixi/' \
  --user 'USERNAME:PASSWORD' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --data-binary @- <<'XML'
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://apigateway.descartes.com/tms/pixi/">
  <SOAP-ENV:Body>
    <ns1:pixiPayGetInvoicesToCapture>
      <PaymentCode>C</PaymentCode>
      <!-- <ShowAll>0</ShowAll> -->
      <!-- <RowCount>30</RowCount> -->
      <!-- <FromInvoiceId>0</FromInvoiceId> -->
    </ns1:pixiPayGetInvoicesToCapture>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML

<?php

$soapClient = new SoapClient(null, [
    'login' => 'USERNAME',
    'password' => 'PASSWORD',
    'location' => 'https://apigateway.descartes.com/tms/pixi/',
    'uri' => 'https://apigateway.descartes.com/tms/pixi/',
]);

$arguments = [
    'PaymentCode' => 'C',
    // 'ShowAll' => '0',
    // 'RowCount' => '30',
    // 'FromInvoiceId' => '0',
];

$soapArguments = [];
foreach ($arguments as $name => $value) {
    $soapArguments[] = new SoapVar($value, XSD_STRING, '', '', $name);
}

$response = $soapClient->__soapCall('pixiPayGetInvoicesToCapture', $soapArguments);

Verwendete Tabellen

SQL-Objekt:

dbo.pipiPayGetInvoicesToCapture

Prozedur zuletzt geändert am 2026-10-05

Dokumentation von claude-opus-5-5 am 2026-10-30 geschrieben