OrderPaymentInterface

What it does

This interface defines the data structure and methods for managing payment information associated with sales orders in Magento 2.

Developers use it to access and manipulate payment details like amounts (authorized, paid, refunded), credit card information, eCheck data, and payment method specifics when working with order payments through the API or service contracts.

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()