API Information

Response Format
XML
Service Action Code
PaymentQueryRQ
Current Version
3.11
Target Audience
Both TN and AS
Environment
Production
Documentation
Go to the PaymentQueryRQ documentation

What's New

  • ValidatingCarrierCode : new attribute added to QueryRQ002
  • OrderType : new attribute added to QueryRQ002
  • QueryRQ006 : new service added
  • QueryRS006 : new service added
  • FopFeeAmount : new attribute added to QueryRS002
  • FopFeeTaxCode : new attribute added to QueryRS002
  • PromotionalInd : new attribute added to QueryRS002
  • FopFeeAmount : new attribute added to FullfilmentItemType

Business Value

  • New attribute and elements added to the schema

New Features

In the Request

Optional

Parameter: ValidatingCarrierCode

Type: string

Description: ValidatingCarrierCode is a new attribute added to QueryRQ002

Sample Value:

<QueryRQ002 FOP_Type="CC" FOP_Code="CA" CardBIN="542362" CurrencyCode="BRL" BaseAmount="150.00" TotalAmount="190.00" Taxes="40.00" Fees="0" CardIssuerCountry="BR" ProductType="1" ValidatingCarrierCode="AA" OrderType="O">
Parameter: OrderType

Type: string

Description: OrderType is a new attribute added to QueryRQ002

Sample Value:

<QueryRQ002 FOP_Type="CC" FOP_Code="CA" CardBIN="542362" CurrencyCode="BRL" BaseAmount="150.00" TotalAmount="190.00" Taxes="40.00" Fees="0" CardIssuerCountry="BR" ProductType="1" ValidatingCarrierCode="AA" OrderType="O">
Parameter: QueryRQ006

Type:

Description: New service QueryRQ006 added

Sample Value:

<QueryRQ006 ValidatingCarrierCode="AA"> <FOP_Details FOP_RPH="1" FOP_Type="CC" FOP_Code="AX" CurrencyCode="BRL" CardBIN="376446" PaymentAmount="603.83" /> <FOP_Details FOP_RPH="2" FOP_Type="CC" FOP_Code="VI" CurrencyCode="BRL" CardBIN="444433" PaymentAmount="1000.00" /> <FulfillmentDetails FulfillmentTotalAmount="1603.83" FulfillmentTaxAmount="173.93" FulfillmentFeeAmount="0.00" FulfillmentBaseAmount="1429.90"> <PsgrFulfillmentItems NameNumberInPNR="1.1" LastName="LASTNAME" FirstName="FIRSTNAME"> <FulfillmentItem Type="TKT" TotalAmount="603.83" TaxAmount="73.93" Quantity="1" ItemNbr="1" BaseAmount="529.90"> <TaxBreak> <Tax TaxCode="BR" TaxAmount="30.94" /> <Tax TaxCode="DU" TaxAmount="42.99" /> </TaxBreak> </FulfillmentItem> </PsgrFulfillmentItems> <PsgrFulfillmentItems NameNumberInPNR="1.2" LastName="LASTNAMETWO" FirstName="FIRSTNAMETWO"> <FulfillmentItem Type="AE" TotalAmount="1000.00" TaxAmount="100.00" Quantity="1" ItemNbr="1" BaseAmount="900.00"> <TaxBreak> <Tax TaxCode="BR" TaxAmount="50.00" /> <Tax TaxCode="DU" TaxAmount="50.00" /> </TaxBreak> </FulfillmentItem> </PsgrFulfillmentItems> </FulfillmentDetails> </QueryRQ006>

In the Response

Optional

Parameter: FopFeeAmount

Type: string

Description: FopFeeAmount is a new attribute added to QueryRS002

Sample Value:

<InstallmentOption NbrOfInstallments="12" TotalPaymentAmount="200.00" InstallmentAmount="16.67" InterestAmount="0.00" InterestRate="0.0" CardIssuerName="AMEX" Plan="PlanZ" FopFeeAmount="1603.83" FopFeeTaxCode="OB" PromotionalInd="false">
Parameter: FopFeeTaxCode

Type: string

Description: FopFeeTaxCode is a new attribute added to QueryRS002

Sample Value:

<InstallmentOption NbrOfInstallments="12" TotalPaymentAmount="200.00" InstallmentAmount="16.67" InterestAmount="0.00" InterestRate="0.0" CardIssuerName="AMEX" Plan="PlanZ" FopFeeAmount="1603.83" FopFeeTaxCode="OB" PromotionalInd="false">
Parameter: PromotionalInd

Type: boolean

Description: new attribute PromotionalInd added to QueryRS002/InstallmentOptions/InstallmentOption

Sample Value:

<InstallmentOption NbrOfInstallments="12" TotalPaymentAmount="200.00" InstallmentAmount="16.67" InterestAmount="0.00" InterestRate="0.0" CardIssuerName="AMEX" Plan="PlanZ" FopFeeAmount="1603.83" FopFeeTaxCode="OB" PromotionalInd="false">
Parameter: QueryRS006

Type:

Description: new service QueryRS006 added.

Sample Value:

<QueryRS006> <FOP_Details FOP_RPH="1" FOP_Type="CC" FOP_Code="AX" CardBIN="376446" CurrencyCode="BRL" PaymentAmount="603.83" FopFeeAmount="3.41" FopFeeTaxCode="OB" /> <FOP_Details FOP_RPH="2" FOP_Type="CC" FOP_Code="VI" CardBIN="444433" CurrencyCode="BRL" PaymentAmount="1000.00" FopFeeAmount="5.65" FopFeeTaxCode="OB" /> <FulfillmentDetails FulfillmentTotalAmount="1603.83" FulfillmentBaseAmount="1429.90" FulfillmentTaxAmount="173.93" FulfillmentFeeAmount="0.00"> <PsgrFulfillmentItems NameNumberInPNR="1.1" FirstName="FIRSTNAME1" LastName="LASTNAME1"> <FulfillmentItem ItemNbr="1" Type="TKT" Quantity="1" TotalAmount="603.83" BaseAmount="529.90" FeeAmount="22.24" TaxAmount="73.93" InterestAmount="2.21" FopFeeAmount="9.06"> <TaxBreak> <Tax TaxCode="BR" TaxAmount="30.94" /> <Tax TaxCode="DU" TaxAmount="42.99" /> </TaxBreak> </FulfillmentItem> </PsgrFulfillmentItems> <PsgrFulfillmentItems NameNumberInPNR="1.2" FirstName="FIRSTNAME2" LastName="LASTNAME2"> <FulfillmentItem ItemNbr="1" Type="AE" Quantity="1" TotalAmount="1000.00" BaseAmount="900.00" FeeAmount="12.54" TaxAmount="100.00" InterestAmount="7.32" > <TaxBreak> <Tax TaxCode="BR" TaxAmount="50.00" /> <Tax TaxCode="DU" TaxAmount="50.00" /> </TaxBreak> </FulfillmentItem> </PsgrFulfillmentItems> </FulfillmentDetails> </QueryRS006>

In the Request/Response

Optional

Parameter: FopFeeAmount

Type: string

Description: New attribute FopFeeAmount added to FulfillmentItemType

Sample Value:

<FulfillmentItem ItemNbr="1" Type="TKT" Quantity="1" TotalAmount="990.02" BaseAmount="850.00" TaxAmount="0.00" FeeAmount="0.00" FopFeeAmount="950.00"/>