Customized Deeplink API
Request Headers
| Header Name | Header Value |
Content-Type | application/json |
X-VERIFY | SHA256(base64 encoded payload + “/v3/deeplink” + salt key) + ‘###’ + salt index |
X-CLIENT-ID | The default value will be merchant ID which will be unique for each merchant. |
Sample Request
{ "request": "ewoJInR5cGUiOiAiV0VCIiwKCSJ1dG1QYXJhbXMiOiB7CgkJInNvdXJjZSI6ICJzb3VyY2UiLAoJCSJtZWRpdW0iOiAibWVkaXVtIiwKCQkiY2FtcGFpZ24iOiAiY2FtcGFpZ24iCgl9LAoJImFwcFVuaXF1ZUlkIjogIk1FUkNIQU5UXzEyMzQzX1RSIiwKCSJhcHBFbnRyeUluZm8iOiB7CgkJInR5cGUiOiAiSFRUUCIsCgkJInVybCI6ICJodHRwOi8vd3d3Lm1lcmNoYW50cGF5bWVudHBhZ2UuY29tIgoJfQp9" }
Request Parameters
| Parameter Name | Type | Description | Mandatory |
type | STRING | The default value will be WEB | Yes |
source | STRING | Source name, in case merchants wants to know the source of the deeplink. | Optional |
medium | STRING | Medium name. If a merchants wants to know what is the medium – website etc. | Optional |
campaign | STRING | Name of the campaign | Yes |
appUniqueId | STRING | A unique ID which will be shared by the Phonepe team | Yes |
type | STRING | The default value will be HTTPS | Yes |
url | STRING | The dynamic URL on which a user will be redirected to after clicking on the deeplink. | Yes |
Response Parameters
| Parameter Name | Type | Description |
success | BOOLEAN | Success status of the request |
code | ENUM | See list of response codes below |
data | Object | The URL received in the response is needed to be send on the message so the user. |
Response Codes
| Code | Description |
AUTHORIZATION_FAILED | Incorrect X-VERIFY header |
INTERNAL_SERVER_ERROR | Something went wrong |
