Skip Navigation

Payment Service

v4.35.1
Air
Payment
SOAP API
Airline Carrier
  • ApplePayMerchantId
  • "ApplePayMerchantID" Registered Apple Pay merchant ID that identifies merchant to Apple Pay as being able to accept payments. A Payment Processing certificate that is associated with the merchant ID is used to encrypt payment information.
  • ApplePayInd - a boolean value to indicate if ApplePay is used.
  • ApplePayCryptogram - json object contains details of the certificate value coming for ApplePay

API Information

Format
XML
Current Version
4.35.1
Environment
Production

What's New

  • ApplePayMerchantId
  • "ApplePayMerchantID" Registered Apple Pay merchant ID that identifies merchant to Apple Pay as being able to accept payments. A Payment Processing certificate that is associated with the merchant ID is used to encrypt payment information.
  • ApplePayInd - a boolean value to indicate if ApplePay is used.
  • ApplePayCryptogram - json object contains details of the certificate value coming for ApplePay

Business Value

  • Adding provision to use ApplePay related fields


  • PresentCreditCardInd

API Information

Format
XML
Current Version
4.35.0
Environment
Production

What's New

  • PresentCreditCardInd

Business Value

  • If true, the verification will be performed on any of credit cards that match on a ticket purchased.

New Features

In the Response

Optional

Parameter: PresentCreditCardInd

Type: boolean

Description: New optional attribute element "PresentCreditCardInd" added to PaymentRS/FraudCheckRS as a boolean true/false

Sample Value:

<PaymentRS SystemDateTime="2017-05-17T14:20:46" SabreTransactionID="01111495011036483002" Version="4.35.0" xmlns="http://www.opentravel.org/OTA/2003/05/beta">
    <POS SourceID="RADIXX"/>
    <MerchantDetail MerchantID="SD"/>
    <Result ResultCode="SUCCESS" Description="Successful Transaction" POSActionCode="PROCEED_REVIEW"/>
    <Results FOP_RPH="1">
        <FOP Type="CC" FOP_Code="CA"/>
        <AuthorizationResult ResponseCode="APPROVED" Description="Successful Transaction" SupplierID="CS" SupplierResponseCode="100" PaymentRef="01811652262783783883">
            <T3DS_Result IssuerURL="https://ipe.cert.havail.sabre.com/ipe/cs3ds2?merchantReference=01811652262783783883&amp;merchantId=SD">
                <AdditionalDetail>
                    <Field>
                        <Name>DDCURL</Name>
                        <Value>https://centinelapistag.cardinalcommerce.com/V1/Cruise/Collect</Value>
                    </Field>
                </AdditionalDetail>
            </T3DS_Result>
            <Remarks/>
        </AuthorizationResult>
        <FraudScreenResult Result="REVIEW" ReasonCode="102" Score="1" SupplierTransID="6691295362226687304021" PresentCreditCardInd="true">
            <Remarks>
                <Remark>RISK MGNT/REVIEW/100/1/6691295362226687304021</Remark>
            </Remarks>
        </FraudScreenResult>
        <ReturnURL>http://ipe.dev.sabre.com:7979/pwsair/afop_status?JSESSIONID=AD45D4356E6E2B769587CE3307BD3D85&amp;airline=7H&amp;status=challenge</ReturnURL>
    </Results>
</PaymentRS>
Note: If true, the verification will be performed on any of credit cards that match on a ticket purchased.

Functional Updates And Enhancements

In the Response

Optional

Parameter: PresentCreditCardInd

Type: boolean

Description: If true, the verification will be performed on any of credit cards that match on a ticket purchased.

Sample Value:

<FraudScreenResult Result="REVIEW" ReasonCode="102" Score="1" SupplierTransID="6691295362226687304021" PresentCreditCardInd="true">
            <Remarks>
                <Remark>RISK MGNT/REVIEW/100/1/6691295362226687304021</Remark>
            </Remarks>
        </FraudScreenResult>
Note: New optional attribute element "PresentCreditCardInd" added to PaymentRS/FraudCheckRS as a boolean true/false

  • T3DS_AuthenticationResult
  • PayByLinkURL

API Information

Format
XML
Current Version
4.34.0
Environment
Production

What's New

  • T3DS_AuthenticationResult
  • PayByLinkURL

New Features

In the Response

Optional

Parameter: T3DS_AuthenticationResult

Type: T3DS_AuthenticationResultType

Description: New optional element "T3DS_AuthenticationResult" added to PaymentRS/T3DS_AuthenticationResult

Sample Value:

<Result ResultCode="SUCCESS" Description="Successful Transaction"/>
    <T3DS_AuthenticationResult ResponseCode="INITIALIZEIFRAME" Description="Successful Transaction" SupplierID="CS" SupplierResponseCode="100" PaymentRef="01921691091022683407">
        <T3DS_Result IssuerURL="https://ipe-pmt.int.sabre.com/ipe/cs3ds2?merchantReference=01921691091022683407&merchantId=GETTHERE">
            <AdditionalDetail>
                <Field>
                    <Name>referenceId</Name>
                    <Value>fa48d911-c1dc-42f0-9da4-1abaf72231ad</Value>
                </Field>
                <Field>
                    <Name>DDCURL</Name>
                    <Value>https://centinelapistag.cardinalcommerce.com/V1/Cruise/Collect</Value>
                </Field>
                <Field>
                    <Name>JWT</Name>
                    <Value>eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJiNWUwZWU3MS03NTYyLTRmZmQtOTlmZi1iY2JiZDViZDk3NjAiLCJpYXQiOjE2OTEwOTEwMjMsImlzcyI6IjVkZDgzYmYwMGU0MjNkMTQ5OGRjYmFjYSIsImV4cCI6MTY5MTA5NDYyMywiT3JnVW5pdElkIjoiNThlN2YwMDczM2ZhZGQyNzFjYjkxNWQzIiwiUmVmZXJlbmNlSWQiOiJmYTQ4ZDkxMS1jMWRjLTQyZjAtOWRhNC0xYWJhZjcyMjMxYWQifQ.r_Gtig5oMizBQ3rl-hmpMZ1-whvtTPR7Qj71Io9x9Ak</Value>
                </Field>
                <Field>
                    <Name>threeDSMethodNotificationURL</Name>
                    <Value>https://ipe-pmt.int.sabre.com/ipe/cs3ds2response?merchantReference=01921691091022683407&&;merchantId=GETTHERE</Value>
                </Field>
                <Field>
                    <Name>IFRAMETARGET</Name>
                    <Value>3DSecureform</Value>
                </Field>
                <Field>
                    <Name>HEIGHT</Name>
                    <Value>1</Value>
                </Field>
                <Field>
                    <Name>WIDTH</Name>
                    <Value>1</Value>
                </Field>
            </AdditionalDetail>
        </T3DS_Result>
        <RedirectHTML><html></html></RedirectHTML>
    </T3DS_AuthenticationResult>
</PaymentRS>
Note: "T3DS_AuthenticationResult" added to PaymentRS/T3DS_AuthenticationResult

In the Response

Optional

Parameter: PayByLinkURL

Type: String

Description: New optional element "PayByLinkURL" added to PaymentRS/AuthorizationResultType/PayByLinkURL

Sample Value:

<AuthorizationResult ResponseCode="APPROVED" Description="" ApprovalCode="666" AuthAmountSent="4147590" SupplierID="MPGS" SupplierTransID="700014503245145" SupplierResponseCode="00"
        SupplierReferenceID="700014503245145" AcquirerResponseCode="00"  AuthRemarks1="AUTH-WPAY/BA1111/18JAN/01711453149269847464" AuthRemarks2="  AUTH-APV/666/0/COP3784600" PaymentConfirmInd="R" PaymentRef="01711453149269847464" SabreGeneratedApprovalCodeInd="true">
    <PayByLinkURL>https://sepg-hpp.int.sabre.com/validatetoken?sessionId=apwJGxux%2B9%2BIyiNMILWJ0nQS0Bxw%2BQgOg8WY7hTmkp6VFakrkCE</PayByLinkURL>
Note: "PayByLinkURL" added to PaymentRS/AuthorizationResultType/PayByLinkURL

Functional Updates And Enhancements

In the Response

Optional

Parameter: T3DS_AuthenticationResult

Type: T3DS_AuthenticationResultType

Description: New optional element "T3DS_AuthenticationResult" added to PaymentRS/T3DS_AuthenticationResult

Sample Value:

<Result ResultCode="SUCCESS" Description="Successful Transaction"/>
    <T3DS_AuthenticationResult ResponseCode="INITIALIZEIFRAME" Description="Successful Transaction" SupplierID="CS" SupplierResponseCode="100" PaymentRef="01921691091022683407">
        <T3DS_Result IssuerURL="https://ipe-pmt.int.sabre.com/ipe/cs3ds2?merchantReference=01921691091022683407&merchantId=GETTHERE">
            <AdditionalDetail>
                <Field>
                    <Name>referenceId</Name>
                    <Value>fa48d911-c1dc-42f0-9da4-1abaf72231ad</Value>
                </Field>
                <Field>
                    <Name>DDCURL</Name>
                    <Value>https://centinelapistag.cardinalcommerce.com/V1/Cruise/Collect</Value>
                </Field>
                <Field>
                    <Name>JWT</Name>
                    <Value>eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJiNWUwZWU3MS03NTYyLTRmZmQtOTlmZi1iY2JiZDViZDk3NjAiLCJpYXQiOjE2OTEwOTEwMjMsImlzcyI6IjVkZDgzYmYwMGU0MjNkMTQ5OGRjYmFjYSIsImV4cCI6MTY5MTA5NDYyMywiT3JnVW5pdElkIjoiNThlN2YwMDczM2ZhZGQyNzFjYjkxNWQzIiwiUmVmZXJlbmNlSWQiOiJmYTQ4ZDkxMS1jMWRjLTQyZjAtOWRhNC0xYWJhZjcyMjMxYWQifQ.r_Gtig5oMizBQ3rl-hmpMZ1-whvtTPR7Qj71Io9x9Ak</Value>
                </Field>
                <Field>
                    <Name>threeDSMethodNotificationURL</Name>
                    <Value>https://ipe-pmt.int.sabre.com/ipe/cs3ds2response?merchantReference=01921691091022683407&&;merchantId=GETTHERE</Value>
                </Field>
                <Field>
                    <Name>IFRAMETARGET</Name>
                    <Value>3DSecureform</Value>
                </Field>
                <Field>
                    <Name>HEIGHT</Name>
                    <Value>1</Value>
                </Field>
                <Field>
                    <Name>WIDTH</Name>
                    <Value>1</Value>
                </Field>
            </AdditionalDetail>
        </T3DS_Result>
        <RedirectHTML><html></html></RedirectHTML>
    </T3DS_AuthenticationResult>
</PaymentRS>
Note: "T3DS_AuthenticationResult" added to PaymentRS/T3DS_AuthenticationResult

In the Response

Optional

Parameter: PayByLinkURL

Type: String

Description: New optional element "PayByLinkURL" added to PaymentRS/AuthorizationResultType/PayByLinkURL

Sample Value:

<AuthorizationResult ResponseCode="APPROVED" Description="" ApprovalCode="666" AuthAmountSent="4147590" SupplierID="MPGS" SupplierTransID="700014503245145" SupplierResponseCode="00"
        SupplierReferenceID="700014503245145" AcquirerResponseCode="00"  AuthRemarks1="AUTH-WPAY/BA1111/18JAN/01711453149269847464" AuthRemarks2="  AUTH-APV/666/0/COP3784600" PaymentConfirmInd="R" PaymentRef="01711453149269847464" SabreGeneratedApprovalCodeInd="true">
    <PayByLinkURL>https://sepg-hpp.int.sabre.com/validatetoken?sessionId=apwJGxux%2B9%2BIyiNMILWJ0nQS0Bxw%2BQgOg8WY7hTmkp6VFakrkCE</PayByLinkURL>
Note: "PayByLinkURL" added to PaymentRS/AuthorizationResultType/PayByLinkURL

Resolved Issues

In the Response

Optional

Description: PresentCreditCardInd is added in the FraudCheckRS This indicator is used to perform the verification of the credit cards that was used to purchase the ticket


  • WebhookURL has been added in PaymentRQ
  • VirtualPaymentDetail has been added to PaymentDetail element of PaymentRQ and PaymentRS
  • Elements GetDeploymentResult, UpdateDeploymentResult and GetCardActivityResult and respective attributes has been added in PaymentRS

API Information

Format
XML
Current Version
v4.33.0
Environment
Production

What's New

  • WebhookURL has been added in PaymentRQ
  • VirtualPaymentDetail has been added to PaymentDetail element of PaymentRQ and PaymentRS
  • Elements GetDeploymentResult, UpdateDeploymentResult and GetCardActivityResult and respective attributes has been added in PaymentRS

Business Value

  • WebhookURL for further redirection to POS if status is webhook
  • VirtualPaymentDetail identifies a scope of a business purchase of virtual card
  • GetDeployment - Once an immediate deployment has been successful, the selected payment card can be retrieved from the system at any time. To re-retrieve the card from a previous deployment
  • UpdateDeploymentResult Updated deployment result
  • GetCardActivityResult - Virtual card activity details

New Features

In the Request

Optional

Parameter: WebhookURL

Type: string

Description: If the response status is webhook, then return to this POS url

Sample Value:

https://pwsair-pmt-sup-dev.apps.dev-01.us-central1.dev.sabre-gcp.com/webhook
Note: If the response status is webhook, then return to this POS url

In the Request/Response

Optional

Parameter: VirtualPaymentDetail

Type: object

Description: Information that identifies a scope of a business purchase of virtual card

Note: Information that identifies a scope of a business purchase of virtual card

In the Request/Response

Optional

Parameter: PurchaseType

Type: string

Description: Purchase type e.g. Generic

Note: Purchase type e.g. Generic

In the Request/Response

Optional

Parameter: PaymentStartDate

Type: date

Description: Payment start date e.g. 2022-12-15

Note: Payment start date e.g. 2022-12-15

In the Request/Response

Optional

Parameter: PaymentEndDate

Type: date

Description: Payment end date e.g. 2022-12-23

Note: Payment end date e.g. 2022-12-23

In the Request/Response

Optional

Parameter: SupplierID

Type: string

Description: Custom ID for the supplier

Note: Custom ID for the supplier

In the Request/Response

Optional

Parameter: UpdateNote

Type: string

Description: The note that describes virtual card updates/cancellation

Note: The note that describes virtual card updates/cancellation

In the Request/Response

Optional

Parameter: CustomIdentifiers

Type: object

Description: list of custom identifier data are submitted into Financial Partners system to report data via electronic reporting systems or to be printed on the paper statement

Note: list of custom identifier data are submitted into Financial Partners system to report data via electronic reporting systems or to be printed on the paper statement

In the Request/Response

Optional

Parameter: CustomIdentifier

Type: object

Description: Custom identifier data are submitted into Financial Partners system to report data via electronic reporting systems or to be printed on the paper statement

Note: Custom identifier data are submitted into Financial Partners system to report data via electronic reporting systems or to be printed on the paper statement

In the Request/Response

Optional

Parameter: Key

Type: string

Description: key for customer identifier data

In the Request/Response

Optional

Parameter: Value

Type: string

Description: Value for custom identifier data

In the Response

Optional

Parameter: GetDeploymentResult

Type: object

Description: Once an immediate deployment has been successful, the selected payment card can be retrieved from the system at any time. To re-retrieve the card from a previous deployment, we use the GetDeployment method

Note: Once an immediate deployment has been successful, the selected payment card can be retrieved from the system at any time. To re-retrieve the card from a previous deployment, we use the GetDeployment method

In the Response

Optional

Parameter: PaymentCard

Type: object

Description: Payment card details

Note: Payment card details

In the Response

Optional

Parameter: AmountDetail

Type: object

Description: Total transaction amount

Note: Total transaction amount

In the Response

Required

Parameter: ResponseCode

Type: string

Description: The response will contain the card that was been uniquely assigned to deployment

Note: The response will contain the card that was been uniquely assigned to deployment

In the Response

Optional

Parameter: Description

Type: string

Description: Description of the purchased ticket

Note: Description of the purchased ticket

In the Response

Optional

Parameter: CardDeploymentID

Type: string

Description: Declares CPAPI Deployment ID

Note: Declares CPAPI Deployment ID

In the Response

Optional

Parameter: CardStatus

Type: string

Description: Card status e.g. Deployed

Note: Card status e.g. Deployed

In the Response

Optional

Parameter: BookingID

Type: string

Description: Booking identifier as shown in the supplier/vendor system. This could also be The PNR locator in GDS/CRS system

Note: Booking identifier as shown in the supplier/vendor system. This could also be The PNR locator in GDS/CRS system

In the Response

Optional

Parameter: UpdateDeploymentResult

Type: object

Description: Updated deployment result

In the Response

Optional

Parameter: GetCardActivityResult

Type: object

Description: Virtual card activity details

In the Response

Optional

Parameter: CardActivities

Type: object

Description: List of card activities occured to the virtual card

In the Response

Optional

Parameter: ResultCode

Type: string

Description: Card activity result e.g. Authorise

Note: Card activity result e.g. Authorise

In the Response

Optional

Parameter: Type

Type: string

Description: Type of activity performed against the card e.g. Authorisation

Note: Type of activity performed against the card e.g. Authorisation

In the Response

Optional

Parameter: TransactionDateTime

Type: datetime

Description: The date and time of the card activity. Time is related to the time-zone of the Card Issuers processor

Note: The date and time of the card activity. Time is related to the time-zone of the Card Issuers processor
The date and time of the card activity. Time is related to the time-zone of the Card Issuers processor

In the Response

Optional

Parameter: CardIssuerDescription

Type: string

Description: Information provided by the Card Issuer

Note: Information provided by the Card Issuer

In the Response

Optional

Parameter: MerchantDetail

Type: object

Description: Details of the merchant

In the Response

Optional

Parameter: AmountDetail

Type: object

Description: Transaction amount details


  • ReturnURL, PaymentRef has been added in PaymentRS

API Information

Format
XML
Current Version
4.32.0
Environment
Production

What's New

  • ReturnURL, PaymentRef has been added in PaymentRS

Business Value

  • The appropriate (approved, declined etc.) URL which pos wants user to land on.

New Features

In the Response

Optional

Parameter: ReturnURL

Type: string

Description: The appropriate(approved,declined etc) url which pos wants user to land on

Sample Value:

https://pwsair-pmt-sup-dev.apps.us-central.dev.sabre-gcp.com
Note: The appropriate(approved,declined etc) url which pos wants user to land on

Functional Updates And Enhancements

In the Response

Optional

Parameter: ReturnURL

Type: string

Description: The appropriate(approved,declined etc) url which pos wants user to land on

Sample Value:

https://pwsair-pmt-sup-dev.apps.us-central.dev.sabre-gcp.com
Note: The appropriate(approved,declined etc) url which pos wants user to land on.

Resolved Issues

In the Response

Optional

Description: The appropriate(approved,declined etc) url which pos wants user to land on.


  • RemarkLines has been added in PaymentRQ

API Information

Format
XML
Endpoint
/v1/products
Current Version
4.30.0
Environment
Production

What's New

  • RemarkLines has been added in PaymentRQ

Business Value

  • This is to improve transaction reconciliation process for travel agent and customer

New Features

In the Request

Optional

Parameter: RemarkLines

Type: string

Description: PNR Remarks

Sample Value:

U*11-PAX NAME CDF
Note: PNR Remarks

Functional Updates And Enhancements

In the Request

Optional

Parameter: RemarkLines

Type: string

Description: PNR Remarks

Sample Value:

CDF AGAIN
Note: When Ticketing , EMD , MISF is paid with Virtual Form of Payment, the invoice remarks in the PNR will be automatically retrieved and passed to PWS in the RemarkLines

Resolved Issues

In the Request

Optional

Description: This is to improve transaction reconciliation process for travel agent and customer


  • LinkageID

API Information

Format
XML
Current Version
4.29.0
Environment
Production

What's New

  • LinkageID

Business Value

  • Unique identifier Used for linking PWS transactions

New Features

In the Request

Optional

Parameter: LinkageID

Type: string

Description: Unique identifier Used for linking PWS transactions

Sample Value:

01411654230967580227

Functional Updates And Enhancements

In the Request

Optional

Parameter: LinkageID

Type: string

Description: Unique identifier Used for linking PWS transactions

Sample Value:

LinkageID="01411654230967580227"

Resolved Issues

In the Request

Optional

Description: LinkageID is Unique identifier Used for linking PWS transactions


  • In this version new functionality, enhancements and defect fixes were introduced.

API Information

Format
XML
Current Version
4.28.0
Environment
Production

What's New

  • In this version new functionality, enhancements and defect fixes were introduced.

New Features

In the Response

Optional

Parameter: PaymentRS/Results/ValidateAndQueryPaymentDetailResult

Type: ValidateAndQueryPaymentDetailResultType

Description: Provides payment validation result and payment information details

Sample Value:

<ValidateAndQueryPaymentDetailResult Description="Successful"/>

In the Response

Optional

Parameter: PaymentRS/Results/ValidateAndQueryPaymentDetailResult/AdditionalApprovals

Type: AdditionalApprovals

Description: Used when multiple approvals are returned in single response

Sample Value:

<AdditionalApprovals>
       <Approval Type="AIDT-APPROVALCODE" Value="21115367"/>
               <Approval Type="AGENT FEE" Value="683620"/>
</AdditionalApprovals>

In the Response

Optional

Parameter: PaymentRS/Results/ValidateAndQueryPaymentDetailResult/AdditionalApprovals/Type

Type: String

Description: Type of approval under AdditionalApprovals

Sample Value:

 <Approval Type="AIDT-APPROVALCODE" Value="21115367"/>

In the Response

Optional

Parameter: PaymentRS/Results/ValidateAndQueryPaymentDetailResult/AdditionalApprovals/Value

Type: String

Description: Value of approval under AdditionalApprovals

Sample Value:

<Approval Type="AIDT-APPROVALCODE" Value="21115367"/>

In the Response

Required

Parameter: PaymentRS/Results/ValidateAndQueryPaymentDetailResult/ResultCode

Type: String

Description: Result code set by Sabre System for the request that was sent to the supplier eg: 'SUCCESS','PWS-INVALID-PAYLOAD', 'PWS-ERR','PNR-NOT-FOUND','PNR-NOT-ACTIVE'

Sample Value:

<ValidateAndQueryPaymentDetailResult ResultCode="OK"/>

In the Response

Optional

Parameter: PaymentRS/Results/ValidateAndQueryPaymentDetailResult/Description

Type: String

Description: Description set by Sabre System for the request that was sent to the supplier. eg: 'Successful Transaction' ,'INVALID PARTITION ID LENGTH: gaf' etc

Sample Value:

 <ValidateAndQueryPaymentDetailResult  Description="Successful"/>

In the Response

Optional

Parameter: PaymentRS/Results/ValidateAndQueryPaymentDetailResult/ApprovalCode

Type: String

Description: Approval Code returned by Supplier

Sample Value:

<ValidateAndQueryPaymentDetailResult ApprovalCode="4086"/>

In the Response

Optional

Parameter: PaymentRS/Results/ValidateAndQueryPaymentDetailResult/SupplierID

Type: String

Description: Identifier for Supplier (PSP or other 3rd party provider identifier)

Sample Value:

<ValidateAndQueryPaymentDetailResult  SupplierID="MPGS"/>

In the Response

Optional

Parameter: PaymentRS/Results/ValidateAndQueryPaymentDetailResult/SupplierTransID

Type: String

Description: the transaction Identifier returned by supplier (or PSP Reference)

Sample Value:

<ValidateAndQueryPaymentDetailResult SupplierTransID="500008007727318"/>

In the Response

Optional

Parameter: PaymentRS/Results/ValidateAndQueryPaymentDetailResult/PaymentConfirmInd

Type: String

Description: PaymentConfirmInd is when PWS needs to send API call to provider and/or if refund needs to get logged for batch processing

Sample Value:

<ValidateAndQueryPaymentDetailResult PaymentConfirmInd="R"/>

In the Response

Optional

Parameter: PaymentRS/Results/ValidateAndQueryPaymentDetailResult/PaymentRef

Type: String

Description: PaymentRef is the System generated reference number for this payment request.(Use this reference to query or cancel payment.)

Sample Value:

<ValidateAndQueryPaymentDetailResult PaymentRef="01711453149269847464"/>

In the Response

Optional

Parameter: PaymentRS/Results/ValidateAndQueryPaymentDetailResult/ErrorCode

Type: String

Description: Populated with relevant error response when transaction fails plausibilty check. Examples: DBI_REQUIRED, INVALID_CARD

Sample Value:

<ValidateAndQueryPaymentDetailResult ErrorCode="INVALID_CARD"/>

In the Response

Optional

Parameter: PaymentRQ/PassengerDetail/Document/DOC_RPH

Type: String

Description: RPH is record placeholder.Used to link documents, when multiple refunds or exchanges are requested in a single service request

Sample Value:

<Document DocType="TKT" DocNumber="1235678" InitialDocType="TKT" AlternateCurrency="USD" AlternateCurrencyDocAmount="123.45" TCN_Nbr="9876543211234" DOC_RPH="1"/>

In the Response

Optional

Parameter: PaymentRS/Results/ValidateAndQueryPaymentDetailResult/AdditionalNonHistoricalRemarks

Type: RemarksType

Description: Used by the calling application to store relevant data in the PNR remarks

Sample Value:

<AdditionalNonHistoricalRemarks>
                <Remark>X/-DBI$N1.1$CCTP122I200KV2O5859$PK-ER12</Remark>
                <Remark>X/-DBI/KS-DF12/IK-/PR-CV12</Remark>
                <Remark>X/-DBI/AK-/DS-/AE-</Remark>
                <Remark>X/-DBI/BD-/RZ-/AU-</Remark>
 </AdditionalNonHistoricalRemarks>

Functional Updates And Enhancements

In the Response

Optional

Parameter: PaymentRS/Results/ValidateAndQueryPaymentDetailResult

Type: ValidateAndQueryPaymentDetailResultType

Description: Provides payment validation result and payment information details

Sample Value:

<ValidateAndQueryPaymentDetailResult ResultCode="OK" />

Resolved Issues

In the Response

Optional

Description: PaymentRS/Results/ValidateAndQueryPaymentDetailResult


  • New optional element ReturnURL added to PaymentRS/Results/AccountValidationResult/ReturnURL
  • New optional element RedirectHTML added to PaymentRS/Results/AccountValidationResult/RedirectHTML
  • New optional attribute SupplierReferenceID added to PaymentRS/Results/AccountValidationResult/SupplierReferenceID
  • New optional attribute PaymentRef added to PaymentRS/Results/AccountValidationResult/PaymentRef
  • New optional attribute SupplierTransID added to PaymentRS/AccountDetail/SupplierTransID
  • New optional attribute AccountAuthenticationToken added to PaymentRS/AccountDetail/AccountAuthenticationToken
  • New optional attribute ThreeDSServerTransID added to PaymentRS/AuthorizationResult/T3DS_Result/ThreeDSServerTransID
  • New optional attribute SabreGeneratedApprovalCodeInd added to PaymentRS/AuthorizationResult/SabreGeneratedApprovalCodeInd
  • New optional attribute CAVV_ResultCode added to PaymentRS/AuthorizationResult/T3DS_Result/CAVV_ResultCode
  • New optional attribute OrganizationUnitID added to PaymentRQ/PaymentDetail/RoutingDetail/OrganizationUnitID
  • New optional attribute IssuerID added to PaymentRQ/PaymentDetail/RoutingDetail/IssuerID
  • New optional attribute MacKey added to PaymentRQ/PaymentDetail/RoutingDetail/MacKey

API Information

Format
XML
Current Version
4.27.0
Environment
Production

What's New

  • New optional element ReturnURL added to PaymentRS/Results/AccountValidationResult/ReturnURL
  • New optional element RedirectHTML added to PaymentRS/Results/AccountValidationResult/RedirectHTML
  • New optional attribute SupplierReferenceID added to PaymentRS/Results/AccountValidationResult/SupplierReferenceID
  • New optional attribute PaymentRef added to PaymentRS/Results/AccountValidationResult/PaymentRef
  • New optional attribute SupplierTransID added to PaymentRS/AccountDetail/SupplierTransID
  • New optional attribute AccountAuthenticationToken added to PaymentRS/AccountDetail/AccountAuthenticationToken
  • New optional attribute ThreeDSServerTransID added to PaymentRS/AuthorizationResult/T3DS_Result/ThreeDSServerTransID
  • New optional attribute SabreGeneratedApprovalCodeInd added to PaymentRS/AuthorizationResult/SabreGeneratedApprovalCodeInd
  • New optional attribute CAVV_ResultCode added to PaymentRS/AuthorizationResult/T3DS_Result/CAVV_ResultCode
  • New optional attribute OrganizationUnitID added to PaymentRQ/PaymentDetail/RoutingDetail/OrganizationUnitID
  • New optional attribute IssuerID added to PaymentRQ/PaymentDetail/RoutingDetail/IssuerID
  • New optional attribute MacKey added to PaymentRQ/PaymentDetail/RoutingDetail/MacKey


  • Added support to help process MIT transactions.

API Information

Format
XML
Current Version
4.26.0
Environment
Production

What's New

  • Added support to help process MIT transactions.

New Features

In the Response

Optional

Parameter: PaymentRS/Results/AccountValidationResult/T3DS_Result

Type: T3DS_Result

Description: Populates 3DS-related data.

Sample Value:

<T3DS_Result ECI="05" CAVV="CASDFEWESFSDF" XID="ABCDED" ECI_ResultCode="Y" UCAF_ResultCode="ab34fdf4341fk3j5454h4343ffeeerer" PA_ResponseCode="N" VE_ResponseCode="N" LiabilityShiftInd="true" Version="2.1.0" DirectoryServerTrxID=" eDAzVnZKZkd3MjdGMHUxbFNmSDE">
</T3DS_Result>

In the Response

Optional

Parameter: /PaymentRS/Results/AccountValidationResult/@NetworkTransactionReference

Type: String

Description: NetworkTransactionReference transaction ID supports merchant-initiated transaction (MIT) exemptions.

Sample Value:

<AccountValidationResult ResultCode="APPROVED" Description="" ApprovalCode="666" " SupplierID="MSTR" SupplierTransID="700014503245145" SupplierResponseCode="0"
SupplierReferenceID="700014503245145" NetworkTransactionReference="7055516966056621" >

In the Response

Optional

Parameter: PaymentRS/AccountValidationResult/T3DS_Result

Type: T3DS_Result

Description: Populates 3ds-related data.

In the Response

Optional

Parameter: PaymentRS/AuthorizationResult/T3DS_Result/DirectoryServerTrxID

Type: String

Description: Indicates 3ds2.0.

Sample Value:

DirectoryServerTrxID=" eDAzVnZKZkd3MjdGMHUxbFNmSDE"

In the Request

Optional

Parameter: PaymentRQ/PaymentDetail/PaymentCard/StoredCredentialTransactionInd

Type: Boolean

Description: StoredCredentialTransactionInd indicates merchant-initiated transactions (MIT) where merchants submit their transactions using previously-stored details, without the cardholder's participation.

Sample Value:

<PaymentCard NetworkTransactionReference="N1235678900" StoredCredentialTransactionInd="true" AuthenticationExemptionCode="7" ReadyFor3DSVersion="2.0" Bypass3DS="true" Trigger3DS="true" EncryptedCardNumber="39A494DBA5D015A172E1AA03A0D3CD87" ExtendPayment="00" ExpireDate="122019" T3DS_Ind="true" CardSecurityCode="300" CardNumber="8984001234565894" CardCode="BT">

In the Request

Optional

Parameter: PaymentRQ/PaymentDetail/PaymentCard/NetworkTransactionReference

Type: String

Description: NetworkTransactionReference transaction ID supports merchant-initiated transaction (MIT) exemptions.

Sample Value:

NetworkTransactionReference=""Nwer123445"

Functional Updates And Enhancements

In the Response

Optional

Parameter: PaymentRS/Results/AccountValidationResult/T3DS_Result

Type: T3DS_Result

Description: Populates 3DS-related data.

Sample Value:

 <T3DS_Result ECI="05" CAVV="CASDFEWESFSDF" XID="ABCDED" ECI_ResultCode="Y" UCAF_ResultCode="ab34fdf4341fk3j5454h4343ffeeerer" PA_ResponseCode="N" VE_ResponseCode="N" LiabilityShiftInd="true" Version="2.1.0" DirectoryServerTrxID=" eDAzVnZKZkd3MjdGMHUxbFNmSDE">
</T3DS_Result>

Resolved Issues

In the Response

Optional

Description: PaymentRS/Results/AccountValidationResult/T3DS_Result


  • MsfAgencyFeeDetail - Agency detail of Merchant service fee
  • AdditionalDetail - AdditionalDetails from and to POS
  • LiabilityShiftInd - Set to true if 3D-Secure resulted in merchant liability shift in request and response
  • Version - 3DS version in request and response
  • SystemTraceAuditNumber - Audit Number provided to the POS
  • AdditionalNonHistoricalRemarks - Used by the calling application to store relevant data in the PNR remarks
  • AuthenticationExemptionCode - Indicates Strong Customer Authentication (SCA) Exemption Code for card
  • Trigger3DS - Indicates whether to invoke standalone 3DS
  • Bypass3DS - Indicates whether to bypass standalone 3DS
  • ReadyFor3DSVersion - Indicates 3DS version integration readiness
  • BrowserJavaEnabled - Indicates the ability of the cardholder browser to execute Java
  • BrowserJavascriptEnabled - Indicates the ability of the cardholder browser to execute JavaScript
  • BrowserScreenHeight - Total height of the Cardholder's screen in pixels
  • BrowserScreenWidth - Total width of the Cardholder's screen in pixels
  • BrowserTimeZoneOffset - Time difference between UTC time and the Cardholder browser local time, in minutes
  • ChallengeWindowSize - Dimensions of the challenge window that has been displayed to the Cardholder. ChallengeWindowSize 01 = 250 x 400, 02 = 390 x 400, 03 = 500 x 600, 04 = 600 x 400, 05 = Full screen
  • ChallengeURL - Return URL if response is challenge
  • CountryCode - Issuer card's country code
  • Type - Installment type
  • Code - Installment code
  • GroupCode - Installment group code

API Information

Format
XML
Current Version
4.32.0
Environment
Production

What's New

  • MsfAgencyFeeDetail - Agency detail of Merchant service fee
  • AdditionalDetail - AdditionalDetails from and to POS
  • LiabilityShiftInd - Set to true if 3D-Secure resulted in merchant liability shift in request and response
  • Version - 3DS version in request and response
  • SystemTraceAuditNumber - Audit Number provided to the POS
  • AdditionalNonHistoricalRemarks - Used by the calling application to store relevant data in the PNR remarks
  • AuthenticationExemptionCode - Indicates Strong Customer Authentication (SCA) Exemption Code for card
  • Trigger3DS - Indicates whether to invoke standalone 3DS
  • Bypass3DS - Indicates whether to bypass standalone 3DS
  • ReadyFor3DSVersion - Indicates 3DS version integration readiness
  • BrowserJavaEnabled - Indicates the ability of the cardholder browser to execute Java
  • BrowserJavascriptEnabled - Indicates the ability of the cardholder browser to execute JavaScript
  • BrowserScreenHeight - Total height of the Cardholder's screen in pixels
  • BrowserScreenWidth - Total width of the Cardholder's screen in pixels
  • BrowserTimeZoneOffset - Time difference between UTC time and the Cardholder browser local time, in minutes
  • ChallengeWindowSize - Dimensions of the challenge window that has been displayed to the Cardholder. ChallengeWindowSize 01 = 250 x 400, 02 = 390 x 400, 03 = 500 x 600, 04 = 600 x 400, 05 = Full screen
  • ChallengeURL - Return URL if response is challenge
  • CountryCode - Issuer card's country code
  • Type - Installment type
  • Code - Installment code
  • GroupCode - Installment group code

New Features

In the Request

Optional

Parameter: MsfAgencyFeeDetail

Type: Element

Description: Merchant Service Fee detail Merchant Service Fee Profile ID Merchant Account Number Federal Tax ID

Sample Value:

<ns9:MsfAgencyFeeDetail FederalTaxId="123" MerchantAccountNumber="12345" MsfAgencyProfileId="10168"/>
Note: Merchant Service Fee detail

In the Response

Optional

Parameter: AdditionalDetail

Type: AdditionalDetailType

Description:

Sample Value:

<T3DS_Result>
<AdditionalDetail>
<Field>
                    <Name>threeDSServerTransID</Name>
                    <Value>066ba46c-b57e-4399-95b1-c419be374cba</Value>
            </Field>
</AdditionalDetail>
</T3DS_Result>
Note: Additional detail to POS

In the Response

Optional

Parameter: LiabilityShiftInd

Type: boolean

Description: Set to true if 3D-Secure resulted in merchant liability shift

Sample Value:

<T3DS_Result  LiabilityShiftInd="true">
Note: Set to true if 3D-Secure resulted in merchant liability shift

In the Response

Optional

Parameter: Version

Type: string

Description: 3DS Version

Sample Value:

<T3DS_Result Version="2.1.0">
Note: 3DS Version

In the Response

Optional

Parameter: SystemTraceAuditNumber

Type: string

Description: System Trace Audit Number

Sample Value:

<AuthResponseDetail  SystemTraceAuditNumber="721267"/>
Note: System Trace Audit Number to POS

In the Response

Optional

Parameter: AdditionalNonHistoricalRemarks

Type: RemarksType

Description:

Sample Value:

 <AdditionalNonHistoricalRemarks>
            <Remark>X/-DBI$N1.1$CCAX371I203478V0015$R1-1234</Remark>
            <Remark>X/-DBI/R2-3426/R3-456/R4-456</Remark>
            <Remark>X/-DBI/R5-1233/R6-456/OI-3426/VA-456</Remark>
</AdditionalNonHistoricalRemarks>
Note: Used by the calling application to store relevant data in the PNR remarks

In the Request

Optional

Parameter: AdditionalDetail

Type: AdditionalDetailType

Description:

Sample Value:

<T3DS>
    <AdditionalDetail>
                    <Field>
                        <Name>threeDSServerTransID</Name>
                        <Value>3618c547-ab11-4ab8-b85c-802621acfd8d</Value>
                    </Field>
  </AdditionalDetail>
</T3DS>
Note: AdditionalDetail from POS

In the Request

Optional

Parameter: LiabilityShiftInd

Type: boolean

Description: Set to true if 3D-Secure resulted in merchant liability shift

Sample Value:

<T3DS LiabilityShiftInd="true"/>
Note: Set to true if 3D-Secure resulted in merchant liability shift

In the Request

Optional

Parameter: AuthenticationExemptionCode

Type: string

Description: Indicates Strong Customer Authentication (SCA) Exemption Code

Sample Value:

<PaymentCard AuthenticationExemptionCode="7">
Note: Indicates Strong Customer Authentication (SCA) Exemption Code

In the Request

Optional

Parameter: Trigger3DS

Type: boolean

Description: Indicates whether to invoke standalone 3DS

Sample Value:

<PaymentCard Trigger3DS="true">
Note: Indicates whether to invoke standalone 3DS

In the Request

Optional

Parameter: Bypass3DS

Type: boolean

Description: Indicates whether to bypass standalone 3DS

Sample Value:

<PaymentCard  Bypass3DS="true>
Note: Indicates whether to bypass standalone 3DS

In the Request

Optional

Parameter: ReadyFor3DSVersion

Type: string

Description: Indicates 3DS version integration readiness (e.g. 2.1)

Sample Value:

<PaymentCard  ReadyFor3DSVersion="2.0">
Note: Indicates 3DS version integration readiness (e.g. 2.1)

In the Request

Optional

Parameter: BrowserJavaEnabled

Type: boolean

Description: Indicates the ability of the cardholder browser to execute Java

Sample Value:

<BrowserDetail BrowserJavaEnabled="true"/>
Note: Indicates the ability of the cardholder browser to execute Java

In the Request

Optional

Parameter: BrowserJavascriptEnabled

Type: boolean

Description: Indicates the ability of the cardholder browser to execute JavaScript

Sample Value:

<BrowserDetail BrowserJavascriptEnabled="true"/>
Note: Indicates the ability of the cardholder browser to execute JavaScript

In the Request

Optional

Parameter: BrowserScreenColorDepth

Type: integer

Description: Value representing the bit depth of the colour palette for displaying images, in bits per pixel

Sample Value:

<BrowserDetail  BrowserScreenColorDepth="32"/>
Note: Value representing the bit depth of the colour palette for displaying images, in bits per pixel

In the Request

Optional

Parameter: BrowserScreenHeight

Type: integer

Description: Total height of the Cardholder's screen in pixels

Sample Value:

<BrowserDetail BrowserScreenHeight="250"/>
Note: Total height of the Cardholder's screen in pixels

In the Request

Optional

Parameter: BrowserScreenWidth

Type: integer

Description: Total width of the Cardholder's screen in pixels

Sample Value:

<BrowserDetail BrowserScreenWidth="400"/>
Note: Total width of the Cardholder's screen in pixels

In the Request

Optional

Parameter: BrowserTimeZoneOffset

Type: integer

Description: Time difference between UTC time and the Cardholder browser local time, in minutes

Sample Value:

<BrowserDetail BrowserTimeZoneOffset="-120"/>
Note: Time difference between UTC time and the Cardholder browser local time, in minutes

In the Request

Optional

Parameter: BrowserTimeZoneOffset

Type: integer

Description: Dimensions of the challenge window that has been displayed to the Cardholder. ChallengeWindowSize 01 = 250 x 400, 02 = 390 x 400, 03 = 500 x 600, 04 = 600 x 400, 05 = Full screen

Sample Value:

<BrowserDetail ChallengeWindowSize="1"/>
Note: Dimensions of the challenge window that has been displayed to the Cardholder. ChallengeWindowSize 01 = 250 x 400, 02 = 390 x 400, 03 = 500 x 600, 04 = 600 x 400, 05 = Full screen

In the Request

Optional

Parameter: ChallengeURL

Type: string

Description:

Sample Value:

 <ChallengeURL>http://test.com&amp;status=challenge</ChallengeURL>
Note: ReturnUrl this url when response is challenge

In the Request

Optional

Parameter: CountryCode

Type: string

Description:

Sample Value:

<CardIssuerName CountryCode="EC" />
Note: Issuer country code of card

In the Request

Optional

Parameter: Type

Type: string

Description: Installment type

Sample Value:

<InstallmentDetail Type="D"/>
Note: Installment type

In the Request

Optional

Parameter: Code

Type: string

Description: Installment code

Sample Value:

<InstallmentDetail Code="12"/>
Note: Installment code

In the Request

Optional

Parameter: GroupCode

Type: string

Description: Installment group code

Sample Value:

<InstallmentDetail GroupCode="234"/>
Note: Installment group code

  • MsfAgencyFeeDetail - Agency detail of Merchant service fee
  • AdditionalDetail - AdditionalDetails from and to POS
  • LiabilityShiftInd - Set to true if 3D-Secure resulted in merchant liability shift in request and response
  • Version - 3DS version in request and response
  • SystemTraceAuditNumber - Audit Number provided to the POS
  • AdditionalNonHistoricalRemarks - Used by the calling application to store relevant data in the PNR remarks
  • AuthenticationExemptionCode - Indicates Strong Customer Authentication (SCA) Exemption Code for card
  • Trigger3DS - Indicates whether to invoke standalone 3DS
  • Bypass3DS - Indicates whether to bypass standalone 3DS
  • ReadyFor3DSVersion - Indicates 3DS version integration readiness
  • BrowserJavaEnabled - Indicates the ability of the cardholder browser to execute Java
  • BrowserJavascriptEnabled - Indicates the ability of the cardholder browser to execute JavaScript
  • BrowserScreenHeight - Total height of the Cardholder's screen in pixels
  • BrowserScreenWidth - Total width of the Cardholder's screen in pixels
  • BrowserTimeZoneOffset - Time difference between UTC time and the Cardholder browser local time, in minutes
  • ChallengeWindowSize - Dimensions of the challenge window that has been displayed to the Cardholder. ChallengeWindowSize 01 = 250 x 400, 02 = 390 x 400, 03 = 500 x 600, 04 = 600 x 400, 05 = Full screen
  • ChallengeURL - Return URL if response is challenge
  • CountryCode - Issuer card's country code
  • Type - Installment type
  • Code - Installment code
  • GroupCode - Installment group code

API Information

Format
XML
Current Version
4.32.0
Environment
Production

What's New

  • MsfAgencyFeeDetail - Agency detail of Merchant service fee
  • AdditionalDetail - AdditionalDetails from and to POS
  • LiabilityShiftInd - Set to true if 3D-Secure resulted in merchant liability shift in request and response
  • Version - 3DS version in request and response
  • SystemTraceAuditNumber - Audit Number provided to the POS
  • AdditionalNonHistoricalRemarks - Used by the calling application to store relevant data in the PNR remarks
  • AuthenticationExemptionCode - Indicates Strong Customer Authentication (SCA) Exemption Code for card
  • Trigger3DS - Indicates whether to invoke standalone 3DS
  • Bypass3DS - Indicates whether to bypass standalone 3DS
  • ReadyFor3DSVersion - Indicates 3DS version integration readiness
  • BrowserJavaEnabled - Indicates the ability of the cardholder browser to execute Java
  • BrowserJavascriptEnabled - Indicates the ability of the cardholder browser to execute JavaScript
  • BrowserScreenHeight - Total height of the Cardholder's screen in pixels
  • BrowserScreenWidth - Total width of the Cardholder's screen in pixels
  • BrowserTimeZoneOffset - Time difference between UTC time and the Cardholder browser local time, in minutes
  • ChallengeWindowSize - Dimensions of the challenge window that has been displayed to the Cardholder. ChallengeWindowSize 01 = 250 x 400, 02 = 390 x 400, 03 = 500 x 600, 04 = 600 x 400, 05 = Full screen
  • ChallengeURL - Return URL if response is challenge
  • CountryCode - Issuer card's country code
  • Type - Installment type
  • Code - Installment code
  • GroupCode - Installment group code

New Features

In the Request

Optional

Parameter: MsfAgencyFeeDetail

Type: Element

Description: Merchant Service Fee detail Merchant Service Fee Profile ID Merchant Account Number Federal Tax ID

Sample Value:

<ns9:MsfAgencyFeeDetail FederalTaxId="123" MerchantAccountNumber="12345" MsfAgencyProfileId="10168"/>
Note: Merchant Service Fee detail

In the Response

Optional

Parameter: AdditionalDetail

Type: AdditionalDetailType

Description:

Sample Value:

<T3DS_Result>
<AdditionalDetail>
<Field>
                    <Name>threeDSServerTransID</Name>
                    <Value>066ba46c-b57e-4399-95b1-c419be374cba</Value>
            </Field>
</AdditionalDetail>
</T3DS_Result>
Note: Additional detail to POS

In the Response

Optional

Parameter: LiabilityShiftInd

Type: boolean

Description: Set to true if 3D-Secure resulted in merchant liability shift

Sample Value:

<T3DS_Result  LiabilityShiftInd="true">
Note: Set to true if 3D-Secure resulted in merchant liability shift

In the Response

Optional

Parameter: Version

Type: string

Description: 3DS Version

Sample Value:

<T3DS_Result Version="2.1.0">
Note: 3DS Version

In the Response

Optional

Parameter: SystemTraceAuditNumber

Type: string

Description: System Trace Audit Number

Sample Value:

<AuthResponseDetail  SystemTraceAuditNumber="721267"/>
Note: System Trace Audit Number to POS

In the Response

Optional

Parameter: AdditionalNonHistoricalRemarks

Type: RemarksType

Description:

Sample Value:

 <AdditionalNonHistoricalRemarks>
            <Remark>X/-DBI$N1.1$CCAX371I203478V0015$R1-1234</Remark>
            <Remark>X/-DBI/R2-3426/R3-456/R4-456</Remark>
            <Remark>X/-DBI/R5-1233/R6-456/OI-3426/VA-456</Remark>
</AdditionalNonHistoricalRemarks>
Note: Used by the calling application to store relevant data in the PNR remarks

In the Request

Optional

Parameter: AdditionalDetail

Type: AdditionalDetailType

Description:

Sample Value:

<T3DS>
    <AdditionalDetail>
                    <Field>
                        <Name>threeDSServerTransID</Name>
                        <Value>3618c547-ab11-4ab8-b85c-802621acfd8d</Value>
                    </Field>
  </AdditionalDetail>
</T3DS>
Note: AdditionalDetail from POS

In the Request

Optional

Parameter: LiabilityShiftInd

Type: boolean

Description: Set to true if 3D-Secure resulted in merchant liability shift

Sample Value:

<T3DS LiabilityShiftInd="true"/>
Note: Set to true if 3D-Secure resulted in merchant liability shift

In the Request

Optional

Parameter: AuthenticationExemptionCode

Type: string

Description: Indicates Strong Customer Authentication (SCA) Exemption Code

Sample Value:

<PaymentCard AuthenticationExemptionCode="7">
Note: Indicates Strong Customer Authentication (SCA) Exemption Code

In the Request

Optional

Parameter: Trigger3DS

Type: boolean

Description: Indicates whether to invoke standalone 3DS

Sample Value:

<PaymentCard Trigger3DS="true">
Note: Indicates whether to invoke standalone 3DS

In the Request

Optional

Parameter: Bypass3DS

Type: boolean

Description: Indicates whether to bypass standalone 3DS

Sample Value:

<PaymentCard  Bypass3DS="true>
Note: Indicates whether to bypass standalone 3DS

In the Request

Optional

Parameter: ReadyFor3DSVersion

Type: string

Description: Indicates 3DS version integration readiness (e.g. 2.1)

Sample Value:

<PaymentCard  ReadyFor3DSVersion="2.0">
Note: Indicates 3DS version integration readiness (e.g. 2.1)

In the Request

Optional

Parameter: BrowserJavaEnabled

Type: boolean

Description: Indicates the ability of the cardholder browser to execute Java

Sample Value:

<BrowserDetail BrowserJavaEnabled="true"/>
Note: Indicates the ability of the cardholder browser to execute Java

In the Request

Optional

Parameter: BrowserJavascriptEnabled

Type: boolean

Description: Indicates the ability of the cardholder browser to execute JavaScript

Sample Value:

<BrowserDetail BrowserJavascriptEnabled="true"/>
Note: Indicates the ability of the cardholder browser to execute JavaScript

In the Request

Optional

Parameter: BrowserScreenColorDepth

Type: integer

Description: Value representing the bit depth of the colour palette for displaying images, in bits per pixel

Sample Value:

<BrowserDetail  BrowserScreenColorDepth="32"/>
Note: Value representing the bit depth of the colour palette for displaying images, in bits per pixel

In the Request

Optional

Parameter: BrowserScreenHeight

Type: integer

Description: Total height of the Cardholder's screen in pixels

Sample Value:

<BrowserDetail BrowserScreenHeight="250"/>
Note: Total height of the Cardholder's screen in pixels

In the Request

Optional

Parameter: BrowserScreenWidth

Type: integer

Description: Total width of the Cardholder's screen in pixels

Sample Value:

<BrowserDetail BrowserScreenWidth="400"/>
Note: Total width of the Cardholder's screen in pixels

In the Request

Optional

Parameter: BrowserTimeZoneOffset

Type: integer

Description: Time difference between UTC time and the Cardholder browser local time, in minutes

Sample Value:

<BrowserDetail BrowserTimeZoneOffset="-120"/>
Note: Time difference between UTC time and the Cardholder browser local time, in minutes

In the Request

Optional

Parameter: BrowserTimeZoneOffset

Type: integer

Description: Dimensions of the challenge window that has been displayed to the Cardholder. ChallengeWindowSize 01 = 250 x 400, 02 = 390 x 400, 03 = 500 x 600, 04 = 600 x 400, 05 = Full screen

Sample Value:

<BrowserDetail ChallengeWindowSize="1"/>
Note: Dimensions of the challenge window that has been displayed to the Cardholder. ChallengeWindowSize 01 = 250 x 400, 02 = 390 x 400, 03 = 500 x 600, 04 = 600 x 400, 05 = Full screen

In the Request

Optional

Parameter: ChallengeURL

Type: string

Description:

Sample Value:

 <ChallengeURL>http://test.com&amp;status=challenge</ChallengeURL>
Note: ReturnUrl this url when response is challenge

In the Request

Optional

Parameter: CountryCode

Type: string

Description:

Sample Value:

<CardIssuerName CountryCode="EC" />
Note: Issuer country code of card

In the Request

Optional

Parameter: Type

Type: string

Description: Installment type

Sample Value:

<InstallmentDetail Type="D"/>
Note: Installment type

In the Request

Optional

Parameter: Code

Type: string

Description: Installment code

Sample Value:

<InstallmentDetail Code="12"/>
Note: Installment code

In the Request

Optional

Parameter: GroupCode

Type: string

Description: Installment group code

Sample Value:

<InstallmentDetail GroupCode="234"/>
Note: Installment group code

  • OrderCreateDate : new attribute added to OrderDetail
  • LoyaltyMemberDetail : new element of type LoyaltyMembershipDetailType added to CustomerDetail
  • ErrorCode : new attribute added in PaymentRS/Result
  • PA_ResponseCode : new attribute added in T3DS_Result
  • VE_ResponseCode : new attribute added in T3DS_Result
  • LoyaltyMemberDetail : new element of type LoyaltyMembershipDetailType added to PassengerDetailType
  • ContactInfo : new element added to PassengerDetailType
  • LoyaltyMemberDetail : new element of type LoyaltyMembershipDetailType added to PaymentCardType
  • FopFeeAmount : new attribute added to AmountDetail
  • PromotionalInd : new attribute added to InstallmentDetail
  • Title : new attribute added to PersonNameGroup
  • MiddleName : new attribute added to PersonNameGroup
  • new complex type LoyaltyMembershipDetailType added

API Information

Format
XML
Current Version
4.17.0
Environment
Production

What's New

  • OrderCreateDate : new attribute added to OrderDetail
  • LoyaltyMemberDetail : new element of type LoyaltyMembershipDetailType added to CustomerDetail
  • ErrorCode : new attribute added in PaymentRS/Result
  • PA_ResponseCode : new attribute added in T3DS_Result
  • VE_ResponseCode : new attribute added in T3DS_Result
  • LoyaltyMemberDetail : new element of type LoyaltyMembershipDetailType added to PassengerDetailType
  • ContactInfo : new element added to PassengerDetailType
  • LoyaltyMemberDetail : new element of type LoyaltyMembershipDetailType added to PaymentCardType
  • FopFeeAmount : new attribute added to AmountDetail
  • PromotionalInd : new attribute added to InstallmentDetail
  • Title : new attribute added to PersonNameGroup
  • MiddleName : new attribute added to PersonNameGroup
  • new complex type LoyaltyMembershipDetailType added

Business Value

  • New attribute and elements added to the schema

New Features

In the Request

Optional

Parameter: OrderCreateDate

Type: string

Description: OrderCreateDate is a new attribute added to OrderDetail

Sample Value:

|-|OrderDetail OrderID="KGZWLN" RecordLocator="KGZWLN" OrderExpireDateTime="2016-04-01T14:43:49.289-05:00"  OrderCreateDate="2016-04-21"|--|

In the Request

Optional

Parameter: LoyaltyMemberDetail

Type: LoyaltyMembershipDetailType

Description: LoyaltyMemberDetail is a new element added to CustomerDetail

Sample Value:

|-|CustomerDetail Name="Test Customer"|--|      |-|CustomerID|--|           |-|Other ID="11111111111" Type="CPF" /|--|      |-|/CustomerID|--|        |-|Address|--|            |-|AddressLine1|--|123 Twinkle Street|-|/AddressLine1|--|            |-|AddressLine2|--|Lake Road|-|/AddressLine2|--|            |-|CityName|--|Southlake|-|/CityName|--|            |-|PostalCode|--|760980|-|/PostalCode|--|            |-|StateProv StateCode="TX"/|--|            |-|Country Code="US"/|--|            |-|District|--|Austin|-|/District|--|        |-|/Address|--|        |-|EmailAddress|--|test@sabre.com|-|/EmailAddress|--|        |-|PhoneNumber Number="111111111111" Type="HOME"/|--|       |-|LoyaltyMemberDetail Name="James Smith" Title="Mr" FirstName="James" MiddleName="R" LastName="Smith" MemberLoggedInInd="" ID="" Status="ACTIVE" Level="GOLD" IssueDate="2018-12-07" LoyaltyOalCode="" CurrentBalance="122"/|--|    |-|/CustomerDetail|--|

In the Request

Optional

Parameter: LoyaltyMemberDetail

Type: LoyaltyMembershipDetailType

Description: LoyaltyMemberDetail is a new element added to PassengerDetailType

Sample Value:

|-|LoyaltyMemberDetail Name="James Smith" Title="Mr" FirstName="James" MiddleName="R" LastName="Smith" MemberLoggedInInd="" ID="" Status="ACTIVE" Level="GOLD" IssueDate="2018-12-07" LoyaltyOalCode="" CurrentBalance="122"/|--|

In the Request

Optional

Parameter: LoyaltyMemberDetail

Type: LoyaltyMembershipDetailType

Description: LoyaltyMemberDetail is a new element added to PaymentCardType

Sample Value:

|-|LoyaltyMemberDetail Name="James Smith" Title="Mr" FirstName="James" MiddleName="R" LastName="Smith" MemberLoggedInInd="" ID="" Status="ACTIVE" Level="GOLD" IssueDate="2018-12-07" LoyaltyOalCode="" CurrentBalance="122"/|--|

In the Response

Optional

Parameter: PA_ResponseCode

Type: string

Description: PA_ResponseCode is a new attribute added in T3DS_Result

Sample Value:

|-|T3DS_Result ECI="02" ECI_ResultCode="Y" UCAF_ResultCode="ab34fdf4341fk3j5454h4343ffeeerer" PA_ResponseCode="N" VE_ResponseCode="N" /|--|

In the Response

Optional

Parameter: VE_ResponseCode

Type: string

Description: VE_ResponseCode is a new attribute added in T3DS_Result

Sample Value:

|-|T3DS_Result ECI="02" ECI_ResultCode="Y" UCAF_ResultCode="ab34fdf4341fk3j5454h4343ffeeerer" PA_ResponseCode="N" VE_ResponseCode="N" /|--|

In the Request

Optional

Parameter: ContactInfo

Type: ContactInfoType

Description: ContactInfo : is a new element added to PassengerDetailType

Sample Value:

|-|ContactInfo  FirstName="FirstName" LastName="LastName"|--|                |-|EmailAddress|--|test@test.com|-|/EmailAddress|--|                |-|PhoneNumber Number="1234567890" Type="M"/|--|            |-|/ContactInfo|--|

In the Request

Optional

Parameter: FopFeeAmount

Type: Money

Description: FopFeeAmount is a new attribute added to AmountDetail

Sample Value:

|-|AmountDetail Amount="2985.52" CurrencyCode="AUD" ExchangeRate="1.0" WithInterestInd="true" InterestAmount="" FopFeeAmount="111" /|--|

In the Request

Optional

Parameter: PromotionalInd

Type: boolean

Description: PromotionalInd is a new attribute added to InstallmentDetail

Sample Value:

|-|InstallmentDetail NumberOfInstallments="1" PromotionalInd="true"/|--|

In the Request

Optional

Parameter: LoyaltyMembershipDetailType

Type: LoyaltyMembershipDetailType

Description: New complex type LoyaltyMembershipDetailType added

Sample Value:

|-|LoyaltyMemberDetail Name="James Smith" Title="Mr" FirstName="James" MiddleName="R" LastName="Smith" MemberLoggedInInd="" ID="" Status="ACTIVE" Level="GOLD" IssueDate="2018-12-07" LoyaltyOalCode="" CurrentBalance="122"/|--|

In the Request

Optional

Parameter: Title

Type: string

Description: Title is a new attribute added to PersonNameGroup

Sample Value:

Title="Mr"

In the Request

Optional

Parameter: MiddleName

Type: string

Description: MiddleName is a new attribute added to PersonNameGroup

Sample Value:

MiddleName="Ross"

  • New attribute and elements added to the schema

API Information

Format
XML
Current Version
4.16.0
Environment
Production

What's New

  • New attribute and elements added to the schema

Business Value

  • New attribute and elements added to the schema

New Features

In the Request

Optional

Parameter: TCN_Nbr

Type: String

Description: New optional attribute TCN_Nbr of type String added to PaymentRQ/OrderDetail/@TCN_Nbr indicates transaction reference number to be passed from ticketing based on document issued

Sample Value:

|-|PaymentRQ xmlns="http://www.opentravel.org/OTA/2003/05/beta" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SabreTransactionID="01221450682499283451" SystemDateTime="2015-12-21T07:21:50.364"  Version="4.16.0" xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05/beta ../../PaymentRQ_v4.16.0.xsd"|--|     |-|Action Type="Issuance"|--|ConfirmAuth|-|/Action|--|    |-|POS CityCode="0EZC" PseudoCityCode="0EZC" AgentSine="AAS" StationNumber="11617270" ISOCountry="US" SettlementPlan="ARC" ChannelID="AGY" LocalDateTime="2015-12-21T01:56:00.000-06:00"/|--|    |-|MerchantDetail MerchantID="1S"/|--|    |-|OrderDetail OrderID="GRQMMP" RecordLocator="GRQMMP" ClearingSequence="1" ClearingCount="3" TCN_Nbr="9876543211234"|--| |-|/OrderDetail|--||-|/PaymentRQ|--|

In the Request

Optional

Parameter: TokenizedAccountNbr

Type: String

Description: New optional attribute "TokenizedAccountNbr" indicated Account number is tokenized

Sample Value:

|-|PaymentRQ xmlns="http://www.opentravel.org/OTA/2003/05/beta" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SystemDateTime="2001-12-17T09:30:47Z" SabreTransactionID="01221450682499283451"  Version="4.16.0" xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05/beta  ../PaymentRQ_v4.16.0.xsd"|--|   |-|Action Type="Issuance"|--|ConfirmAuth|-|/Action|--|  |-|POS StationNumber="41000864" ISOCountry="CA" ChannelID="ATO" LocalDateTime="2015-02-12T13:22:09.4601951-07:00"/|--|  |-|MerchantDetail MerchantID="WS"/|--|  |-|OrderDetail OrderID="CWTEWH" RecordLocator="CWTEWH" ClearingSequence="1" ClearingCount="1"|--|       |-|ProductDetail UnitPrice="180.00" OriginCity="YYZ" DestinationCity="YVR"/|--|     |-|PassengerDetail NameInPNR="Barkley/Gordon" FirstName="Gordon" LastName="Barkley"|--|         |-|Document DocType="TKT" DocNumber="1235678" InitialDocType="TKT" AlternateCurrency="USD" AlternateCurrencyDocAmount="123.45"/|--|     |-|/PassengerDetail|--|     |-|FlightDetail|--|         |-|AirlineCode|--|WS|-|/AirlineCode|--|         |-|OperatingAirlineCode|--|WS|-|/OperatingAirlineCode|--|           |-|FlightNumber|--|701|-|/FlightNumber|--|          |-|ClassOfService|--|M|-|/ClassOfService|--|            |-|DepartureInfo DepartureAirport="YYZ" DepartureDateTime="2015-02-13T00:00:00"/|--|        |-|/FlightDetail|--|    |-|/OrderDetail|--| |-|AccountDetail AccountType="WD" TokenizedAccountNbr="4444QZIMELQE1111" AccountCurrencyCode="WD"/|--|  |-|PaymentDetail|--|        |-|FOP Type="WD" FOP_Code="IK"/|--|     |-|AmountDetail Amount="5" CurrencyCode="CAD" ExchangeRate="1"|--|       |-|TaxBreak TaxType="AT" TaxCode="QR" TaxAmount="16.06"/|--|        |-|FeeBreak FeeCode="IVA" BaseFee="0" FeeTaxes="0"/|--|        |-|/AmountDetail|--|    |-|/PaymentDetail|--||-|/PaymentRQ|--|

In the Request

Optional

Parameter: ReturnTokenInd

Type: Boolean

Description: New optional attribute "ReturnTokenInd" indicates whether to return tokenized number or non-tokenized number in the response. eg. true or false. If true, return tokenized number in response. If false, return non-tokenized card number

Sample Value:

|-|PaymentRQ xmlns="http://www.opentravel.org/OTA/2003/05/beta" SystemDateTime="2018-11-21T02:31:31.066-06:00" Version="1.0.0"|--|    |-|Action|--|GetCard|-|/Action|--|    |-|POS PseudoCityCode="61N1" AgencyName="234-234-234" ISOCountry="US" ChannelID="AGY" LocalDateTime=""|--|        |-|BrowserDetail/|--|    |-|/POS|--|    |-|MerchantDetail MerchantID="1H"/|--|    |-|OrderDetail RecordLocator="ABCDEF"|--|        |-|ContactInfo|--|            |-|PhoneNumber Number="234-234-234" Type="F"/|--|        |-|/ContactInfo|--|        |-|Hotel CheckInDate="2019-02-21-06:00" CheckOutDate="2019-02-24-06:00"|--|            |-|ProviderInfo ProviderName="hotelName"|--|                |-|ProviderAddress/|--|                |-|Contact|--|                    |-|PhoneNumber Number=" 441614453941" Type="F"/|--|                |-|/Contact|--|            |-|/ProviderInfo|--|            |-|Room Description="roomDesc"|--|                |-|Guest FirstName="JSPVM" LastName="TDSMOCK"/|--|            |-|/Room|--|            |-|Cost TotalAmount="1000.00"/|--|        |-|/Hotel|--|    |-|/OrderDetail|--|    |-|AccountDetail AccountCode="SABREAIRDINERS" ReturnTokenInd="true"/|--|    |-|PaymentDetail|--|        |-|AmountDetail Amount="1000.00" CurrencyCode="USD"/|--|        |-|CardUsageResult/|--|    |-|/PaymentDetail|--||-|/PaymentRQ|--|

In the Response

Optional

Parameter: PaymentAccountRef

Type: String

Description: New optional attribute "PaymentAccountRef" is for Visa, MasterCard and ELO cards authorization response and the field value will be written to the offline file. The field contains the primary account information of the card.

Sample Value:

|-|PaymentRS xmlns="http://www.opentravel.org/OTA/2003/05/beta" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SystemDateTime="2001-12-17T09:30:47Z" SabreTransactionID="01711453449084466999" Version="4.16.0" xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05/beta ../PaymentRQ_v4.16.0.xsd"|--|    |-|Result ResultCode="SUCCESS" Description="Successful Transaction"/|--|    |-|AuthorizationResult ResponseCode="APPROVED" Description="Approved" ApprovalCode="316510" SupplierID="BA" SupplierTransID="100006173588441" SupplierResponseCode="00" AuthRemarks1="AUTH-BA/CA2346/13JUN/01911497413460082816" AuthRemarks2="  AUTH-APV/316510/00/EUR645.63" PaymentRef="01911497413460082816"|--|        |-|T3DS_Result ECI="02" ECI_ResultCode="Y" UCAF_ResultCode="ab34fdf4341fk3j5454h4343ffeeerer"/|--|      |-|CSC_Result CSC_ResultCode="M" RawCSC_ResultCode="M" CSC_Remarks="   AUTH-MATCHED/M"/|--|        |-|AVS_Result AVS_ResultCode="L" RawAVS_ResultCode="G" AVS_Remarks="  AUTH-AVS COULD NOT BE VERIFIED FOR AN INTERNATIONAL TRANSACTION/L"/|--|     |-|AuthResponseDetail AuthSrcCode="4" AuthValidationCode="6N8D" ProductID="A " AuthCharacteristicInd="V" POS_ConditionCode="08"         POS_AdditionalData="400000000000" MCC="3012"        POS_EntryMode="Y" TIC="U0" SpendQualifiedInd="Z" PaymentAccountRef="V0010013018037701369573085320"/|--|    |-|/AuthorizationResult|--||-|/PaymentRS|--|

In the Response

Optional

Parameter: RawCSC_ResultCode

Type: String

Description: New optional attribute "RawCSC_ResultCode" indicates actual card security verification result code sent from supplier

Sample Value:

|-|PaymentRS xmlns="http://www.opentravel.org/OTA/2003/05/beta" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SystemDateTime="2001-12-17T09:30:47Z" SabreTransactionID="01711453449084466999" Version="4.16.0" xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05/beta ../PaymentRQ_v4.16.0.xsd"|--|    |-|Result ResultCode="SUCCESS" Description="Successful Transaction"/|--|    |-|AuthorizationResult ResponseCode="APPROVED" Description="Approved" ApprovalCode="316510" SupplierID="BA" SupplierTransID="100006173588441" SupplierResponseCode="00" AuthRemarks1="AUTH-BA/CA2346/13JUN/01911497413460082816" AuthRemarks2="  AUTH-APV/316510/00/EUR645.63" PaymentRef="01911497413460082816"|--|        |-|T3DS_Result ECI="02" ECI_ResultCode="Y" UCAF_ResultCode="ab34fdf4341fk3j5454h4343ffeeerer"/|--|        |-|CSC_Result CSC_ResultCode="M" RawCSC_ResultCode="M" CSC_Remarks="   AUTH-MATCHED/M"/|--|        |-|AVS_Result AVS_ResultCode="L" RawAVS_ResultCode="G" AVS_Remarks="  AUTH-AVS COULD NOT BE VERIFIED FOR AN INTERNATIONAL TRANSACTION/L"/|--|       |-|AuthResponseDetail AuthSrcCode="4" AuthValidationCode="6N8D" ProductID="A " AuthCharacteristicInd="V" POS_ConditionCode="08"         POS_AdditionalData="400000000000" MCC="3012"        POS_EntryMode="Y" TIC="U0" SpendQualifiedInd="Z" PaymentAccountRef="V0010013018037701369573085320"/|--|    |-|/AuthorizationResult|--||-|/PaymentRS|--|

In the Response

Optional

Parameter: RawAVS_ResultCode

Type: String

Description: New optional attribute "RawAVS_ResultCode" indicates actual address verification result code sent from supplier

Sample Value:

|-|PaymentRS xmlns="http://www.opentravel.org/OTA/2003/05/beta" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SystemDateTime="2001-12-17T09:30:47Z" SabreTransactionID="01711453449084466999" Version="4.16.0" xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05/beta ../PaymentRQ_v4.16.0.xsd"|--|    |-|Result ResultCode="SUCCESS" Description="Successful Transaction"/|--|    |-|AuthorizationResult ResponseCode="APPROVED" Description="Approved" ApprovalCode="316510" SupplierID="BA" SupplierTransID="100006173588441" SupplierResponseCode="00" AuthRemarks1="AUTH-BA/CA2346/13JUN/01911497413460082816" AuthRemarks2="  AUTH-APV/316510/00/EUR645.63" PaymentRef="01911497413460082816"|--|        |-|T3DS_Result ECI="02" ECI_ResultCode="Y" UCAF_ResultCode="ab34fdf4341fk3j5454h4343ffeeerer"/|--|        |-|CSC_Result CSC_ResultCode="M" RawCSC_ResultCode="M" CSC_Remarks="   AUTH-MATCHED/M"/|--|        |-|AVS_Result AVS_ResultCode="L" RawAVS_ResultCode="G" AVS_Remarks="  AUTH-AVS COULD NOT BE VERIFIED FOR AN INTERNATIONAL TRANSACTION/L"/|--|       |-|AuthResponseDetail AuthSrcCode="4" AuthValidationCode="6N8D" ProductID="A " AuthCharacteristicInd="V" POS_ConditionCode="08"         POS_AdditionalData="400000000000" MCC="3012"        POS_EntryMode="Y" TIC="U0" SpendQualifiedInd="Z" PaymentAccountRef="V0010013018037701369573085320"/|--|    |-|/AuthorizationResult|--||-|/PaymentRS|--|

In the Response

Required

Parameter: SupplierID

Type: String

Description: New attribute "SupplierID" indicates name of the vendor which does authorization

Sample Value:

|-|PaymentRS xmlns="http://www.opentravel.org/OTA/2003/05/beta" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SystemDateTime="2001-12-17T09:30:47Z" SabreTransactionID="01711453449084466999" Version="4.16.0" xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05/beta ../PaymentRQ_v4.16.0.xsd"|--| |-|Result ResultCode="SUCCESS" Description="Successful" /|--|    |-|GetCardResult SupplierID="CONFERMA"|--|  |-|PaymentCard CardCode="DC" CardSecurityCode="" ExpireDate="052019" TokenizedCardNumber="36I201JUFG0374"|--|   |-|/GetCardResult|--||-|/PaymentRS|--|

In the Request

Optional

Parameter: ContactInfo

Type: ContactInfoType

Description: New optional element "ContactInfo" indicates the pos contact details of the passenger

Sample Value:

|-|PaymentRQ xmlns="http://www.opentravel.org/OTA/2003/05/beta" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SabreTransactionID="01911450603043204670" SystemDateTime="2015-12-20T03:21:50.364" Version="4.16.0" xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05/beta ../PaymentRQ_v4.16.0.xsd"|--|  |-|Action|--|Auth|-|/Action|--|  |-|POS PseudoCityCode="ERF" NdcInd="true" LNIATA="BC0DD9" StationNumber="95493101" ISOCountry="AT" IP_Address="10.100.100.200" ChannelID="WEB" LocalDateTime="2017-06-14T04:10:46.738Z" LanguageCode="es_ES"|--|       |-|ContactInfo  FirstName="RASHMI" LastName="KUMBUGOWDANA"|--|          |-|EmailAddress|--|RASHMI.KUMBUGOWDANA@SABRE.COM|-|/EmailAddress|--|            |-|PhoneNumber Number="6826059999" Type="M"/|--|        |-|/ContactInfo|--|  |-|/POS|--||-|/PaymentRQ|--|

In the Request

Optional

Parameter: NdcInd

Type: Boolean

Description: New optional attribute "NDC indicator" that will be passed to payment by Order Management System application when NDC transaction happens

Sample Value:

|-|PaymentRQ xmlns="http://www.opentravel.org/OTA/2003/05/beta" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SabreTransactionID="01911450603043204670" SystemDateTime="2015-12-20T03:21:50.364" Version="4.16.0" xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05/beta ../PaymentRQ_v4.16.0.xsd"|--|  |-|Action|--|Auth|-|/Action|--|  |-|POS PseudoCityCode="ERF" NdcInd="true" LNIATA="BC0DD9" StationNumber="95493101" ISOCountry="AT" IP_Address="10.100.100.200" ChannelID="WEB" LocalDateTime="2017-06-14T04:10:46.738Z" LanguageCode="es_ES"|--|       |-|ContactInfo  FirstName="RASHMI" LastName="KUMBUGOWDANA"|--|          |-|EmailAddress|--|RASHMI.KUMBUGOWDANA@SABRE.COM|-|/EmailAddress|--|            |-|PhoneNumber Number="6826059999" Type="M"/|--|        |-|/ContactInfo|--|  |-|/POS|--||-|/PaymentRQ|--|

In the Request

Optional

Parameter: Description

Type: String

Description: New optional attribute "Description" indicates description of hotel room

Sample Value:

|-|PaymentRQ xmlns="http://www.opentravel.org/OTA/2003/05/beta" SystemDateTime="2018-11-21T02:31:31.066-06:00" Version="1.0.0"|--|    |-|Action|--|GetCard|-|/Action|--|    |-|POS PseudoCityCode="61N1" AgencyName="234-234-234" ISOCountry="US" ChannelID="AGY" LocalDateTime=""|--|        |-|BrowserDetail/|--|    |-|/POS|--|    |-|MerchantDetail MerchantID="1H"/|--|    |-|OrderDetail RecordLocator="ABCDEF"|--|        |-|ContactInfo|--|            |-|PhoneNumber Number="234-234-234" Type="F"/|--|        |-|/ContactInfo|--|        |-|Hotel CheckInDate="2019-02-21-06:00" CheckOutDate="2019-02-24-06:00"|--|            |-|ProviderInfo ProviderName="hotelName"|--|                |-|ProviderAddress/|--|                |-|Contact|--|                    |-|PhoneNumber Number=" 441614453941" Type="F"/|--|                |-|/Contact|--|            |-|/ProviderInfo|--|            |-|Room Description="roomDesc"|--|                |-|Guest FirstName="JSPVM" LastName="TDSMOCK"/|--|            |-|/Room|--|            |-|Cost TotalAmount="1000.00"/|--|        |-|/Hotel|--|    |-|/OrderDetail|--|    |-|AccountDetail AccountCode="SABREAIRDINERS" ReturnTokenInd="false"/|--|    |-|PaymentDetail|--|        |-|AmountDetail Amount="1000.00" CurrencyCode="USD"/|--|        |-|CardUsageResult/|--|    |-|/PaymentDetail|--||-|/PaymentRQ|--|

  • New attribute and elements added to the schema

API Information

Format
XML
Current Version
4.13.0
Environment
Production

What's New

  • New attribute and elements added to the schema

Business Value

  • New attribute and elements added to the schema

New Features

In the Request

Optional

Parameter: ClearingSequence

Type: String

Description: New optional attribute ClearingSequence of type String added to PaymentRQ/OrderDetail/@ClearingSequence. This indicates the sequence number of the document,

Sample Value:

|-|PaymentRQ xmlns="http://www.opentravel.org/OTA/2003/05/beta" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SabreTransactionID="01221450682499283451" SystemDateTime="2015-12-21T07:21:50.364"  Version="4.13.0" xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05/beta ../../PaymentRQ_v4.13.0.xsd"|--|     |-|Action Type="Issuance"|--|ConfirmAuth|-|/Action|--|    |-|POS CityCode="0EZC" PseudoCityCode="0EZC" AgentSine="AAS" StationNumber="11617270" ISOCountry="US" SettlementPlan="ARC" ChannelID="AGY" LocalDateTime="2015-12-21T01:56:00.000-06:00"/|--|    |-|MerchantDetail MerchantID="1S"/|--|    |-|OrderDetail OrderID="GRQMMP" RecordLocator="GRQMMP" ClearingSequence="1" ClearingCount="3"|--|

In the Request

Optional

Parameter: ClearingCount

Type: String

Description: New optional attribute ClearingCount of type String added to PaymentRQ/OrderDetail/@ClearingCount. This indicates the total number of documents.

Sample Value:

|-|PaymentRQ xmlns="http://www.opentravel.org/OTA/2003/05/beta" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SabreTransactionID="01221450682499283451" SystemDateTime="2015-12-21T07:21:50.364"  Version="4.13.0" xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05/beta ../../PaymentRQ_v4.13.0.xsd"|--|     |-|Action Type="Issuance"|--|ConfirmAuth|-|/Action|--|    |-|POS CityCode="0EZC" PseudoCityCode="0EZC" AgentSine="AAS" StationNumber="11617270" ISOCountry="US" SettlementPlan="ARC" ChannelID="AGY" LocalDateTime="2015-12-21T01:56:00.000-06:00"/|--|    |-|MerchantDetail MerchantID="1S"/|--|    |-|OrderDetail OrderID="GRQMMP" RecordLocator="GRQMMP" ClearingSequence="1" ClearingCount="3"|--|

In the Request

Optional

Parameter: AdditionalDetail

Type: AdditionalDetailType

Description: New element AdditionalDetail of type AdditionalDetailType added to PaymentRQ/PaymentDetail/AuthorizationResult/. This is to send any additional data in the request.

Sample Value:

|-|ns4:AdditionalDetail|--|                                     |-|ns4:Field|--|                           |-|ns4:Name|--|SMSCODE|-|/ns4:Name|--|                                           |-|ns4:Value|--|123453|-|/ns4:Value|--|                       |-|/ns4:Field|--|                                     |-|ns4:Field|--|                                           |-|ns4:Name|--|REFERENCE|-|/ns4:Name|--|                                           |-|ns4:Value|--|9199******06|-|/ns4:Value|--|                       |-|/ns4:Field|--|                              |-|/ns4:AdditionalDetail|--|

In the Request

Optional

Parameter: InstallmentDetail

Type: InstallmentDetail

Description: New complex element InstallmentDetail added to PaymentRQ/PaymentDetail/. It has 3 attributes : Plan, NumberOfInstallments and InstallmentAmount.This is used to send installment details in the authorization requests.

Sample Value:

|-|PaymentDetail|--|    |-|FOP Type="CC"/|--|    |-|PaymentCard CardCode="CA" CardNumber="1111********2346" CardSecurityCode="***" ExpireDate="******"|--|      |-|CardHolderName Name="Harvey Specter"/|--|      |-|Address|--|        |-|AddressLine1|--|111|-|/AddressLine1|--|        |-|CityName|--|Pom|-|/CityName|--|        |-|PostalCode|--|78990|-|/PostalCode|--|        |-|StateProv/|--|        |-|Country Code="DZ"/|--|      |-|/Address|--|      |-|EmailAddress|--|test@sabre.com|-|/EmailAddress|--|      |-|Authenticated|--|false|-|/Authenticated|--|    |-|/PaymentCard|--|    |-|InstallmentDetail NumberOfInstallments="3" Plan="Nevaplan" InstallmentAmount="12.22"/|--|    |-|AmountDetail Amount="645.63" CurrencyCode="EUR"/|--|      |-|/PaymentDetail|--|

In the Request

Optional

Parameter: LanguageCode

Type: String

Description: New optional attribute LanguageCode of type String added to PaymentRQ/POS/. This indicates language used during booking.

Sample Value:

|-|POS CityCode="SAT" PseudoCityCode="RG3C" AgentSine="AH8" AgentDutyCode="*" LNIATA="3A8EB2" StationNumber="45542884" ISOCountry="US" SettlementPlan="ARC" ChannelID="AGY" LocalDateTime="2016-01-11T04:35:00.000" LanguageCode="es_ES"|--|