Options
All
  • Public
  • Public/Protected
  • All
Menu

Module shopperPayments

Index

References

Namespaces

Classes

Type aliases

Variables

References

ErrorResponse

Re-exports ErrorResponse

ErrorResponse

Re-exports ErrorResponse

GetPaymentConfigurationPersonalizedEnum

Re-exports GetPaymentConfigurationPersonalizedEnum

GetPaymentConfigurationPersonalizedEnum

Re-exports GetPaymentConfigurationPersonalizedEnum

GetPaymentConfigurationSfdcDwDntEnum

Re-exports GetPaymentConfigurationSfdcDwDntEnum

GetPaymentConfigurationSfdcDwDntEnum

Re-exports GetPaymentConfigurationSfdcDwDntEnum

GetPaymentInstrumentBalanceSfdcDwDntEnum

Re-exports GetPaymentInstrumentBalanceSfdcDwDntEnum

GetPaymentInstrumentBalanceSfdcDwDntEnum

Re-exports GetPaymentInstrumentBalanceSfdcDwDntEnum

GiftCardRequest

Re-exports GiftCardRequest

GiftCardRequest

Re-exports GiftCardRequest

PaymentConfiguration

Re-exports PaymentConfiguration

PaymentConfiguration

Re-exports PaymentConfiguration

PaymentConfigurationPaymentMethodSetAccountsInner

Re-exports PaymentConfigurationPaymentMethodSetAccountsInner

PaymentConfigurationPaymentMethodSetAccountsInner

Re-exports PaymentConfigurationPaymentMethodSetAccountsInner

PaymentConfigurationPaymentMethodSetAccountsInnerConfig

Re-exports PaymentConfigurationPaymentMethodSetAccountsInnerConfig

PaymentConfigurationPaymentMethodSetAccountsInnerConfig

Re-exports PaymentConfigurationPaymentMethodSetAccountsInnerConfig

PaymentConfigurationPaymentMethodsInner

Re-exports PaymentConfigurationPaymentMethodsInner

PaymentConfigurationPaymentMethodsInner

Re-exports PaymentConfigurationPaymentMethodsInner

PaymentInstrumentBalanceRequest

Re-exports PaymentInstrumentBalanceRequest

PaymentInstrumentBalanceRequest

Re-exports PaymentInstrumentBalanceRequest

PaymentInstrumentBalanceResponse

Re-exports PaymentInstrumentBalanceResponse

PaymentInstrumentBalanceResponse

Re-exports PaymentInstrumentBalanceResponse

ShopperPayments

Re-exports ShopperPayments

ShopperPayments

Re-exports ShopperPayments

ShopperPaymentsParameters

Re-exports ShopperPaymentsParameters

ShopperPaymentsParameters

Re-exports ShopperPaymentsParameters

ShopperPaymentsPathParameters

Re-exports ShopperPaymentsPathParameters

ShopperPaymentsPathParameters

Re-exports ShopperPaymentsPathParameters

ShopperPaymentsQueryParameters

Re-exports ShopperPaymentsQueryParameters

ShopperPaymentsQueryParameters

Re-exports ShopperPaymentsQueryParameters

defaultBaseUri

Re-exports defaultBaseUri

getPaymentConfigurationPathParameters

Re-exports getPaymentConfigurationPathParameters

getPaymentConfigurationPathParameters

Re-exports getPaymentConfigurationPathParameters

getPaymentConfigurationQueryParameters

Re-exports getPaymentConfigurationQueryParameters

getPaymentConfigurationQueryParameters

Re-exports getPaymentConfigurationQueryParameters

getPaymentInstrumentBalancePathParameters

Re-exports getPaymentInstrumentBalancePathParameters

getPaymentInstrumentBalancePathParameters

Re-exports getPaymentInstrumentBalancePathParameters

getPaymentInstrumentBalanceQueryParameters

Re-exports getPaymentInstrumentBalanceQueryParameters

getPaymentInstrumentBalanceQueryParameters

Re-exports getPaymentInstrumentBalanceQueryParameters

Type aliases

ErrorResponse

ErrorResponse: { detail: string; instance?: undefined | string; title: string; type: string } & {}
property

title: A short, human-readable summary of the problem type. It will not change from occurrence to occurrence of the problem, except for purposes of localization

  • Max Length: 256
property

type: A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank". It accepts relative URIs; this means that they must be resolved relative to the document's base URI, as per [RFC3986], Section 5.

  • Max Length: 2048
property

detail: A human-readable explanation specific to this occurrence of the problem.

property

instance: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. It accepts relative URIs; this means that they must be resolved relative to the document's base URI, as per [RFC3986], Section 5.

  • Max Length: 2048

GetPaymentConfigurationPersonalizedEnum

GetPaymentConfigurationPersonalizedEnum: "none"

GetPaymentConfigurationSfdcDwDntEnum

GetPaymentConfigurationSfdcDwDntEnum: "0" | "1"

GetPaymentInstrumentBalanceSfdcDwDntEnum

GetPaymentInstrumentBalanceSfdcDwDntEnum: "0" | "1"

GiftCardRequest

GiftCardRequest: { brand: string; cardNumber: string; cvc: string; expirationMonth?: undefined | number; expirationYear?: undefined | number } & {}
property

brand: The gift card type or brand (for example, givex, blackhawk).

  • Max Length: 256
property

cardNumber: The gift card number.

  • Max Length: 40
property

cvc: The card verification code (CVC/CVV) for the gift card.

  • Max Length: 4
property

expirationMonth: The month when the gift card expires.

property

expirationYear: The year when the gift card expires.

PaymentConfiguration

PaymentConfiguration: { paymentMethodSetAccounts: Array<PaymentConfigurationPaymentMethodSetAccountsInner>; paymentMethods: Array<PaymentConfigurationPaymentMethodsInner>; zoneId?: string | null } & {}
property

zoneId: The unique identifier for a Payments zone.

  • Pattern: /^[a-zA-Z0-9\-_]{1,100}$/
  • Min Length: 1
  • Max Length: 100
property

paymentMethodSetAccounts: List of payment method set accounts

property

paymentMethods: Configured payment methods

PaymentConfigurationPaymentMethodSetAccountsInner

PaymentConfigurationPaymentMethodSetAccountsInner: { accountId: string; config?: PaymentConfigurationPaymentMethodSetAccountsInnerConfig; live: boolean; vendor: string } & {}
property

accountId: Account identifier

  • Min Length: 1
  • Max Length: 100
property

config:

property

live: Whether the account is in live mode

property

vendor: Payment vendor name

PaymentConfigurationPaymentMethodSetAccountsInnerConfig

PaymentConfigurationPaymentMethodSetAccountsInnerConfig: { bnCode?: undefined | string; country?: undefined | string; key?: undefined | string; paymentMethods?: {} | null } & {}
property

key: API key for the payment processor

  • Max Length: 200
property

bnCode: Account BN code (optional, null if not a PayPal account)

  • Max Length: 100
property

country: The country associated with this payment account configuration

  • Max Length: 256
property

paymentMethods: Available payment methods from gateway (optional, null if not an Adyen account)

PaymentConfigurationPaymentMethodsInner

PaymentConfigurationPaymentMethodsInner: { accountId: string; paymentMethodType: string; paymentModes: Array<string> } & {}
property

accountId: Associated account identifier

  • Min Length: 1
property

paymentMethodType: Type of payment method

property

paymentModes: Supported payment modes

PaymentInstrumentBalanceRequest

PaymentInstrumentBalanceRequest: { giftCard: GiftCardRequest; paymentMethodId: string } & {}
property

paymentMethodId: The payment method ID.

  • Max Length: 256
property

giftCard: The gift card details.

PaymentInstrumentBalanceResponse

PaymentInstrumentBalanceResponse: { amount: number; currency: string } & {}
property

amount: The remaining balance on the payment instrument.

property

currency: The three-letter currency code (ISO 4217) of the payment instrument balance.

  • Pattern: /^([A-Z][A-Z][A-Z]|N/A)$/

ShopperPaymentsParameters

All parameters that are used by ShopperPayments.

ShopperPaymentsParameters

All parameters that are used by ShopperPayments.

ShopperPaymentsPathParameters

All path parameters that are used by at least one ShopperPayments method.

ShopperPaymentsPathParameters

ShopperPaymentsPathParameters: Partial<getPaymentConfigurationPathParameters & {}>

All path parameters that are used by at least one ShopperPayments method.

ShopperPaymentsQueryParameters

All query parameters that are used by at least one ShopperPayments method.

ShopperPaymentsQueryParameters

ShopperPaymentsQueryParameters: Partial<getPaymentConfigurationQueryParameters & {}>

All query parameters that are used by at least one ShopperPayments method.

getPaymentConfigurationPathParameters

getPaymentConfigurationPathParameters: { organizationId: string }

Type declaration

  • organizationId: string

getPaymentConfigurationPathParameters

getPaymentConfigurationPathParameters: { organizationId: string }

Type declaration

  • organizationId: string

getPaymentConfigurationQueryParameters

getPaymentConfigurationQueryParameters: { amount?: number | null; countryCode?: undefined | string; currency: string; personalized?: undefined | "none"; siteId: string; zoneId?: string | null }

Type declaration

  • Optional amount?: number | null
  • Optional countryCode?: undefined | string
  • currency: string
  • Optional personalized?: undefined | "none"
  • siteId: string
  • Optional zoneId?: string | null

getPaymentConfigurationQueryParameters

getPaymentConfigurationQueryParameters: { amount?: number | null; countryCode?: undefined | string; currency: string; siteId: string; zoneId?: string | null }

Type declaration

  • Optional amount?: number | null
  • Optional countryCode?: undefined | string
  • currency: string
  • siteId: string
  • Optional zoneId?: string | null

getPaymentInstrumentBalancePathParameters

getPaymentInstrumentBalancePathParameters: { organizationId: string }

Type declaration

  • organizationId: string

getPaymentInstrumentBalanceQueryParameters

getPaymentInstrumentBalanceQueryParameters: { siteId: string }

Type declaration

  • siteId: string

Variables

Const defaultBaseUri

defaultBaseUri: "https://{shortCode}.api.commercecloud.salesforce.com/checkout/shopper-payments/v1" = "https://{shortCode}.api.commercecloud.salesforce.com/checkout/shopper-payments/v1"

Generated using TypeDoc