Log in
Interface

OrderPaymentInterface

Magento\Sales\Api\Data\OrderPaymentInterface

What it does

This interface defines the contract for order payment data in Magento 2.

Developers use it to access and manipulate payment information associated with sales orders, including payment amounts, credit card details, eCheck information, and transaction data.

It's primarily used when working with order payment processing, retrieving payment details, or implementing custom payment methods.

Public Methods

  • getAccountStatus()
  • getAdditionalData()
  • getAdditionalInformation()
  • getAddressStatus()
  • getAmountAuthorized()
  • getAmountCanceled()
  • getAmountOrdered()
  • getAmountPaid()
  • getAmountRefunded()
  • getAnetTransMethod()
  • getBaseAmountAuthorized()
  • getBaseAmountCanceled()
  • getBaseAmountOrdered()
  • getBaseAmountPaid()
  • getBaseAmountPaidOnline()
  • getBaseAmountRefunded()
  • getBaseAmountRefundedOnline()
  • getBaseShippingAmount()
  • getBaseShippingCaptured()
  • getBaseShippingRefunded()
  • getCcApproval()
  • getCcAvsStatus()
  • getCcCidStatus()
  • getCcDebugRequestBody()
  • getCcDebugResponseBody()
  • getCcDebugResponseSerialized()
  • getCcExpMonth()
  • getCcExpYear()
  • getCcLast4()
  • getCcNumberEnc()
  • getCcOwner()
  • getCcSecureVerify()
  • getCcSsIssue()
  • getCcSsStartMonth()
  • getCcSsStartYear()
  • getCcStatus()
  • getCcStatusDescription()
  • getCcTransId()
  • getCcType()
  • getEcheckAccountName()
  • getEcheckAccountType()
  • getEcheckBankName()
  • getEcheckRoutingNumber()
  • getEcheckType()
  • getEntityId()
  • setEntityId()
  • getLastTransId()
  • getMethod()
  • getParentId()
  • getPoNumber()
  • getProtectionEligibility()
  • getQuotePaymentId()
  • getShippingAmount()
  • getShippingCaptured()
  • getShippingRefunded()
  • setParentId()
  • setBaseShippingCaptured()
  • setShippingCaptured()
  • setAmountRefunded()
  • setBaseAmountPaid()
  • setAmountCanceled()
  • setBaseAmountAuthorized()
  • setBaseAmountPaidOnline()
  • setBaseAmountRefundedOnline()
  • setBaseShippingAmount()
  • setShippingAmount()
  • setAmountPaid()
  • setAmountAuthorized()
  • setBaseAmountOrdered()
  • setBaseShippingRefunded()
  • setShippingRefunded()
  • setBaseAmountRefunded()
  • setAmountOrdered()
  • setBaseAmountCanceled()
  • setQuotePaymentId()
  • setAdditionalData()
  • setCcExpMonth()
  • setCcSsStartYear()
  • setEcheckBankName()
  • setMethod()
  • setCcDebugRequestBody()
  • setCcSecureVerify()
  • setProtectionEligibility()
  • setCcApproval()
  • setCcLast4()
  • setCcStatusDescription()
  • setEcheckType()
  • setCcDebugResponseSerialized()
  • setCcSsStartMonth()
  • setEcheckAccountType()
  • setLastTransId()
  • setCcCidStatus()
  • setCcOwner()
  • setCcType()
  • setPoNumber()
  • setCcExpYear()
  • setCcStatus()
  • setEcheckRoutingNumber()
  • setAccountStatus()
  • setAnetTransMethod()
  • setCcDebugResponseBody()
  • setCcSsIssue()
  • setEcheckAccountName()
  • setCcAvsStatus()
  • setCcNumberEnc()
  • setCcTransId()
  • setAdditionalInformation()
  • setAddressStatus()
  • getExtensionAttributes()
  • setExtensionAttributes()