pixiPayGetOrdersToAuthorize

API Call made for Payment-Apps to get all orders that need authorizing

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


Request

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

Request body

Name Type Required Description
ShowAll boolean false

If true (1), shows all orders even though ccpSetFailTries is > 3 (Default 0)

Type: bit

Default value:

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

RowCount integer false

Number of rows that is returned by API call. Default = 30.

Type: int

Default value:

Example:

Available from: 22.06 (22.6.0.28129)

PaymentCode string false

PaymentCode of the specific Payment that shall be listed.

Type: char

Default value:

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)


Response

1. List of orders to authorize

Name Type Description
ZIP string

ZIP

Type: varchar

Available from: 25.06 (25.6.0.58802)

City string

City

Type: varchar

Available from: 25.06 (25.6.0.58802)

Phone string

Phone

Type: varchar

Available from: 25.06 (25.6.0.58802)

Anrede string

Salutation

Type: varchar

Available from: 25.06 (25.6.0.58802)

CareOf string

Care Of

Type: varchar

Available from: 25.06 (25.6.0.58802)

ShopID string

Shop ID

Type: varchar

Available from: 25.06 (25.6.0.58802)

Address string

Address

Type: varchar

Available from: 25.06 (25.6.0.58802)

CardCVC string

Card CVC

Type: varchar

Available from: 25.06 (25.6.0.58802)

Country string

Country

Type: varchar

Available from: 25.06 (25.6.0.58802)

OrderNr integer

pixi Order Number

Type: int

Available from: 25.06 (25.6.0.58802)

LastName string

Last Name

Type: varchar

Available from: 25.06 (25.6.0.58802)

ShipCost number

The total shipping costs of the whole order

Type: money

Available from: 25.06 (25.6.0.58802)

ccpPayID string

ID of credit card payment

Type: varchar

Available from: 25.06 (25.6.0.58802)

CardOwner string

Card Owner

Type: varchar

Available from: 25.06 (25.6.0.58802)

FirstName string

First Name

Type: varchar

Available from: 25.06 (25.6.0.58802)

CardNumber string

Card Number

Type: varchar

Available from: 25.06 (25.6.0.58802)

OrderTotal number

Order total

Type: money

Available from: 25.06 (25.6.0.58802)

CCPNumOfTries integer

Number of tries

Type: int

Available from: 25.06 (25.6.0.58802)

OrderCurrency string

Order currency

Type: varchar

Available from: 25.06 (25.6.0.58802)

CardExpiration string

Card Expiration

Type: varchar

Available from: 25.06 (25.6.0.58802)

CCPLastAuthCode string

Last Authorization Code

Type: varchar

Available from: 25.06 (25.6.0.58802)

OrderLinesTotal number

Order lines total

Type: money

Available from: 25.06 (25.6.0.58802)

OrderNrExternal string

External order number

Type: varchar

Available from: 25.06 (25.6.0.58802)

ccpSetFailTries integer

Number of failed transations

Type: int

Available from: 25.06 (25.6.0.58802)

CCPPaymentInfoOK string

Payment Info OK

Type: varchar

Available from: 25.06 (25.6.0.58802)

CCPReauthorizeYN string

Re-authorize (Y(es) / N(o))

Type: varchar

Available from: 25.06 (25.6.0.58802)

OrderLinesDiscount number

Order lines discount

Type: money

Available from: 25.06 (25.6.0.58802)

OrderLinesTotalANG number

Order lines total for all orderlines on ANG status

Type: decimal

Available from: 25.06 (25.6.0.58802)

OrderLinesTotalAUS number

Order lines total for all orderlines on AUS status

Type: decimal

Available from: 25.06 (25.6.0.58802)

OrderLinesTotalHAL number

Order lines total for all orderlines on HAL status

Type: decimal

Available from: 25.06 (25.6.0.58802)

ShipCost_OrderCurr number

Ship costs (obsolete)

Type: money

Available from: 25.06 (25.6.0.58802)

ccpSetFailLastTime string

Date time of last failed transaction.

Type: datetime

Available from: 25.06 (25.6.0.58802)

OrderLinesTotal_OrderCurr number

Order lines total (obsolete)

Type: money

Available from: 25.06 (25.6.0.58802)

OrderLinesTotalANG_OrderCurr number

Order lines total for all orderlines on ANG status (obsolete)

Type: decimal

Available from: 25.06 (25.6.0.58802)

OrderLinesTotalAUS_OrderCurr number

Order lines total for all orderlines on AUS status (obsolete)

Type: decimal

Available from: 25.06 (25.6.0.58802)

OrderLinesTotalHAL_OrderCurr number

Order lines total for all orderlines on HAL status (obsolete)

Type: decimal

Available from: 25.06 (25.6.0.58802)