PayFanout API reference
    Preparing search index...

    Interface AdapterOnboardingDescriptor

    interface AdapterOnboardingDescriptor {
        credentialFields: CredentialFieldDescriptor[];
        csp: { connect: string[]; frame: string[]; script: string[] };
        pspName: string;
        webhook: { events?: string[]; signature: WebhookSignatureScheme };
    }
    Index
    credentialFields csp pspName webhook
    credentialFields: CredentialFieldDescriptor[]

    Credentials a host collects to onboard a merchant onto this PSP.

    csp: { connect: string[]; frame: string[]; script: string[] }

    CSP sources the PSP's browser SDK needs, by directive. An empty array means none is needed for that directive (no embedded surface, as with a redirect-only PSP). Hosts, subdomain wildcards included (https://*.paypal.com), are listed as they are; a PSP whose documentation allows any host lists a bare "*", which CSP accepts as a host source.

    pspName: string
    webhook: { events?: string[]; signature: WebhookSignatureScheme }

    Type Declaration

    • Optionalevents?: string[]

      Provider event-type identifiers the adapter's parser consumes — render these as the "events to subscribe" list in the PSP's dashboard. Omitted for PSPs that have no discrete subscribable event types (e.g. PayZen, whose IPNs are order-state snapshots).

    • signature: WebhookSignatureScheme

    Settings
    Member Visibility

    On This Page
    Properties