pixiPaySetInvoiceCapture

Verarbeitet das Ergebnis eines Zahlungseinzugs (Capture) zu einer Rechnung, bucht sie als bezahlt oder setzt sie auf unbezahlt zurück und protokolliert dies in CCPTranLog.

Verarbeitet das Ergebnis eines Zahlungseinzugs (Capture), das ein externer Zahlungsanbieter ("pixi Apps Payment Provider") für die Rechnung InvoiceNr meldet.

Zunächst wird die Rechnung zusammen mit Kunde und Währung gelesen (Shop CustomerOf des Kunden, CustRef, AddrRef, Währungscode). Alle Änderungen laufen in einer Transaktion (bzw. in einem Savepoint, falls bereits eine Transaktion offen ist).

Success = 1 (Einzug erfolgreich)

1. Aufruf der internen Prozedur pixi_SetInvoicePaid mit paid = 1, EventID und PaidSum = CaptureSum. Diese legt im Kundenkonto ein manuelles Buchungsereignis an und gleicht es mit der Rechnung ab. EventID muss ein manuelles, positives Kundenkonto-Ereignis sein, sonst wird keine Buchung erzeugt.
2. Bei SetRemainingOrdersToHAL = 1 werden alle Auftragspositionen mit Status ANG, die zu einem Auftrag (gleiche OrderNr) mit mindestens einer Position auf dieser Rechnung gehören, auf Status HAL gesetzt.
3. Eintrag in CCPTranLog mit Transaktionstyp CA und Fehlercode CAPTURED, Notiz Message, Gesamtbetrag CaptureSum und Rechnungswährung.
4. Rückgabe Status = Success mit der Meldung Successfully created CA manual booking event for InvoiceNr ….

Success = 0 (Einzug fehlgeschlagen)

1. Aktualisierung der Rechnung: ccpSetFailTries wird erhöht, CCPNumOfTries und ccpSetFailLastTime gesetzt, PayedSum auf 0 und Payed auf NULL zurückgesetzt, CCPPaymentDone und CCPReCharge auf N gesetzt.
2. Die verbleibenden ANG-Auftragspositionen der betroffenen Aufträge werden immer auf HAL gesetzt (unabhängig von SetRemainingOrdersToHAL).
3. Eintrag in CCPTranLog mit Transaktionstyp ER und Fehlercode CAPTURED FAILED.
4. Rückgabe Status = Success mit der Meldung Reset payment data to unpaid for InvoiceNr ….

Bei einem Fehler wird die Transaktion zurückgerollt und eine Zeile mit Status = Error und der SQL-Fehlermeldung geliefert.

Parameter

Antwort

Result-Set 1 · Immer, eine Zeile (Erfolgsmeldung des jeweiligen Zweigs oder Fehlerzeile bei einer Ausnahme).

Statuszeile des Aufrufs.

<SqlRowSet1>
  <row>
    <Status>Success</Status>
    <Message>Successfully created CA manual booking event for InvoiceNr RE1000123</Message>
  </row>
</SqlRowSet1>

Fehlermeldungen

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:pixiPaySetInvoiceCapture>
      <InvoiceNr>RE1000123</InvoiceNr>
      <Success>1</Success>
      <PayID>pay_8f3a21c9</PayID>
      <PayCode>CAPTURE_OK</PayCode>
      <Message>Capture confirmed by provider</Message>
      <CaptureSum>119.90</CaptureSum>
      <!-- <EventID>ZE</EventID> -->
      <SetRemainingOrdersToHAL>0</SetRemainingOrdersToHAL>
    </ns1:pixiPaySetInvoiceCapture>
  </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:pixiPaySetInvoiceCapture>
      <InvoiceNr>RE1000123</InvoiceNr>
      <Success>1</Success>
      <PayID>pay_8f3a21c9</PayID>
      <PayCode>CAPTURE_OK</PayCode>
      <Message>Capture confirmed by provider</Message>
      <CaptureSum>119.90</CaptureSum>
      <!-- <EventID>ZE</EventID> -->
      <SetRemainingOrdersToHAL>0</SetRemainingOrdersToHAL>
    </ns1:pixiPaySetInvoiceCapture>
  </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 = [
    'InvoiceNr' => 'RE1000123',
    'Success' => '1',
    'PayID' => 'pay_8f3a21c9',
    'PayCode' => 'CAPTURE_OK',
    'Message' => 'Capture confirmed by provider',
    'CaptureSum' => '119.90',
    // 'EventID' => 'ZE',
    'SetRemainingOrdersToHAL' => '0',
];

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

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

Verwendete Tabellen

SQL-Objekt:

dbo.pipiPaySetInvoiceCapture

Prozedur zuletzt geändert am 2026-10-05

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