DefaultApi

All URIs are relative to https://business.apis.kesk.app/v1

Method	HTTP request	Description
deleteVendorDocument	DELETE /vendors/`{vendor_id}`/document-requests/documents/`{document_id}`	Delete a vendor document
getVendorDocumentDownloadUrl	GET /vendors/`{vendor_id}`/document-requests/documents/`{document_id}`/download	Get document download URL
getVendorDocumentRequestWithFiles	GET /vendors/`{vendor_id}`/document-requests/`{request_id}`	Get vendor document request with files
getVendorPendingDocumentRequest	GET /vendors/`{vendor_id}`/document-requests/pending	Get pending vendor document request
listVendorDocumentRequests	GET /vendors/`{vendor_id}`/document-requests	List vendor document requests
terminalWebhookAdyen	POST /webhooks/terminals/adyen	Receive Adyen Terminal webhook events (notifications)
terminalWebhookGeneric	POST /webhooks/terminals/`{provider}`	Generic webhook endpoint - returns 200 OK to stop provider retries
terminalWebhookRevolut	POST /webhooks/terminals/revolut	Receive Revolut Terminal webhook events
terminalWebhookStripe	POST /webhooks/terminals/stripe	Receive Stripe Terminal webhook events
terminalWebhookSumup	POST /webhooks/terminals/sumup	Receive SumUp Terminal webhook events
terminalWebhookWorldline	POST /webhooks/terminals/worldline	Receive Worldline Terminal webhook events
terminalWebhookZettle	POST /webhooks/terminals/zettle	Receive Zettle Terminal webhook events
uploadDriverDocument	POST /vendors/`{vendor_id}`/drivers/`{driver_id}`/document-requests	Upload driver documents
uploadVendorDocument	POST /vendors/`{vendor_id}`/document-requests/`{request_id}`/upload	Upload vendor documents

deleteVendorDocument

MessageResponse deleteVendorDocument(vendor_id, document_id)

Delete a vendor document

Deletes a specific document from a document request.

Parameters

Name	Type	Description	Notes
vendor_id	Long	The ID of the vendor	[default to null]
document_id	Long	The ID of the document to delete	[default to null]

Return type

MessageResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getVendorDocumentDownloadUrl

DocumentDownloadUrlResponse getVendorDocumentDownloadUrl(vendor_id, document_id)

Get document download URL

Generates a download URL for a specific document file.

Parameters

Name	Type	Description	Notes
vendor_id	Long	The ID of the vendor	[default to null]
document_id	Long	The ID of the document to download	[default to null]

Return type

DocumentDownloadUrlResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getVendorDocumentRequestWithFiles

DocumentRequestWithFiles getVendorDocumentRequestWithFiles(vendor_id, request_id)

Get vendor document request with files

Retrieves a specific document request with all associated uploaded files.

Parameters

Name	Type	Description	Notes
vendor_id	Long	The ID of the vendor	[default to null]
request_id	Long	The ID of the document request	[default to null]

Return type

DocumentRequestWithFiles

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getVendorPendingDocumentRequest

DocumentRequestData getVendorPendingDocumentRequest(vendor_id)

Get pending vendor document request

Retrieves the current pending document request for the specified vendor. Returns the document request details if one exists.

Parameters

Name	Type	Description	Notes
vendor_id	Long	The ID of the vendor	[default to null]

Return type

DocumentRequestData

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

listVendorDocumentRequests

PaginatedResponse_DocumentRequestWithFiles listVendorDocumentRequests(vendor_id, status, page, per_page)

List vendor document requests

Retrieves all document requests for the specified vendor with optional status filtering. Supports pagination.

Parameters

Name	Type	Description	Notes
vendor_id	Long	The ID of the vendor	[default to null]
status	Status	Filter by status (pending, review, successful, failed)	[optional] [default to null] [enum: Active, Pending, Failed, Successful, Review]
page	Integer	Page number (1-indexed)	[optional] [default to null]
per_page	Integer	Items per page	[optional] [default to null]

Return type

PaginatedResponse_DocumentRequestWithFiles

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

terminalWebhookAdyen

TerminalWebhookAck terminalWebhookAdyen(AdyenTerminalWebhookPayload)

Receive Adyen Terminal webhook events (notifications)

Handles AUTHORISATION, CAPTURE, REFUND, and other notification types.

Parameters

Name	Type	Description	Notes
AdyenTerminalWebhookPayload	AdyenTerminalWebhookPayload

Return type

TerminalWebhookAck

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

terminalWebhookGeneric

TerminalWebhookAck terminalWebhookGeneric(provider, body)

Generic webhook endpoint - returns 200 OK to stop provider retries

This endpoint catches webhooks for unknown providers and returns success to prevent infinite retry loops.

Parameters

Name	Type	Description	Notes
provider	String		[default to null]
body	oas_any_type_not_mapped

Return type

TerminalWebhookAck

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

terminalWebhookRevolut

TerminalWebhookAck terminalWebhookRevolut(RevolutWebhookPayload)

Receive Revolut Terminal webhook events

Parameters

Name	Type	Description	Notes
RevolutWebhookPayload	RevolutWebhookPayload

Return type

TerminalWebhookAck

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

terminalWebhookStripe

TerminalWebhookAck terminalWebhookStripe(StripeTerminalWebhookPayload)

Receive Stripe Terminal webhook events

Handles payment_intent.succeeded, payment_intent.payment_failed, charge.refunded, and other terminal-related events. Requires valid Stripe-Signature header for verification.

Parameters

Name	Type	Description	Notes
StripeTerminalWebhookPayload	StripeTerminalWebhookPayload

Return type

TerminalWebhookAck

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

terminalWebhookSumup

TerminalWebhookAck terminalWebhookSumup(SumUpWebhookPayload)

Receive SumUp Terminal webhook events

Parameters

Name	Type	Description	Notes
SumUpWebhookPayload	SumUpWebhookPayload

Return type

TerminalWebhookAck

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

terminalWebhookWorldline

TerminalWebhookAck terminalWebhookWorldline(WorldlineWebhookPayload)

Receive Worldline Terminal webhook events

Parameters

Name	Type	Description	Notes
WorldlineWebhookPayload	WorldlineWebhookPayload

Return type

TerminalWebhookAck

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

terminalWebhookZettle

TerminalWebhookAck terminalWebhookZettle(ZettleWebhookPayload)

Receive Zettle Terminal webhook events

Parameters

Name	Type	Description	Notes
ZettleWebhookPayload	ZettleWebhookPayload

Return type

TerminalWebhookAck

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

uploadDriverDocument

MessageResponse uploadDriverDocument(vendor_id, driver_id, documents)

Upload driver documents

Allows drivers to upload required documents for account verification and compliance. Documents are validated and processed for approval by the vendor.

Parameters

Name	Type	Description	Notes
vendor_id	Long	The ID of the vendor organization	[default to null]
driver_id	Long	The ID of the driver uploading documents	[default to null]
documents	List		[default to null]

Return type

MessageResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json; charset=utf-8

uploadVendorDocument

MessageResponse uploadVendorDocument(vendor_id, request_id, documents)

Upload vendor documents

Allows vendors to upload required documents for account verification and compliance.

Parameters

Name	Type	Description	Notes
vendor_id	Long	The ID of the vendor uploading documents	[default to null]
request_id	Long	The ID of the document request	[default to null]
documents	List		[default to null]

Return type

MessageResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json; charset=utf-8