org.wisepersist.pinpayments.api

Interface WebhookEndpointsApi

All Known Implementing Classes:

WebhookEndpointsApiImpl

public interface WebhookEndpointsApi

The Webhook Endpoints API allows you to create and view your webhook endpoints to enable your website to receive push notifications of events that occur on your Pin Payments account.

See Also:

Webhook Endpoints API Beta

Method Summary

Modifier and Type	Method and Description
WebhookEndpointResponse	create(WebhookEndpoint endpoint) Creates a new webhook endpoint and returns its details.
DeletionResult	delete(java.lang.String endpointToken) Deletes a webhook endpoint and all of its webhook requests.
WebhookEndpointResponse	fetch(java.lang.String endpointToken) Returns the details of a webhook endpoint.
WebhookEndpointListResponse	list(int page) Returns a paginated list of all webhook endpoints.

Method Detail

create

WebhookEndpointResponse create(WebhookEndpoint endpoint)
                        throws java.io.IOException

Creates a new webhook endpoint and returns its details.

Parameters:

endpoint - The endpoint specified.

Returns:

The details of the endpoint created.

Throws:

java.io.IOException - If IO errors occur while calling PinPayments REST API.

list

WebhookEndpointListResponse list(int page)
                          throws java.io.IOException

Returns a paginated list of all webhook endpoints.

Parameters:

page - The page number specified.

Returns:

A paginated list of all webhook endpoints.

Throws:

java.io.IOException - If IO errors occur while calling PinPayments REST API.

fetch

WebhookEndpointResponse fetch(java.lang.String endpointToken)
                       throws java.io.IOException

Returns the details of a webhook endpoint.

Parameters:

endpointToken - The endpoint token specified.

Returns:

The details of the webhook endpoint fetched.

Throws:

java.io.IOException - If IO errors occur while calling PinPayments REST API.

delete

DeletionResult delete(java.lang.String endpointToken)
               throws java.io.IOException

Deletes a webhook endpoint and all of its webhook requests. You will not be able to recover them.

Parameters:

endpointToken - The endpoint token specified.

Returns:

The deletion result.

Throws:

java.io.IOException - If IO errors occur while calling PinPayments REST API.