Unofficial Pixi-API-Documentation

by koempf24.de

pixiPaySetAuthorizationStatus

Pixi-Docs
Old Pixi-Docs

API Call for settings Pay Set Authorization Status

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

Payments

Request

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

Request body

Name Type Required Description
AuthID string false

Authorizazion ID, will be written back into the OrderHeader to ccpPayID

Type: varchar(50)

Default value:

Example:

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

This message will be logged additionally in pixi CCP Logfile.

Type: varchar(200)

Default value:

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)
OrderNr integer false

OrderNr of the order that was tried to authorized

Type: int

Default value:

Example:

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

Flag if the autorization was successull

Type: bit

Default value:

Example:

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

Return Code of the Payment Provider. will be written into OrderHeader ccpLastAuthCode

Type: varchar(50)

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="">
    <pixiPaySetAuthorizationStatus>
      <OrderNr>0</OrderNr>
      <Success>true</Success>
      <AuthID>string</AuthID>
      <AuthCode>string</AuthCode>
      <Message>string</Message>
    </pixiPaySetAuthorizationStatus>
  </Body>
</Envelope>

Response

Name Type Description

Response Example

<PixiPaySetAuthorizationStatusPost200TextXmlResponse />

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:pixiPaySetAuthorizationStatus>
            <AuthID xsi:type="xsd:string"></AuthID>
            <Message xsi:type="xsd:string"></Message>
            <OrderNr xsi:type="xsd:integer"></OrderNr>
            <Success xsi:type="xsd:boolean"></Success>
            <AuthCode xsi:type="xsd:string"></AuthCode>
        </ns1:pixiPaySetAuthorizationStatus>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiPaySetAuthorizationStatus', [
    'AuthID' => '', // string
    'Message' => '', // string
    'OrderNr' => '', // integer
    'Success' => '', // boolean
    'AuthCode' => '', // 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);
}