Skip to content

Latest commit

 

History

History
87 lines (82 loc) · 2.69 KB

paymentinitializerequest.md

File metadata and controls

87 lines (82 loc) · 2.69 KB

PaymentInitializeRequest

Example Usage

import {
  AddressReferenceExplicitTag,
  CountryCode,
  Currency,
  PaymentInitializeRequest,
  PaymentMethodAffirmTag,
} from "@boltpay/bolt-typescript-sdk/models/components";

let value: PaymentInitializeRequest = {
  cart: {
    orderReference: "order_100",
    orderDescription: "Order #1234567890",
    displayId: "215614191",
    shipments: [
      {
        address: {
          dotTag: AddressReferenceExplicitTag.Explicit,
          firstName: "Alice",
          lastName: "Baker",
          company: "ACME Corporation",
          streetAddress1: "535 Mission St, Ste 1401",
          streetAddress2: "c/o Shipping Department",
          locality: "San Francisco",
          postalCode: "94105",
          region: "CA",
          countryCode: CountryCode.Us,
          email: "[email protected]",
          phone: "+14155550199",
        },
        cost: {
          currency: Currency.Usd,
          units: 900,
        },
        carrier: "FedEx",
      },
    ],
    discounts: [
      {
        amount: {
          currency: Currency.Usd,
          units: 900,
        },
        code: "SUMMER10DISCOUNT",
        detailsUrl: "https://www.example.com/SUMMER-SALE",
      },
    ],
    items: [
      {
        name: "Bolt Swag Bag",
        reference: "item_100",
        description: "Large tote with Bolt logo.",
        totalAmount: {
          currency: Currency.Usd,
          units: 900,
        },
        unitPrice: 1000,
        quantity: 1,
        imageUrl: "https://www.example.com/products/123456/images/1.png",
      },
    ],
    total: {
      currency: Currency.Usd,
      units: 900,
    },
    tax: {
      currency: Currency.Usd,
      units: 900,
    },
  },
  paymentMethod: {
    dotTag: PaymentMethodAffirmTag.Affirm,
    returnUrl: "www.example.com/handle_affirm_success",
  },
};

Fields

Field Type Required Description
cart components.Cart ✔️ N/A
paymentMethod components.PaymentMethodExtended ✔️ N/A