Unofficial Pixi-API-Documentation

by koempf24.de

pixiAutomatchPayments

Pixi-Docs
Old Pixi-Docs

API call creates an automatic match and releases the order.

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:

Payments

Request

POST https://apigateway.descartes.com/tms/pixi/pixiAutomatchPayments

Request body

Name Type Required Description
BankHeaderKey integer false

[mandatory] BankHeader ID - used for identifying banklines for matching.

Type: int

Default value:

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)
SuppressOutput boolean false

Type: bit

Default value:

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiAutomatchPayments>
      <BankHeaderKey>0</BankHeaderKey>
      <SuppressOutput>true</SuppressOutput>
    </pixiAutomatchPayments>
  </Body>
</Envelope>

Response

Name Type Description

Response Example

<PixiAutomatchPaymentsPost200TextXmlResponse />

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:pixiAutomatchPayments>
            <BankHeaderKey xsi:type="xsd:integer"></BankHeaderKey>
            <SuppressOutput xsi:type="xsd:boolean"></SuppressOutput>
        </ns1:pixiAutomatchPayments>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiAutomatchPayments', [
    'BankHeaderKey' => '', // integer
    'SuppressOutput' => '', // 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);
}