pixiPaySetAuthorizationStatus · Pixi API documentation

Used by an external payment provider (logged as pixi Apps Payment Provider) to report the outcome of an authorization for an order.

The order is looked up by OrderNr in OrderHeader. From it the procedure reads the customer reference, billing address reference, currency code (Currency.CodeA) and the CustomerOf (shop) of the customer. It also calculates the sum of qty * price of all orderlines of the order that are currently in status HAL.
Depending on Success:
- 1 (authorized): orderlines in status HAL are set to ANG; the log entry gets transaction type AU and code AUTHORIZED.
- 0 (declined, default): orderlines stay in status HAL; the log entry gets type DE and code AUTH DECLINED; the order's fail counter ccpSetFailTries is increased by 1.
The order header is updated: ccpNumOfTries is increased by 1, CCPLastAuthCode = AuthCode, ccpPayID = AuthID, CCPPaymentInfoOK = Y, CCPReauthorizeYN = N, ccpSetFailLastTime and UpdateDate = current time, UpdateEmp = API Call PaySetAuth.
All orderlines of the order with status HAL get the new status (see step 2), with UpdateEmp/UpdateDate set.
A row is inserted into CCPTranLog with vendor AP, the shop (CustomerOf), the order number, Message as note, the calculated HAL amount as total amount, customer and billing address references and the currency code.

The call returns no result set.

Notes

All changes run in one transaction (or a savepoint if a transaction is already open). On error the changes are rolled back and log.InsertError (not attached) is called; the code itself does not re-raise the error, so the caller may receive no error indication.
If OrderNr does not exist, no order header or orderlines are updated, but a CCPTranLog row is still inserted with empty (NULL) shop, customer, address and currency values. No error is returned.
CCPPaymentInfoOK is set to Y and ccpSetFailLastTime is updated even when Success = 0.
ccpSetFailTries is incremented without ISNULL; if the column is NULL it stays NULL.
The amount is calculated via Order_Id, while the orderlines to update are selected via OrderNr.
Lookups use NOLOCK; updates use ROWLOCK.
AuthID, AuthCode and Message have no default and must be sent.

Tables used

OrderHeader · Write Orderlines · Write CCPTranLog · Write Customers · Read Currency · Read

Parameter	Type	Default	Description
`OrderNr` Required	int	–	Pixi order number of the order whose authorization result is reported. Example: `100245`
`Success`	bit boolean	0	Result of the authorization. Allowed values `1` – Authorized: HAL orderlines are set to ANG, log type AU / AUTHORIZED. `0` – Declined: orderlines stay HAL, fail counter is increased, log type DE / AUTH DECLINED. Example: `1`
`AuthID` Required	varchar(50) string	–	Payment/authorization ID of the provider; stored in `OrderHeader.ccpPayID`. Example: `PAY-7F3A9C21`
`AuthCode` Required	varchar(50) string	–	Authorization code of the provider; stored in `OrderHeader.CCPLastAuthCode`. Example: `A12345`
`Message` Required	varchar(200) string	–	Free text message of the provider; stored as note (`CCPNote`) in the transaction log. Example: `Authorization approved`

This call returns no result set.

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:pixiPaySetAuthorizationStatus>
      <OrderNr>100245</OrderNr>
      <!-- <Success>1</Success> -->
      <AuthID>PAY-7F3A9C21</AuthID>
      <AuthCode>A12345</AuthCode>
      <Message>Authorization approved</Message>
    </ns1:pixiPaySetAuthorizationStatus>
  </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:pixiPaySetAuthorizationStatus>
      <OrderNr>100245</OrderNr>
      <!-- <Success>1</Success> -->
      <AuthID>PAY-7F3A9C21</AuthID>
      <AuthCode>A12345</AuthCode>
      <Message>Authorization approved</Message>
    </ns1:pixiPaySetAuthorizationStatus>
  </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 = [
    'OrderNr' => '100245',
    // 'Success' => '1',
    'AuthID' => 'PAY-7F3A9C21',
    'AuthCode' => 'A12345',
    'Message' => 'Authorization approved',
];

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

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