pixiPayGetInvoicesToCapture
API Call made for Payment-Apps to get all orders that need capturing. These are all invoice for a specific payment type, that are created and shipped out! Make sure you email the shop owner on error! When the invoice shows up in this API Call, its allready shiped!
Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
ShowAll | boolean | false | If True (1), also Invoice with ccpSetFailTries > 3 are shown (Default = 0) Type: bit Default value: Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
RowCount | integer | false | Number of rows that is returned by API call. Default = 30. Type: int Default value: Example: Available from: 22.06 (22.6.0.28129) |
PaymentCode | string | false | PaymentCode of the specific Payment that shall be listed. Type: char Default value: Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
FromInvoiceId | integer | false | Optional parameter to define from which InvoiceId on results are shown. Default = 0 Type: int Default value: Example: Available from: 22.06 (22.6.0.28129) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiPayGetInvoicesToCapture>
<PaymentCode>string</PaymentCode>
<ShowAll>true</ShowAll>
<RowCount>0</RowCount>
<FromInvoiceId>0</FromInvoiceId>
</pixiPayGetInvoicesToCapture>
</Body>
</Envelope>
Response
1. Result if the call was successfull or not
Name | Type | Description |
---|---|---|
ZIP | string | ZIP Type: varchar Available from: 25.06 (25.6.0.58802) |
City | string | City Type: varchar Available from: 25.06 (25.6.0.58802) |
Phone | string | Phone Type: varchar Available from: 25.06 (25.6.0.58802) |
Total | number | Total Type: money Available from: 25.06 (25.6.0.58802) |
string | E-Mail address Type: varchar Available from: 25.06 (25.6.0.58802) |
|
Anrede | string | Salutation Type: varchar Available from: 25.06 (25.6.0.58802) |
CareOf | string | Care Of Type: varchar Available from: 25.06 (25.6.0.58802) |
ShopID | string | Shop ID Type: varchar Available from: 25.06 (25.6.0.58802) |
Address | string | Address Type: varchar Available from: 25.06 (25.6.0.58802) |
CardCVC | string | Card CVC Type: varchar Available from: 25.06 (25.6.0.58802) |
Country | string | Country Type: varchar Available from: 25.06 (25.6.0.58802) |
LastName | string | Last Name Type: varchar Available from: 25.06 (25.6.0.58802) |
PayedSum | number | Paid Summary Type: money Available from: 25.06 (25.6.0.58802) |
ccpPayID | string | ID of credit card payment Type: varchar Available from: 25.06 (25.6.0.58802) |
CardOwner | string | Card Owner Type: varchar Available from: 25.06 (25.6.0.58802) |
FirstName | string | First Name Type: varchar Available from: 25.06 (25.6.0.58802) |
InvoiceId | integer | Invoice ID Type: int Available from: 25.06 (25.6.0.58802) |
InvoiceNr | string | Invoice Number Type: varchar Available from: 25.06 (25.6.0.58802) |
CardNumber | string | Card Number Type: varchar Available from: 25.06 (25.6.0.58802) |
CCPRecharge | string | Re-charge (Y(es) / N(o)) Type: varchar Available from: 25.06 (25.6.0.58802) |
CCPNumOfTries | integer | Number of tries Type: int Available from: 25.06 (25.6.0.58802) |
OrderCurrency | string | Order currency Type: varchar Available from: 25.06 (25.6.0.58802) |
CardExpiration | string | Card Expiration Type: varchar Available from: 25.06 (25.6.0.58802) |
TotalToCapture | number | Total amount to capture Type: money Available from: 25.06 (25.6.0.58802) |
OrderNrExternal | string | External order number Type: varchar Available from: 25.06 (25.6.0.58802) |
Total_OrderCurr | number | Total (obsolete) Type: money Available from: 25.06 (25.6.0.58802) |
ccpSetFailTries | integer | Number of failed transations Type: int Available from: 25.06 (25.6.0.58802) |
OrderLinesTotalANG | number | Order lines total for all orderlines on ANG status Type: money Available from: 25.06 (25.6.0.58802) |
ccpSetFailLastTime | string | Date time of last failed transaction. Type: datetime Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiPayGetInvoicesToCapturePost200TextXmlResponse>
<InvoiceNr>string</InvoiceNr>
<OrderNrExternal>string</OrderNrExternal>
<Total>0</Total>
<OrderLinesTotalANG>0</OrderLinesTotalANG>
<PayedSum>0</PayedSum>
<TotalToCapture>0</TotalToCapture>
<Total_OrderCurr>0</Total_OrderCurr>
<OrderCurrency>string</OrderCurrency>
<ShopID>string</ShopID>
<CardOwner>string</CardOwner>
<CardNumber>string</CardNumber>
<CardExpiration>string</CardExpiration>
<CardCVC>string</CardCVC>
<Anrede>string</Anrede>
<CareOf>string</CareOf>
<FirstName>string</FirstName>
<LastName>string</LastName>
<Address>string</Address>
<City>string</City>
<ZIP>string</ZIP>
<Country>string</Country>
<Phone>string</Phone>
<eMail>string</eMail>
<CCPNumOfTries>0</CCPNumOfTries>
<CCPRecharge>string</CCPRecharge>
<ccpPayID>string</ccpPayID>
<ccpSetFailLastTime>string</ccpSetFailLastTime>
<ccpSetFailTries>0</ccpSetFailTries>
<InvoiceId>0</InvoiceId>
</PixiPayGetInvoicesToCapturePost200TextXmlResponse>
HTTP Example
POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
# echo -n '{{username}}:{{password}}' | base64 | pbcopy
Authorization: Basic {{token}}
<?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/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Body>
<ns1:pixiPayGetInvoicesToCapture>
<ShowAll xsi:type="xsd:boolean"></ShowAll>
<RowCount xsi:type="xsd:integer"></RowCount>
<PaymentCode xsi:type="xsd:string"></PaymentCode>
<FromInvoiceId xsi:type="xsd:integer"></FromInvoiceId>
</ns1:pixiPayGetInvoicesToCapture>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiPayGetInvoicesToCapture', [
'ShowAll' => '', // boolean
'RowCount' => '', // integer
'PaymentCode' => '', // string
'FromInvoiceId' => '', // integer
]);
function getPixiSoapClientResponse(string $method, array $arguments = [])
{
$soapArguments = [];
foreach ($arguments as $key => $value) {
$soapArguments[] = new SoapVar($value, null, '', '', $key);
}
$soapClient = new SoapClient(null, [
'login' => '...',
'password' => '...',
'uri' => 'https://apigateway.descartes.com/tms/pixi/',
'location' => 'https://apigateway.descartes.com/tms/pixi/',
]);
return $soapClient->__call($method, $soapArguments);
}