Inquire Interfaces
Last updated
Was this helpful?
Last updated
Was this helpful?
The inquire interfaces are used in cases, where the merchant wishes to inquire information about certain datasets within Saferpay, like transactions, or an alias. This can be useful in cases, where data has been lost, or was otherwise unavailable to certain systems, that need it.
This chapter will cover their implementation and more.
However, the inquiry interfaces have some restrictions, that have to be considered when using them:
Use the standard means first: The inquire interfaces are not meant to replace other API functions, like for example , , or . When implementing the , , or flows, you should always use the standard means first, and the inquire interfaces only if those cannot be executed anymore, e.g. due to the token being expired.
No polling: In general, but in this case specifically, do not use polling to continuously ask for data.
Only successful datasets: As of now, the inquire interfaces only work with successful datasets. Things like failed transactions or alias registrations are not returned.
Possible Update delay: The result of a Transaction/Inquire request does not display the current status in real time because the requested data may be updated with a few minutes delay.
Saferpay reserves the right to restrict or deny access to the inquire interface, due to excessive use of the interface, or violation of these rules.
is used to gather information about successful transactions. It basically returns the same information you would get via , or .
As mentioned before, the only works with successful transactions. Therefore you'll get the following response, if a transaction was either not completed by the payer, or was not successful.
As of now, the Inquire Interface does not return information on individual Captures, like . However, it will report the currently captured amount of the main transaction.
is used to gather Information about a previously created Alias, using Secure Card Data, like the brand, card number, expiration etc.