@tax1driver/ts-przelewy24
    Preparing search index...

    Interface Order

    Represents an order

    Order

    interface Order {
        additional?: Additional;
        address?: string;
        amount: number;
        cart?: CartItem[];
        channel?: Channel;
        city?: string;
        client?: string;
        country: Country;
        currency: Currency;
        description: string;
        email: string;
        encoding?: Encoding;
        language: Language;
        method?: number;
        methodRefId?: string;
        mobileLib?: number;
        phone?: string;
        regulationAccept?: boolean;
        sdkVersion?: string;
        sessionId: string;
        shipping?: number;
        timeLimit?: number;
        transferLabel?: string;
        urlReturn: string;
        urlStatus?: string;
        waitForResult?: boolean;
        zip?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    additional? address? amount cart? channel? city? client? country currency description email encoding? language method? methodRefId? mobileLib? phone? regulationAccept? sdkVersion? sessionId shipping? timeLimit? transferLabel? urlReturn urlStatus? waitForResult? zip?

    Properties

    additional?: Additional

    Set of additional information about the transaction or the payer

    Order

    address?: string

    Customer's address

    Order

    amount: number

    Transaction amount expressed in lowest currency unit, e.g. 1.23 PLN = 123

    Order

    cart?: CartItem[]

    cart items

    Order

    channel?: Channel

    Channel of payment

    Order

    city?: string

    Customer's city

    Order

    client?: string

    Customer's first name and surname

    Order

    country: Country

    Country code

    Order

    currency: Currency

    Currency in ISO code

    Order

    description: string

    Transaction description

    Order

    email: string

    Customer's e-mail

    Order

    encoding?: Encoding

    Coding system for characters sent: ISO-8859-2, UTF-8, Windows-1250

    Order

    language: Language

    One of following language codes according to ISO 639-1: bg, cs, de, en, es, fr, hr, hu, it, nl, pl, pt, se, sk

    Order

    method?: number

    Payment method ID. List of payment methods provided in the panel or available through API

    Order

    methodRefId?: string

    Special parameter for some payment flows e.g. BLIK and Card one-click.

    Order

    mobileLib?: number

    The parameter is necessary while using SDK libraries. The value passed in mobileLib parameter is always 1 and value passed in sdkVersion determines which version of library should be used.

    Order

    phone?: string

    Customer's telephone in the following format: 481321132123

    Order

    regulationAccept?: boolean

    Acceptance of Przelewy24 regulations: false – display consent on p24 website (default), true – consent granted, do not display. In case the "true" parameter is sent, the consent – worded as follows – must be displayed on the Partner’s website: "I hereby state that I have read the regulations and information obligation of ”Przelewy24”. Under words regulations and information obligation there must be hyperlinks redirecting to websites with these documents. The checkbox must not be ticked by default.

    Order

    sdkVersion?: string

    Version of mobile library. Determines if transaction is mobile.

    Order

    sessionId: string

    Unique identifier from merchant's system

    Order

    shipping?: number

    Delivery cost

    Order

    timeLimit?: number

    Time limit for transaction process, 0 - no limit, max. 99 (in minutes)

    Order

    transferLabel?: string

    Description forwarded to transfer's description (not in every payment methods).

    Order

    urlReturn: string

    URL address to which customer will be redirected when transaction is complete

    Order

    urlStatus?: string

    URL address to which transaction status will be send

    Order

    waitForResult?: boolean

    Parameter determines wheter a user should wait for result of the transaction in the transaction service and be redirected back to the shop upon receiving confirmation or be redirected back to the shop immediately after payment.

    Order

    zip?: string

    Customer's postal code

    Order

    Settings

    Member Visibility

    On This Page

    Properties