PaymentTokenManagementInterface Interface Reference

Inheritance diagram for PaymentTokenManagementInterface:

Public Member Functions
	getListByCustomerId ($customerId)
	getByPaymentId ($paymentId)
	getByGatewayToken ($token, $paymentMethodCode, $customerId)
	getByPublicHash ($hash, $customerId)
	saveTokenWithPaymentLink (PaymentTokenInterface $token, OrderPaymentInterface $payment)
	addLinkToOrderPayment ($paymentTokenId, $orderPaymentId)

Detailed Description

Gateway vault payment token repository interface.

@api

Since

100.1.0

Definition at line 17 of file PaymentTokenManagementInterface.php.

Member Function Documentation

addLinkToOrderPayment()

addLinkToOrderPayment	(		$paymentTokenId,
			$orderPaymentId
	)

Add link between payment token and order payment.

Parameters

int	$paymentTokenId	Payment token ID.
int	$orderPaymentId	Order payment ID.

Returns

bool

Since

100.1.0

Implemented in PaymentTokenManagement.

getByGatewayToken()

getByGatewayToken	(		$token,
			$paymentMethodCode,
			$customerId
	)

Get payment token by gateway token.

Parameters

string	$token	The gateway token.
string	$paymentMethodCode
int	$customerId	Customer ID.

Returns

PaymentTokenInterface|null Payment token interface.

Since

100.1.0

Implemented in PaymentTokenManagement.

getByPaymentId()

getByPaymentId

(

$paymentId

)

Get payment token by token Id.

Parameters

int

$paymentId

The gateway payment token ID.

Returns

\Magento\Vault\Api\Data\PaymentTokenInterface Payment token interface.

Since

100.1.0

Implemented in PaymentTokenManagement.

getByPublicHash()

getByPublicHash	(		$hash,
			$customerId
	)

Get payment token by public hash.

Parameters

string	$hash	Public hash.
int	$customerId	Customer ID.

Returns

PaymentTokenInterface|null Payment token interface.

Since

100.1.0

Implemented in PaymentTokenManagement.

getListByCustomerId()

getListByCustomerId

(

$customerId

)

Lists payment tokens that match specified search criteria.

Parameters

int

$customerId

Customer ID.

Returns

\Magento\Vault\Api\Data\PaymentTokenSearchResultsInterface Payment token search result interface.

Since

100.1.0

Implemented in PaymentTokenManagement.

saveTokenWithPaymentLink()

saveTokenWithPaymentLink	(	PaymentTokenInterface	$token,
		OrderPaymentInterface	$payment
	)

Parameters

PaymentTokenInterface	$token
OrderPaymentInterface	$payment

Returns

bool

Since

100.1.0

Implemented in PaymentTokenManagement.

---

The documentation for this interface was generated from the following file:

• vendor/magento/module-vault/Api/PaymentTokenManagementInterface.php