Unofficial Pixi-API-Documentation

by koempf24.de

pixiBanklineExists

Pixi-Docs
Old Pixi-Docs

API call returns a count of banklines found based on set parameters.

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

Payments

Request

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

Request body

Name Type Required Description
BankAmount number false

[optional] Bank amount from banklines.

Type: money

Default value: NULL

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)
BankText01 string false

[optional] if one of "BankText" parameters is set.

Type: varchar(1024)

Default value: NULL

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)
BankText02 string false

[optional] if one of "BankText" parameters is set.

Type: varchar(1024)

Default value: NULL

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)
BankText03 string false

[optional] if one of "BankText" parameters is set.

Type: varchar(1024)

Default value: NULL

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiBanklineExists>
      <BankText01>string</BankText01>
      <BankText02>string</BankText02>
      <BankText03>string</BankText03>
      <BankAmount>0</BankAmount>
    </pixiBanklineExists>
  </Body>
</Envelope>

Response

1. Status output

Name Type Description
count integer

Number of banklines found.

Type: int

Available from: 25.06 (25.6.0.58802)
error string

Error message.

Type: varchar

Available from: 25.06 (25.6.0.58802)
message string

Status message ofthe execution.

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiBanklineExistsPost200TextXmlResponse>
  <count>0</count>
  <message>string</message>
  <error>string</error>
</PixiBanklineExistsPost200TextXmlResponse>

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:pixiBanklineExists>
            <BankAmount xsi:type="xsd:number"></BankAmount>
            <BankText01 xsi:type="xsd:string"></BankText01>
            <BankText02 xsi:type="xsd:string"></BankText02>
            <BankText03 xsi:type="xsd:string"></BankText03>
        </ns1:pixiBanklineExists>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiBanklineExists', [
    'BankAmount' => '', // number
    'BankText01' => '', // string
    'BankText02' => '', // string
    'BankText03' => '', // string
]);

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);
}