Skip to content

IPN Webhook Safelisting API

Method: POST

Path: https://amazonpay.amazon.in/v1/ipn

Description: This API is used to safelist the webhook URL for receiving the IPN (Instant Payment Notification). In return, merchant will get “200 OK” if the IPN is successfully safe listed for the given webhook URL.

Request Parameters

Parameter Type Description Values allowed/Constraints Nullable
merchantId String Merchant ID provided by Amazon - No
recipientIdentifier String Merchant ID provided by Amazon - No
recipientType String Recipient Type "MERCHANT" No
recipientEndpoint String Webhook URL for receiving the IPN from Amazon Pay (Max length of 2048 characters) - No
recipientEndpointType String Recipient endpoint type "HTTPS" No

Request Samples

{
    "recipientEndpoint": "https://www.merchantwebhook.in",
    "recipientEndpointType": "HTTPS",
    "recipientType": "MERCHANT",
    "merchantId": "AMAZONMID12",
    "recipientIdentifier": "AMAZONMID12"
}

Response Parameters

Note

For successful invocation, no response body is returned

Sample Response

  • Success response
    HTTP 200 OK Empty response body

  • Error
    HTTP 400 InvalidArguments 

    {
"code": "InvalidArguments",
"message": "merchantId field is mandatory, cannot be null or blank"
}

Common Errors

Status Code Code Type Message
400 InvalidArguments recipientEndpointType must be one of following: [HTTPS]
400 InvalidArguments recipientType must be one of following: [MERCHANT]
400 InvalidArguments recipientIdentifier field is mandatory, cannot be null or blank
400 InvalidArguments The recipient endpoint provided is incorrect
400 InvalidArguments The recipient Identifier provided is not supported. Please try again.
400 MerchantIdMismatch Specified merchant id does not match with x-amz-client-id header value.
401 AuthorizationExpired Specified Signature has expired
401 AuthorizationFailed Specified Signature is invalid
403 LimitExceeded Maximum limit of subscriptions reached.
404 IdentifierNotFound The recipient Identifier provided does not exist. Please try again.
500 InternalServerError An internal server error has occurred. Try your request again later.