pixiGetPendingPayments
API Call to get pending payments at a specific time. Multi Currency: Return database currency code in field dbCurrency depend on if Multi Currency is Enabled then we:
- calculate and return data in database currency else
- calculate and return data in order / original currency (with value NULL for currency code).
Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:
Request
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| Date | string | false | Date when you want to have this export Type: datetime Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
| ShopID | string | false | Shop Id Type: varchar(3) Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
| Details | boolean | false | 1 = you'll see the details of this report, 0 = you'll only get payment type and amount at the specified date Type: bit Default value: 0 Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiGetPendingPayments>
<Date>string</Date>
<Details>true</Details>
<ShopID>string</ShopID>
</pixiGetPendingPayments>
</Body>
</Envelope>Response
1. Result set
| Name | Type | Description |
|---|---|---|
| Amount | number | Amount Type: money Available from: 25.06 (25.6.0.58802) |
| ShopID | string | ShopID Type: varchar Available from: 25.06 (25.6.0.58802) |
| Comment | string | Comment Type: varchar Available from: 25.06 (25.6.0.58802) |
| CustRef | integer | Customer Id Type: int Available from: 25.06 (25.6.0.58802) |
| Reference | string | Reference Type: varchar Available from: 25.06 (25.6.0.58802) |
| OpenAmount | number | OpenAmount Type: money Available from: 25.06 (25.6.0.58802) |
| dbCurrency | string | dbCurrency Type: varchar Available from: 25.06 (25.6.0.58802) |
| PaymentType | string | PaymentType Type: varchar Available from: 25.06 (25.6.0.58802) |
| CustomerAccountKey | integer | Customer Account Key Type: int Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetPendingPaymentsPost200TextXmlResponse>
<CustRef>0</CustRef>
<CustomerAccountKey>0</CustomerAccountKey>
<Comment>string</Comment>
<Reference>string</Reference>
<Amount>0</Amount>
<OpenAmount>0</OpenAmount>
<PaymentType>string</PaymentType>
<ShopID>string</ShopID>
<dbCurrency>string</dbCurrency>
</PixiGetPendingPaymentsPost200TextXmlResponse>2. Result set
| Name | Type | Description |
|---|---|---|
| Date | string | Date Type: datetime Available from: 25.06 (25.6.0.58802) |
| OpenAmount | string | OpenAmount Type: varchar Available from: 25.06 (25.6.0.58802) |
| dbCurrency | string | dbCurrency Type: varchar Available from: 25.06 (25.6.0.58802) |
| PaymentType | string | PaymentType Type: varchar Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetPendingPaymentsPost200TextXmlResponse>
<CustRef>0</CustRef>
<CustomerAccountKey>0</CustomerAccountKey>
<Comment>string</Comment>
<Reference>string</Reference>
<Amount>0</Amount>
<OpenAmount>0</OpenAmount>
<PaymentType>string</PaymentType>
<ShopID>string</ShopID>
<dbCurrency>string</dbCurrency>
</PixiGetPendingPaymentsPost200TextXmlResponse>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:pixiGetPendingPayments>
<Date xsi:type="xsd:string"></Date>
<ShopID xsi:type="xsd:string"></ShopID>
<Details xsi:type="xsd:boolean"></Details>
</ns1:pixiGetPendingPayments>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>PHP Example
<?php
getPixiSoapClientResponse('pixiGetPendingPayments', [
'Date' => '', // string
'ShopID' => '', // string
'Details' => '', // boolean
]);
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);
}