Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Payment

Hierarchy

Index

Properties

Properties

Optional Readonly child

child?: Core.Graph

curie

curie: "fx:payment"

links

links: { fx:store: Backend.Rels.Store; fx:transaction: Backend.Rels.Transaction; self: Payment }

Type declaration

props

props: { amount: number; cc_exp_month: null | string; cc_exp_year: null | string; cc_number_masked: string; cc_type: null | string; date_created: null | string; date_modified: null | string; fraud_protection_score: number; gateway_type: string; paypal_payer_id: string; processor_response: string; processor_response_details: string; purchase_order: string; third_party_id: string; type: "plastic" | "purchase_order" | "paypal" | "amazon_mws" | "hosted" | "ogone" | "paypal_ec" }

Type declaration

  • amount: number

    The total amount of this payment.

  • cc_exp_month: null | string

    The credit card expiration month (for plastic payment types).

  • cc_exp_year: null | string

    The credit card expiration year (for plastic payment types).

  • cc_number_masked: string

    The masked credit card number used for this payment (for plastic payment types).

  • cc_type: null | string

    The type of credit card such as Visa or MasterCard (for plastic payment types).

  • date_created: null | string

    The date this resource was created.

  • date_modified: null | string

    The date this resource was last modified.

  • fraud_protection_score: number

    If this payment gateway set is configured with a fraud protection system, the fraud score for this payment will be listed here.

  • gateway_type: string

    The payment gateway type for this payment. This should correspond to a value in hosted_payment_gateways or payment_gateways.

  • paypal_payer_id: string

    The payer id for this payment (for Paypal payment types).

  • processor_response: string

    The processor response string from the payment gateway. This will include their transaction or reference number.

  • processor_response_details: string

    If supported by the payment gateway integration, this will include additional information from the payment gateway's response.

  • purchase_order: string

    The PO value entered by the customer during checkout (for purchase order payment types).

  • third_party_id: string

    The identifer for the third party provider for this payment (for hosted payment types).

  • type: "plastic" | "purchase_order" | "paypal" | "amazon_mws" | "hosted" | "ogone" | "paypal_ec"

    The payment type for this payment. Values include plastic (for credit/debit cards), purchase_order, paypal, amazon_mws, hosted, ogone, and paypal_ec

Optional Readonly zooms

zooms?: Readonly<Record<string, undefined | Core.Graph>>

Generated using TypeDoc