PSPRequest | WebHare Platform SDK
WebHare Platform SDK
    Preparing search index...

    Interface PSPRequest

    interface PSPRequest {
        billingAddress?: PSPAddressFormat;
        customerId?: string;
        email?: string;
        extraPspData?: Record<string, unknown>;
        firstName?: string;
        infix?: string;
        ipAddress?: string;
        lang?: string;
        lastName?: string;
        method: string;
        orderId: string;
        orderLines?: PSPOrderLine[];
        paymentId: string;
        pushUrl: string;
        returnUrl: string;
        shippingAddress?: PSPAddressFormat;
        toPay: Money;
    }

    Hierarchy (View Summary)

    Index

    Properties

    billingAddress?: PSPAddressFormat
    customerId?: string

    User's customer id in our database

    email?: string

    Email address

    extraPspData?: Record<string, unknown>

    Extra data

    firstName?: string

    Personal info

    infix?: string
    ipAddress?: string

    User's IP address

    lang?: string

    User's language code, eg 'nl' or 'en-US

    lastName?: string
    method: string

    Rowkey of the selected method

    orderId: string

    Order id/payment reference which should be unique in the scope of the relevant application for the payment requests (but shared over all payment attempts)

    orderLines?: PSPOrderLine[]

    Order contents

    paymentId: string

    The end-to-end paymentuuid to track this payment attempt which should be globally unique

    pushUrl: string

    URL the PSP should push notifications to

    returnUrl: string

    URL the PSP should return to

    shippingAddress?: PSPAddressFormat
    toPay: Money

    The amount we'd like to be paid, includes vat if we expect that to be included in the payment