Interface MerchantServerWebhookCallbacks

interface MerchantServerWebhookCallbacks {
    anonymousSessionHandling: {
        handleRemoteCall(methodIdentifier, requestData, counterpartyUid): WebhookCallbackResponse<{
            data: Uint8Array;
            kind: "respond";
        } | {
            kind: "reject";
            reason: reason_with_details;
        }>;
        handleRemoteCallNoReturn(methodIdentifier, requestData, counterpartyUid): WebhookCallbackResponse<{
            kind: "processed";
        } | {
            kind: "reject";
            reason: reason_with_details;
        }>;
    };
    diagnostics?: {
        edgeSessionClosed?(userMerchantReference): void;
        edgeSessionCreated?(userMerchantReference): void;
    };
    personaLifecycle: {
        continuePersonaSignup(signupId, signupForm, signupRecordData, steps): WebhookCallbackResponse<PersonaSignupProcessResult>;
        initializePersonaSignup(signupId, signupForm, initialStep, handoveredRealworldProfile?): WebhookCallbackResponse<PersonaSignupProcessResult>;
        personaRemovalRequested(userMerchantReference, companionData): WebhookCallbackResponse<{
            kind: "requestProcessed";
        } | {
            kind: "requestRejected";
            reason: reason_with_details;
        }>;
        personaSignupAborted(signupId, reason, signupRecordData, signupPreregistrationData?): WebhookCallbackResponse<{
            kind: "acknowledged";
        }>;
        personaSignupFinished(signupId, signupRecordData, signupPreregistrationData): WebhookCallbackResponse<{
            kind: "acknowledged";
        }>;
    };
    personaSessionHandling: {
        handleRemoteCall(methodIdentifier, merchantUserReference, dynamicEvidence, requestData): WebhookCallbackResponse<{
            data: Uint8Array;
            kind: "respond";
        } | {
            kind: "reject";
            reason: reason_with_details;
        }>;
        handleRemoteCallNoReturn(methodIdentifier, merchantUserReference, dynamicEvidence, requestData): WebhookCallbackResponse<{
            kind: "processed";
        } | {
            kind: "reject";
            reason: reason_with_details;
        }>;
    };
}

Properties

anonymousSessionHandling: {
    handleRemoteCall(methodIdentifier, requestData, counterpartyUid): WebhookCallbackResponse<{
        data: Uint8Array;
        kind: "respond";
    } | {
        kind: "reject";
        reason: reason_with_details;
    }>;
    handleRemoteCallNoReturn(methodIdentifier, requestData, counterpartyUid): WebhookCallbackResponse<{
        kind: "processed";
    } | {
        kind: "reject";
        reason: reason_with_details;
    }>;
}

Type declaration

  • handleRemoteCall:function
    • Parameters

      • methodIdentifier: string
      • requestData: Uint8Array
      • counterpartyUid: string

      Returns WebhookCallbackResponse<{
          data: Uint8Array;
          kind: "respond";
      } | {
          kind: "reject";
          reason: reason_with_details;
      }>

  • handleRemoteCallNoReturn:function
    • Parameters

      • methodIdentifier: string
      • requestData: Uint8Array
      • counterpartyUid: string

      Returns WebhookCallbackResponse<{
          kind: "processed";
      } | {
          kind: "reject";
          reason: reason_with_details;
      }>

diagnostics?: {
    edgeSessionClosed?(userMerchantReference): void;
    edgeSessionCreated?(userMerchantReference): void;
}

Type declaration

  • edgeSessionClosed?:function
    • Parameters

      • userMerchantReference: string

      Returns void

  • edgeSessionCreated?:function
    • Parameters

      • userMerchantReference: string

      Returns void

personaLifecycle: {
    continuePersonaSignup(signupId, signupForm, signupRecordData, steps): WebhookCallbackResponse<PersonaSignupProcessResult>;
    initializePersonaSignup(signupId, signupForm, initialStep, handoveredRealworldProfile?): WebhookCallbackResponse<PersonaSignupProcessResult>;
    personaRemovalRequested(userMerchantReference, companionData): WebhookCallbackResponse<{
        kind: "requestProcessed";
    } | {
        kind: "requestRejected";
        reason: reason_with_details;
    }>;
    personaSignupAborted(signupId, reason, signupRecordData, signupPreregistrationData?): WebhookCallbackResponse<{
        kind: "acknowledged";
    }>;
    personaSignupFinished(signupId, signupRecordData, signupPreregistrationData): WebhookCallbackResponse<{
        kind: "acknowledged";
    }>;
}

Type declaration

personaSessionHandling: {
    handleRemoteCall(methodIdentifier, merchantUserReference, dynamicEvidence, requestData): WebhookCallbackResponse<{
        data: Uint8Array;
        kind: "respond";
    } | {
        kind: "reject";
        reason: reason_with_details;
    }>;
    handleRemoteCallNoReturn(methodIdentifier, merchantUserReference, dynamicEvidence, requestData): WebhookCallbackResponse<{
        kind: "processed";
    } | {
        kind: "reject";
        reason: reason_with_details;
    }>;
}

Type declaration

Generated using TypeDoc