Return Response: Acquirer Message (acquirerMessage)
Warning
This parameter ONLY working with those integration types (Hosted Payment Page, Managed Form, Own Form, Invoices (Payment Endpoint), and PayLinks (Payment Endpoint).
The Acquirer Message parameter acquirerMessage will be provided within the return POST return request and indicates the response message as received from the acquirer bank.
It is worth mentioning that
That this message can be used only internally for security reasons don't share the message with the customer.
Next, we can delve into the specifics of how to fetch the
acquirerMessage parameter in your requests.How this parameter could benefit you?
Here are some scenarios to help you understand when to use the Acquirer Message parameter:
- Semantic Meaning: Gives you a semantic meaning of the transaction status reason. However we advise you to relay on the return respStatus parameter to get the status.
Limitations
- HTTPS return URL: The return path MUST be a HTTPS URL to get the return transaction payload.
- Acquirer response: This message comes from the Acquirer and PayTabs has no upper hand on it.
- Test Profile: You may find the parameter empty through the Test profile integration.
How to Use?
In order to get this parameter within the return request payload you need to set the return URL parameter while initiating the payment.
Parameter Specifications
-
acquirerMessageParameter acquirerMessageDescription acquirerMessageis one of the parameters that received from the acquirer bank and provided within the return URL request payload.Data Type STRING Required ✘ Sample //For example:
acquirerMessage=00:Approved
acquirerMessage=204:REJECT
acquirerMessage=BLOCKED