API Information

Response Format
XML
Service Action Code
PaymentRQ/PaymentRS
Current Version
4.3.0
Target Audience
AS
Environment
Production
Documentation
Go to the PaymentService documentation

What's New

  • New Elements and attributes added for MCP, ApplePay etc.

New Features

In the Request

Optional

Parameter: /PaymentRq/OrderDetail/MCP

Type: A new complex xml element was introduced; consisting new attributes - MCP_TrandID(String) and OptedIn(String)

Description: This element enables card holder to have a transaction converted to their local currency when making a payment with a foreign card.

Sample Value:

<MCP MCP_TransID="05711492396440341106" OptedIn="true" "> </MCP>
Parameter: /PaymentRq/PaymentDetail/PaymentCard/@ApplePayInd

Type: Boolean

Description: This attribute enables the ability to process Apple Pay transactions through Payment Web Service.

Sample Value:

<PaymentCard ApplePayInd="true"> </ PaymentCard>
Parameter: /PaymentRq/PaymentDetail/AmountDetail/@WithInterestInd, /PaymentRq/PaymentDetail/AmountDetail/@InterestAmount

Type: Boolean, Big Decimal

Description: These attributes support authorization with extended payment (with interest) through PWS

Sample Value:

<AmountDetail WithInterestInd="true" InterestAmount=""> </AmountDetail>
Parameter: /PaymentRq/POS/@AgencyName

Type: String

Description: This attribute provides additional information for office/agency/pseudo city code.

Sample Value:

<POS AgencyName="Agency"/>
Parameter: /PaymentRq/PaymentDetail/AuthorizationResult/AdditionalDetail

Type: A new complex xml element was introduced; consisting Name(String)-value(String) pair.

Description: Key-Value pair has been added to provide additional details as part of Authorization result.

Sample Value:

<AdditionalDetail> <Name>checkoutId</Name> <Value>618495244</Value> </AdditionalDetail>

In the Response

Optional

Parameter: /PaymentRs/MCP_Result

Type: A new complex xml element MCP_Result was introduced; consisting new attributes. /PaymentRs/MCP_Result/@MCP_Offered - Boolean /PaymentRs/MCP_Result/@ SupplierResponseCode - String /PaymentRs/MCP_Result/@ SupplierID - String /PaymentRs/MCP_Result/@ ReasonCode - String /PaymentRs/MCP_Result/@ Description - String /PaymentRs/MCP_Result/MCP_Offer/@ CurrencyCode - String /PaymentRs/MCP_Result/MCP_Offer/@ ExchangeRate - Double /PaymentRs/MCP_Result/MCP_Offer/@ ExchangeRateSourceName - XMLGregorianCalander /PaymentRs/MCP_Result/MCP_Offer/@ ExchangeRateSourceDateTime - XMLGregorianCalander /PaymentRs/MCP_Result/MCP_Offer/@ ExchangeRateExpireDateTime - XMLGregorianCalander /PaymentRs/MCP_Result/MCP_Offer/@ MarginPercentRate - Double /PaymentRs/MCP_Result/MCP_Offer/@ CommissionPercentRate - Double

Description: This element enables card holder to have a transaction converted to their local currency when making a payment with a foreign card.

Sample Value:

<MCP_Result MCP_Offered="true" SupplierResponseCode="0" SupplierID="FEXCO" ReasonCode="UNK" Description="UNKNOWN RESPONSE CODE" SupplierTransID=""> <MCP_Offer CurrencyCode="AUD" ExchangeRate="2.0937" ExchangeRateSourceName="REUTERS WHOLESALE INTERBANK" ExchangeRateSourceDateTime="2016-01-29T09:59:05.000-06:00" ExchangeRateExpireDateTime="2020-01-22T15:47:58.000-06:00" MarginPercentRate="3.0" CommissionPercentRate="0.0"/> </MCP_Result>
Parameter: /PaymentRs/Results/CancelRefundResult

Type: A new complex xml element CancelRefundResult was introduced,consisting new element and attributes

Description: This element has been added to support Refund reversals through PWS.

Sample Value:

<CancelRefundResult ResponseCode="APPROVED" Description="Approved" Remarks="" SupplierID="MPGS" SupplierTransID="100019290021061" SupplierResponseCode="00" ApprovalCode=""> <CancelRefundAmount Amount="100.00" CurrencyCode="USD"/> <CancelRefundRemarks></CancelRefundResult> <CancelRefundResult>
Parameter: /PaymentRs/AuthorizationResult/@SupplierRefernceID

Type: String

Description: This attribute provides additional detail for Authorization Result

Sample Value:

<AuthorizationResult SupplierReferenceID="700014503245145" />