Skip to Content

OnboardingFeeApi

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

MethodHTTP requestDescription
checkOnboardingPaymentStatusGET /onboarding/fees/{business_id}/statusCheck onboarding payment status for a business.
initiateOnboardingFeePaymentPOST /onboarding/fees/{business_id}/payInitiate payment for a selected onboarding fee.
listOnboardingFeesGET /onboarding/fees/{business_id}List active onboarding fees for a specific business.

checkOnboardingPaymentStatus

OnboardingPaymentStatusResponse checkOnboardingPaymentStatus(business_id)

Check onboarding payment status for a business.

Parameters

NameTypeDescriptionNotes
business_idLong[default to null]

Return type

OnboardingPaymentStatusResponse

Authorization

JwtAuthScheme

HTTP request headers

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

initiateOnboardingFeePayment

InitiateOnboardingPaymentResponse initiateOnboardingFeePayment(business_id, InitiateOnboardingPaymentRequest)

Initiate payment for a selected onboarding fee.

Parameters

NameTypeDescriptionNotes
business_idLong[default to null]
InitiateOnboardingPaymentRequestInitiateOnboardingPaymentRequest

Return type

InitiateOnboardingPaymentResponse

Authorization

JwtAuthScheme

HTTP request headers

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

listOnboardingFees

PaginatedResponse_ListedFee listOnboardingFees(business_id, page, per_page)

List active onboarding fees for a specific business.

Parameters

NameTypeDescriptionNotes
business_idLong[default to null]
pageIntegerPage number for pagination (default: 1)[optional] [default to null]
per_pageIntegerItems per page for pagination (default: 20)[optional] [default to null]

Return type

PaginatedResponse_ListedFee

Authorization

JwtAuthScheme

HTTP request headers

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