RAratepay
Endpoints

Endpoint to update the properties of the subscription.

Update Subscription

The request body must contain the complete information about the subscription.

The following values can be updated: The URL used for the webhook, the event type applied to this URL and the secret, which is used to sign the payload. It is not possible to change the identification of the subscription.

Omitting properties from the request body (e.g. secret) will result in a validation error and return the status code 400.

put/webhook/management/v1/{id}

Request

  • Base URL
    https://api-integration.ratepay.com
  • URL
    https://api-integration.ratepay.com/webhook/management/v1/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

ID of the subscription.

Example:d8znR1k1_0Kw305BsoPT

Subscription ID received when creating a subscription.

Headers

Authorizationstring required

For each request, a valid access token must be provided in the Authorization header. See Authentication API for obtaining a valid token.

Request body

urlUrl required(unresolved $ref)
event_typeEventType required(unresolved $ref)
secretSecret required(unresolved $ref)

Response

OK. The subscription was updated.

idstring

ID of the subscription.

urlstring url

HTTP URL to execute the webhook call with the POST method.

event_typestring

Type of the event to process by calling the API endpoint.

secretstring

Parameter given by the client to sign their payloads. Recommended to be unique for each URL.

Example response

{
  "id": "d8znR1k1_0Kw305BsoPT",
  "url": "https://api.merchant.com/event",
  "event_type": "INVOICE_INVOICE",
  "secret": "6GHbLH4d1Nx3eIs5CyLHCW4HuFi1qttpNSDawHKHlW7kurTpaddarwEKDWUI59IU"
}

Changes

No recorded changes to this operation across all 1 revision of this API.