PaymentLinkDriverInterface

Source: view src/Contracts/PaymentLinkDriverInterface.php

Generated from the public PHP contract and its PHPDoc. Driver support varies; check instanceof or GatewayCapabilities before calling optional gateway capabilities.

createPaymentLink

Create a shareable payment link. Expected $data keys: amount (float) optional — fixed amount; omit for customer-specified amount currency (string) required name (string) required — link title / product name description (string) optional callback_url (string) optional — redirect URL after payment reference (string) optional — unique caller-supplied reference expires_at (string) optional — ISO 8601 datetime for link expiry metadata (array) optional

public function createPaymentLink(array $data): array;

updatePaymentLink

Update an existing payment link.

public function updatePaymentLink(string $linkId, array $data): array;

getPaymentLink

Retrieve details of a single payment link.

public function getPaymentLink(string $linkId): array;

listPaymentLinks

List all payment links with optional filters.

public function listPaymentLinks(array $params = []): array;

disablePaymentLink

Disable / deactivate a payment link so it can no longer be used.

public function disablePaymentLink(string $linkId): array;