pixiGetPaymenttypes · Pixi API documentation

Reads the payment types from the Payments table and returns, for each one, its Code, PaymentText, IniOrderStatus and XMLTag.

Parameters sent as an empty string are treated as not set (NULL).
If no parameter is set, all payment types are returned.
If one or more parameters are set, a payment type is returned when it matches at least one of the given values:
- Code equals Code
- PaymentText equals PaymentText
- IniOrderStatus equals IniOrderStatus
- XMLTag equals TagXML

All comparisons are exact matches; there is no wildcard search. No sort order is applied.

Notes

The filters are combined with OR, not AND. Passing e.g. both Code and IniOrderStatus returns payment types that match either value, not only those that match both.
The table is read WITH (NOLOCK), so uncommitted changes may be visible.
The parameter for the XML tag is named TagXML, while the returned column is named XMLTag.
Because SQL Server ignores trailing spaces in string comparisons, a value consisting only of spaces is also treated as not set.
The column types in the result are not visible in the code; the types given here mirror the parameter types used for the comparisons.

Tables used

Payments · Read

Parameter	Type	Default	Description
`Code`	varchar(1) string	–	One-character code of the payment type. Empty means no filter on the code. Example: `V`
`PaymentText`	varchar(32) string	–	Exact text (name) of the payment type. Empty means no filter on the text. Example: `Vorkasse`
`IniOrderStatus`	varchar(3) string	–	Initial order status assigned to orders with this payment type. Empty means no filter on the status. Example: `VK`
`TagXML`	varchar(32) string	–	XML tag of the payment type, compared with the column `XMLTag`. Empty means no filter on the tag. Example: `PREPAYMENT`

Result set 1 · Always; all payment types if no parameter is set, otherwise those matching at least one given value.

One row per payment type.

Column	Type	Description
`Code` Nullable	varchar(1) string	One-character code of the payment type.
`PaymentText` Nullable	varchar(32) string	Text (name) of the payment type.
`IniOrderStatus` Nullable	varchar(3) string	Initial order status for orders with this payment type.
`XMLTag` Nullable	varchar(32) string	XML tag used for this payment type, e.g. in order imports.

Response example

<SqlRowSet1>
  <row>
    <Code>V</Code>
    <PaymentText>Vorkasse</PaymentText>
    <IniOrderStatus>VK</IniOrderStatus>
    <XMLTag>PREPAYMENT</XMLTag>
  </row>
  <row>
    <Code>R</Code>
    <PaymentText>Rechnung</PaymentText>
    <IniOrderStatus>AU</IniOrderStatus>
    <XMLTag>INVOICE</XMLTag>
  </row>
</SqlRowSet1>

POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
Authorization: Basic BASE64(USERNAME:PASSWORD)

<?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/">
  <SOAP-ENV:Body>
    <ns1:pixiGetPaymenttypes>
      <!-- <Code>V</Code> -->
      <!-- <PaymentText>Vorkasse</PaymentText> -->
      <!-- <IniOrderStatus>VK</IniOrderStatus> -->
      <!-- <TagXML>PREPAYMENT</TagXML> -->
    </ns1:pixiGetPaymenttypes>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

curl -X POST 'https://apigateway.descartes.com/tms/pixi/' \
  --user 'USERNAME:PASSWORD' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --data-binary @- <<'XML'
<?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/">
  <SOAP-ENV:Body>
    <ns1:pixiGetPaymenttypes>
      <!-- <Code>V</Code> -->
      <!-- <PaymentText>Vorkasse</PaymentText> -->
      <!-- <IniOrderStatus>VK</IniOrderStatus> -->
      <!-- <TagXML>PREPAYMENT</TagXML> -->
    </ns1:pixiGetPaymenttypes>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML

<?php

$soapClient = new SoapClient(null, [
    'login' => 'USERNAME',
    'password' => 'PASSWORD',
    'location' => 'https://apigateway.descartes.com/tms/pixi/',
    'uri' => 'https://apigateway.descartes.com/tms/pixi/',
]);

$arguments = [
    // 'Code' => 'V',
    // 'PaymentText' => 'Vorkasse',
    // 'IniOrderStatus' => 'VK',
    // 'TagXML' => 'PREPAYMENT',
];

$soapArguments = [];
foreach ($arguments as $name => $value) {
    $soapArguments[] = new SoapVar($value, XSD_STRING, '', '', $name);
}

$response = $soapClient->__soapCall('pixiGetPaymenttypes', $soapArguments);