LogoLogo
BlogLogin
English
English
  • An Introduction to Saferpay
    • Licensing
      • Legacy licensing
    • Reconciliation
    • Acquirers & Payment Methods
    • Web Shop Plugins and certified partners
      • ePages Beyond
      • ePages NOW
      • Magento 2
      • Odoo
      • PrestaShop
        • PrestaShop User Guide
      • Salesforce Commerce Cloud
      • SAP Commerce Cloud
      • Shopware 6
        • Shopware 6 User Guide - German
        • Shopware 6 User Guide - English
      • WordPress WooCommerce
      • Shopify
    • Supported Languages
    • Common Saferpay terms - Glossary
  • News
    • Changes for transactions without customer presence
    • Changes for the Saferpay Hosted Forms, Fields and Payment Page
  • Quick Links
    • Web Shop Plugins and certified partners
    • Secure PayGate
    • User Administration
    • Payment Page Configuration
    • Risk Management
    • API Authentication
  • Interfaces
    • Payment API (aka JSON API)
    • Management API
    • Backoffice
      • The Home screen
      • Batch Processing
      • Transactions
        • Transaction Details
        • Batch Close
        • Declined transactions
        • Pending authorizations
        • Analytics
        • SEPA Refunds Export
        • Authorization & Payment
        • Credit
      • Risk Management
      • Secure PayGate / Payment Links
      • Secure Card Data
        • Secure Card Data Details
      • Settings
        • JSON API basic/Client Certificate authentication
        • User Administration
        • Payment Page Configuration
      • Online Support
      • User Profile
    • Saferpay OnSite
    • Feedback
  • Integration Guide
    • Integrating Saferpay
    • Ways of integration
      • General Information
        • Data Security and PCI DSS
        • Versioning
        • 3-D Secure
        • PSD2
        • Dynamic Currency Conversion
        • Iframe Integration and CSS
        • Fraud Intelligence
          • Silver
          • Fraud Intelligence Integration
      • Payment Page
        • Payment Page checklist
      • Transaction Interface
        • Recurring Payments
        • Refunds
          • SEPA Refunds
      • Capture and Daily Closing
        • Partial Captures
          • Marketplace
      • Secure Card Data - Tokenization
      • Saferpay Fields
      • Inquire Interfaces
      • Mobile Integration
      • Omni-Channel
      • Mail Phone Order
      • Error Handling
      • API Health Check
      • Saferpay API Specification
    • Payment Methods & Wallets
      • General and special cases
      • Account-to-Account Payments
      • Alipay+
      • Apple Pay
      • American Express
      • Bancontact
      • Billie
      • blik
      • Click to Pay
      • Diners Club International & Discover Card
      • eps
      • giropay
      • Google Pay
      • iDEAL 2.0
      • JCB
      • Klarna Payments
      • Maestro International
      • Mastercard
      • paydirekt
      • PayPal
      • PostFinance Pay
      • Przelewy24
      • Reka
      • SEPA Direct Debit
      • Sofort by Klarna
      • TWINT
      • UnionPay
      • Visa & V PAY
      • WeChat Pay
      • WL Crypto Payments
    • Testing
    • Go-Live
    • Frequently Asked Questions
    • Saferpay Demo
      • Saferpay Demo Environment
      • Saferpay Demo Shop
    • Support
    • Changelog
Powered by GitBook
On this page
  • Rules, limitations and requirements
  • Transaction Inquire
  • Examples
  • Inquire and Multipart Captures
  • Alias Inquire

Was this helpful?

  1. Integration Guide
  2. Ways of integration

Inquire Interfaces

PreviousSaferpay FieldsNextMobile Integration

Last updated 22 days ago

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:

Rules, limitations and requirements

  1. 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.

  2. No polling: In general, but in this case specifically, do not use polling to continuously ask for data.

  3. Only successful datasets: As of now, the inquire interfaces only work with successful datasets. Things like failed transactions or alias registrations are not returned.

  4. 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.

Transaction Inquire

is used to gather information about successful transactions. It basically returns the same information you would get via , or .

Examples

{
 "RequestHeader": {
   "SpecVersion": "[CURRENT SPEC_VERSION]",
   "CustomerId": "[YOUR CUSTOMERID]",
   "RequestId": "f7ca9af6c203c055ec50b6dcc2a40831",
   "RetryIndicator": 0,
   "ClientInfo": {
     "ShopInfo": "My Shop",
     "OsInfo": "Windows Server 2016"
   }
 },
 "TransactionReference": {
   "TransactionId": "fn7O7nAIQWKMSAbIdnC3A26SMUpA"
 }
}
{
 "ResponseHeader": {
   "SpecVersion": "[CURRENT SPEC_VERSION]",
   "RequestId": "f7ca9af6c203c055ec50b6dcc2a40831"
 },
 "Transaction": {
   "Type": "PAYMENT",
   "Status": "CAPTURED",
   "Id": "fn7O7nAIQWKMSAbIdnC3A26SMUpA",
   "CaptureId": "fn7O7nAIQWKMSAbIdnC3A26SMUpA",
   "Date": "2019-05-17T12:44:14.097+02:00",
   "Amount": {
     "Value": "245",
     "CurrencyCode": "EUR"
   },
   "OrderId": "0",
   "AcquirerName": "VISA Saferpay Test",
   "AcquirerReference": "84050331349",
   "SixTransactionReference": "0:0:3:fn7O7nAIQWKMSAbIdnC3A26SMUpA",
   "ApprovalCode": "586216"
 },
 "PaymentMeans": {
   "Brand": {
     "PaymentMethod": "VISA",
     "Name": "VISA"
   },
   "DisplayText": "xxxx xxxx xxxx 0004",
   "Card": {
     "MaskedNumber": "xxxxxxxxxxxx0004",
     "ExpYear": 2019,
     "ExpMonth": 5,
     "HolderName": "Yamada Taro",
     "CountryCode": "JP"
   }
 },
 "Payer": {
   "IpAddress": "178.15.222.100",
   "IpLocation": "DE"
 },
 "Liability": {
   "LiabilityShift": true,
   "LiableEntity": "ThreeDs",
   "ThreeDs": {
     "Authenticated": true,
     "LiabilityShift": true,
     "Xid": "HVQOUwEUJnYaBAM7BCQDNAofGgg="
   }
 },
 "Dcc": {
   "PayerAmount": {
     "Value": "352",
     "CurrencyCode": "JPY"
   }
 }
}
{
 "ResponseHeader": {
   "SpecVersion": "[CURRENT SPEC_VERSION]",
   "RequestId": "fbe3bb5ba9984ce74dcd54089b0cc95a"
 },
 "Behavior": "ABORT",
 "ErrorName": "TRANSACTION_NOT_FOUND",
 "ErrorMessage": "Transaction not found"
}

Inquire and Multipart Captures

Alias Inquire

{
  "RequestHeader": {
    "SpecVersion": "[current Spec-Version]",
    "CustomerId": "[your customer id]",
    "RequestId": "[unique request identifier]",
    "RetryIndicator": 0
  },
  "AliasId": "alias35nfd9mkzfw0x57iwx"
}
{
  "ResponseHeader": {
    "SpecVersion": "[current Spec-Version]",
    "RequestId": "[your request id]"
  },
  "Alias": {
    "Id": "alias35nfd9mkzfw0x57iwx",
    "Lifetime": 1000
  },
  "PaymentMeans": {
    "Brand": {
      "PaymentMethod": "VISA",
      "Name": "VISA Saferpay Test"
    },
    "DisplayText": "9123 45xx xxxx 1234",
    "Card": {
      "MaskedNumber": "912345xxxxxx1234",
      "ExpYear": 2098,
      "ExpMonth": 7,
      "HolderName": "Max Mustermann",
      "CountryCode": "CH",
      "TokenPan":{
        "MaskedNumber": "900234xxxxxx0987",
        "ExpYear": 2099,
        "ExpMonth": 9,
      }
    }
  }
}

Example of a response for a failed transaction:

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.

Payment Page Assert
Transaction Authorize
Alias AssertInsert
Payment Page
Transaction Interface
Secure Card Data
Transaction Inquire
Transaction Authorize
Payment Page Assert
Transaction Inquire
Transaction Inquire Interface
Multipart Captures
Alias Inquire