Third Party App Return Signature
Description¶
The thirdPartyAppReturnSignature
endpoint generates a SHA-256 signature based on the provided parameters along with the merchant’s secret key.
Request¶
Endpoint
/v1/thirdPartyAppReturnSignature
Method
GET
Attributes
ELEMENT | DESCRIPTION | FORMAT |
---|---|---|
invoiceNumber | Required Invoice number associated to the transaction. |
e.g., 123456789 |
subscriptionId | Required Subscription ID of the token |
e.g., ivasfdasdf23ds |
status | Required | Status of the Transaction. The value of status is 'OK' for approved transactions and 'KO' for declined/failed transactions. |
errorCode | Conditional | Error code in case of failure |
Given all the details as above, the request Endpoint would appear as follows:
<BASE_URL>/ui/v1/thirdpartyapp/resources/thirdPartyAppReturnSignature?invoiceNumber=123456&subscriptionId=ABC123&status=OK&errorCode=
Note
BASE_URL is derived from the merchant code.
For Test Environment, to obtain the BASE_URL, please contact vela@datumtg.com.
For Production Environment, to obtain the BASE_URL, please contact vela@datumtg.com.
Response¶
The Response would appear as follows:
<BASE_URL>/thirdpartyapp/resources/xyzspacesConfirmation?subscriptionId=1iawx7xnq8ugg&invoiceNumber=123456789
&cardNetworkName=VISA&cardExpiry=0631&status=OK&signature=3de62767b83cd27e4c722fd8d01cb5c9523bcf6fe771c21958a8e1df07ba1234
ELEMENT | DESCRIPTION | FORMAT |
---|---|---|
subscriptionId | Unique identifier for the subscription related to the transaction. | 1iawx7xnq8ugg |
invoiceNumber | Invoice number associated with the Payment | 1234567 |
cardNetworkName | Name of the card network used for payment | VISA, MasterCard etc. |
cardExpiry | Card Expiry date MMYY Format. |
0631 |
status | Status of the transaction | OK for success. KO for Failure. |
signature | The Signature will include the Merchant Secret Key + Invoice Number + Subscription Id + Card Network Name + Card Expiry + Response Status + Error Code with a semicolon(;) as a delimiter. |
Updated As Of Version 6.7.1.0