Unofficial Pixi-API-Documentation

by koempf24.de

pixiSetCreditCardInfo

Pixi-Docs
Old Pixi-Docs

API call for updating the credit card information

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes: The Api call will exit with return value 0 when it was successfull. And with return value 1 in case of error.

Orderlines Orders

Request

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

Request body

Name Type Required Description
OrderNr integer true

Filter: pixi* order number

Type: int

Default value:

Example: 123

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

Value to populate the credit card authentication code.

Type: varchar(50)

Default value: NULL

Example: abcdefg

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

Switch to scramble the credit card data

Type: bit

Default value: 1

Example: 0 or 1

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiSetCreditCardInfo>
      <OrderNr>0</OrderNr>
      <ScrambleData>true</ScrambleData>
      <AuthCode>string</AuthCode>
    </pixiSetCreditCardInfo>
  </Body>
</Envelope>

Response

Name Type Description

Response Example

<PixiSetCreditCardInfoPost200TextXmlResponse />

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:pixiSetCreditCardInfo>
            <OrderNr xsi:type="xsd:integer">123</OrderNr> <!-- required -->
            <AuthCode xsi:type="xsd:string">abcdefg</AuthCode>
            <ScrambleData xsi:type="xsd:boolean">0 or 1</ScrambleData>
        </ns1:pixiSetCreditCardInfo>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiSetCreditCardInfo', [
    'OrderNr' => '123', // integer (required)
    'AuthCode' => 'abcdefg', // string
    'ScrambleData' => '0 or 1', // 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);
}