pixiCreateBanklineMatch

Match a bank line to an order.

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

     - When the value for **MaxMatchDelta** parameter is defined, the API call checks if the difference between bank line amount and order total is **smaller or equal** the value provided for parameter MaxMatchDelta. 
     - Only when this is true, a new bank line match will be added.
    
    Using **AutoReleaseOrder** parameter:
    
     - When **AutoReleaseOrder** parameter is set to **1** the API call will **release** the order **from status hold** automatically after a successful bank line match will be added and the amount paid by the customer equals the amount of the order total. 
     - If the difference of the order total and amount paid by the customer is not 0 or smaller than defined with parameter MaxMatchDelta. The  bank match will not be created and order will not be released.

Payments

Request

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

Request body

Name	Type	Required	Description
OrderNr	integer	false	Order which will be matched. Use either OrderNr or OrderNrExternal parameter Type: int Default value: Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927)
BanklineKey	integer	false	Match order to this bank line ID Type: int Default value: Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927)
MaxMatchDelta	number	false	Maximum allowed delta between order total and bank line amount Type: money Default value: Example: 9.99 Available from: AVA 17.12 (8.4.36.32642)
OrderNrExternal	string	false	Order which will be matched. Use either OrderNr or OrderNrExternal parameter Type: varchar(50) Default value: Example: abcdefg Available from: LOU Official - Update 46 (6.9.46.27927)
AutoReleaseOrder	boolean	false	Automatically release order from HOLD after the bank match is created Type: bit Default value: Example: 0 or 1 Available from: AVA 17.12 (8.4.36.32642)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiCreateBanklineMatch>
      <BanklineKey>0</BanklineKey>
      <OrderNr>0</OrderNr>
      <OrderNrExternal>string</OrderNrExternal>
      <MaxMatchDelta>0</MaxMatchDelta>
      <AutoReleaseOrder>true</AutoReleaseOrder>
    </pixiCreateBanklineMatch>
  </Body>
</Envelope>

Response

1. Bank match status

Name	Type	Description
Status	string	Bank match status Type: varchar (5) Available from: / (25.7.0.59144)
Message	string	Bank match error message Type: varchar (500) Available from: / (25.7.0.59144)
BankAmount	number	Bank line amount Type: money Available from: / (25.7.0.59144)
UsedAmount	number	Bank line used amount Type: money Available from: / (25.7.0.59144)
BankLineKey	integer	Bank line ID Type: int Available from: / (25.7.0.59144)

Response Example

<PixiCreateBanklineMatchPost200TextXmlResponse>
  <Status>string</Status>
  <Message>string</Message>
  <BankLineKey>0</BankLineKey>
  <BankAmount>0</BankAmount>
  <UsedAmount>0</UsedAmount>
</PixiCreateBanklineMatchPost200TextXmlResponse>

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:pixiCreateBanklineMatch>
            <OrderNr xsi:type="xsd:integer">123</OrderNr>
            <BanklineKey xsi:type="xsd:integer">123</BanklineKey>
            <MaxMatchDelta xsi:type="xsd:number">9.99</MaxMatchDelta>
            <OrderNrExternal xsi:type="xsd:string">abcdefg</OrderNrExternal>
            <AutoReleaseOrder xsi:type="xsd:boolean">0 or 1</AutoReleaseOrder>
        </ns1:pixiCreateBanklineMatch>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiCreateBanklineMatch', [
    'OrderNr' => '123', // integer
    'BanklineKey' => '123', // integer
    'MaxMatchDelta' => '9.99', // number
    'OrderNrExternal' => 'abcdefg', // string
    'AutoReleaseOrder' => '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);
}

Unofficial Pixi-API-Documentation

by koempf24.de