Description

API Call made for Payment-Apps to set invoices to paid or to unpaid after capturing the amount

Request Parameters

#	Name	Type	Required	Example	Description
1	InvoiceNr	string	1	DEM0000021	Invoice number of the invoice that was captured
2	Success	boolean	1	0 or 1	@Success = 0 -> PaidSum = 0, @Success = 1 -> PaidSum > 0
3	PayID	string	1	31HA07BC812E3C3FDD691A7818766939	Unique TransactionID
4	PayCode	string	1	CC	CC = Credit Card
5	Message	string	1	Amount of 46.18 EUR was captured	Message will be saved to the Credit Card Log in pixi Control Center
6	CaptureSum	number	1	46.18	Sum that should be captured. @PaidSum in pixiSetInvoicePaid
7	EventID	string	0	MIN	Mandatory when @Success = 1 - the EventID of the payment event in Customer Account
8	SetRemainingOrdersToHAL	boolean	1	0 or 1	If items of the order remain on ANG (e.g. for partial deliveries) they can be set back to HAL =1

Request body

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dem="https://api.pixi.eu/soap/demosandbox/">
   <soapenv:Header/>
   <soapenv:Body>
      <dem:pixiPaySetInvoiceCapture>
         <dem:InvoiceNr>DEM0000021</dem:InvoiceNr>
         <dem:Success>0 or 1</dem:Success>
         <dem:PayID>31HA07BC812E3C3FDD691A7818766939</dem:PayID>
         <dem:PayCode>CC</dem:PayCode>
         <dem:Message>Amount of 46.18 EUR was captured</dem:Message>
         <dem:CaptureSum>46.18</dem:CaptureSum>
         <dem:EventID>MIN</dem:EventID>
         <dem:SetRemainingOrdersToHAL>0 or 1</dem:SetRemainingOrdersToHAL>
      </dem:pixiPaySetInvoiceCapture>
   </soapenv:Body>
</soapenv:Envelope>

Response

Body 1: Return status

#	Name	Type	Description
1	Status	string	Result of API Call
2	Message	string	Extended Result of API Call

Additional Notes

@Success - Was the capture successful?
IF not(@Success = 0), the call sets the PayedSum in Invoices to "0" and all connected payment data for the invoice will be reset to unpaid.
IF yes(@Success = 1), the call will create manual booking event in Customer Account.