No results

Inquiry, query by transaction

Inquiry synchronous message allows you to obtain information on the outcome of a payment at a later stage.

It is recommended to perform the operation of inquiry at the end of the maximum duration of a session of payment, or better after 20 minutes from the generation of the paymentid.

Transmission of inquiry message

Example of HTTP inquiry message
id=99999999&password=99999999&tenantId=10&operationType=inquiry&paymentId=123456789012345

Call parameters of HTTP inquiry message

NAME DESCRIPTION FORMAT
id Id associated with terminal N
Max. length: 8
password Terminal id password AN
Max. length: 50
tenantId Identification code of the acquiring service to which the merchant belongs. In the case of a merchant having an agreement with Intesa enter "10", otherwise enter "20". N
operationType
  • 'Inquiry', for Credit Cards payments
  • 'Inquirymybank', for MyBank payments
 AN
Max. length: 50
paymentid Unique identifier of the Gateway authorization request AN
Max. length: 18
Example of XML message with inquiry outcome
Example of XML message with inquirymybank outcome

Parameters of response to inquiry message

NAME DESCRIPTION FORMAT
result Transaction outcome:
  • APPROVED = transaction authorised
  • NOT APPROVED = transaction rejected
  • AUTH VOIDED = transaction cancelled
  • CAPTURED = transaction confirmed
  • VOIDED = transaction voided
  • NOT AUTHENTICATED = 3D authentication failed
  • PARES ERROR = error during 3D authentication
  • CANCELED = payment cancelled by the holder/payer
  • AUTHORISED = credit transfer authorised by the payer's Bank [only for MyBank payment]
  • ERROR = credit transfer not completed because it was denied by the payer's Bank [only for MyBank payment ]
  • AUTHORISINGPARTYABORTED = credit transfers aborted by the payer (after acces to the portal of the Bank [only for MyBank payment]
  • TIMEOUT = uncompleted credit transfer caused for exceeding the timeout period available [only for MyBank payment]
  • PENDING = payment pending outcome [only for MyBank payment]
 AN
Max. length: 32
paymentid Unique identifier of the Gateway authorization request AN
Max. length: 18
transactiontime Authorization request time (yyyy-MM-dd'T'HH:mm:ss.SSS±HHmm) [ ISO 8601 format ] AN
amount Transaction amount using the point as decimal separator (e.g. 1428,76€ = "1428.76"). The decimal portion may vary depending on the currency N Int. 18 - Dec. 4
currencyCode Currency numeric code (optional – default '978' [euro]) N
Max. length: 3
merchantorderid Transaction Reference sent to the merchant in Initialisation phase (can contain only letters and numbers and must be absolutely unique) AN
Max. length: 18
authorizationcode Authorisation code, which is entered only if the transaction has been authorised AN
Max. length: 6
threedsecure Transaction security level:
  • S = Full Secure transaction
  • H = Half Secure transaction
  • N = Not Secure transaction
 AN
Max. length: 1
responsecode Response code (e.g. '000' if the transaction is authorised, in all other cases the transaction is rejected) N
Max. length: 3
customfield Custom field sent to the merchant in Initialisation phase AN
Max. length: 255
description Payment description AN
Max. length: 255
rrn Unique transaction reference generated by the Authorisation System (to be used in case of explicit posting via file) AN
Max. length: 12
cardcountry Nationality of the used credit card AN
Max. length: 255
cardbrand Circuit and type of credit card used (upon request) ['Amex', 'Diners', 'Maestro', 'Mastercard', 'Visa', 'JCB'] AN
Max. length: 10
cardtype Circuit and type of credit card used (upon request)
  • Amex
  • Diners
  • Maestro
  • Mastercard
  • Moneta
  • Visa
  • BAPAYPAL
  • PAYPAL
 AN
Max. length: 10
maskedpan Used credit card's masked PAN (in the format 123456******7890) AN
Max. length: 19

Parameters of response to inquiry message: optional fields (for 3DSecure transactions only)

NAME DESCRIPTION FORMAT
securitytoken Security token AN
Max. length: 32
cardholderip Cardholder's IP AN
Max. length: 15

Parameters of response to inquiry message: optional fields (for MyBank only)

NAME DESCRIPTION FORMAT
mybankid EBA transaction id AN
Max. length: 35
selectedbank Cardholder's bank selected for the payment AN
Max. length: 511

Behaviour of the system in case of error in inquiry phase

When incorrect parameters are sent (e.g. unknown terminal, incorrect password, invalid amount, …) the Gateway responds with an error message in XML format.

This message includes:

  • an error code
  • a mnemonic description of the error

Example of error message in inquiry phase