Better Payment 0.11.1 API
    Preparing search index...

    Interface PaymentRequest

    Payment request parameters

    interface PaymentRequest {
        basketId: string;
        basketItems: BasketItem[];
        billingAddress: Address;
        buyer: Buyer;
        callbackUrl?: string;
        conversationId?: string;
        currency: string;
        installment?: number;
        paidPrice: string;
        paymentCard?: PaymentCard;
        price: string;
        saveCard?: boolean | { alias?: string; customerToken?: string };
        shippingAddress: Address;
        storedCard?: StoredCardReference;
    }

    Hierarchy (View Summary)

    Index
    basketId basketItems billingAddress buyer callbackUrl? conversationId? currency installment? paidPrice paymentCard? price saveCard? shippingAddress storedCard?
    basketId: string
    basketItems: BasketItem[]
    billingAddress: Address
    buyer: Buyer
    callbackUrl?: string
    conversationId?: string

    Order/transaction ID. Used as the order ID by bank and PayTR integrations; if omitted, an alphanumeric ID is generated and returned in the response.

    currency: string
    installment?: number

    Installment count (1 = single payment)

    paidPrice: string
    paymentCard?: PaymentCard

    The card to charge. Omit it when paying with storedCard.

    price: string
    saveCard?: boolean | { alias?: string; customerToken?: string }

    Save paymentCard with the provider during this payment (iyzico, PayTR Direct API). The tokens come back in storedCard of the result, or of the 3D Secure / notification result. Pass customerToken to add the card to an existing customer.

    shippingAddress: Address
    storedCard?: StoredCardReference

    Pay with a card saved earlier (iyzico, PayTR) instead of paymentCard

    Settings
    Member Visibility

    On This Page
    Properties