Method Detail

• parse

  public static java.util.List<Event> parse(java.lang.String requestBody,
                            java.lang.String signatureHeader,
                            java.lang.String webhookEndpointSecret)

  Validates that a webhook was genuinely sent by GoCardless using isValidSignature, and then parses it into an array of com.gocardless.resources.Event objects representing each event included in the webhook.

  Parameters:

  requestBody - the request body

  signatureHeader - the signature included in the request, found in the Webhook-Signature header

  webhookEndpointSecret - the webhook endpoint secret for your webhook endpoint, as configured in your GoCardless Dashboard

  Returns:

  the events included in the webhook

  Throws:

  InvalidSignatureException - if the signature header specified does not match the signature computed using the request body and webhook endpoint secret

• isValidSignature

  public static boolean isValidSignature(java.lang.String requestBody,
                         java.lang.String signatureHeader,
                         java.lang.String webhookEndpointSecret)

  Validates that a webhook was genuinely sent by GoCardless by computing its signature using the body and your webhook endpoint secret, and comparing that with the signature included in the Webhook-Signature header.

  Parameters:

  requestBody - the request body

  signatureHeader - the signature included in the request, found in the Webhook-Signature header

  webhookEndpointSecret - the webhook endpoint secret for your webhook endpoint, as configured in your GoCardless Dashboard

  Returns:

  whether the webhook’s signature is valid