Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetPaymenttypes

Pixi-Docs
Old Pixi-Docs

This call gets all the payment types of the customer

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

General

Request

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

Request body

Name Type Required Description
Code string false

Code

Type: varchar(1)

Default value:

Example:

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

TagXML

Type: varchar(32)

Default value:

Example:

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

PaymentText

Type: varchar(32)

Default value:

Example:

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

IniOrderStatus

Type: varchar(3)

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="">
    <pixiGetPaymenttypes>
      <Code>string</Code>
      <PaymentText>string</PaymentText>
      <IniOrderStatus>string</IniOrderStatus>
      <TagXML>string</TagXML>
    </pixiGetPaymenttypes>
  </Body>
</Envelope>

Response

1. Result set

Name Type Description
Code string

Uniqe code of the paymenttype

Type: varchar

Available from: 25.06 (25.6.0.58802)
XMLTag string

XML is the tag of the paymenttype which is used in open trans for example

Type: nvarchar

Available from: 25.06 (25.6.0.58802)
PaymentText string

Name of the paymenttype

Type: varchar

Available from: 25.06 (25.6.0.58802)
IniOrderStatus string

IniOrderStatus is the default stauts of an order after export with that paymenttype

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetPaymenttypesPost200TextXmlResponse>
  <Code>string</Code>
  <PaymentText>string</PaymentText>
  <IniOrderStatus>string</IniOrderStatus>
  <XMLTag>string</XMLTag>
</PixiGetPaymenttypesPost200TextXmlResponse>

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:pixiGetPaymenttypes>
            <Code xsi:type="xsd:string"></Code>
            <TagXML xsi:type="xsd:string"></TagXML>
            <PaymentText xsi:type="xsd:string"></PaymentText>
            <IniOrderStatus xsi:type="xsd:string"></IniOrderStatus>
        </ns1:pixiGetPaymenttypes>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetPaymenttypes', [
    'Code' => '', // string
    'TagXML' => '', // string
    'PaymentText' => '', // string
    'IniOrderStatus' => '', // 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);
}