CustomerDriverInterface

Source: view src/Contracts/CustomerDriverInterface.php

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

createCustomer

Create a customer on the gateway. Expected $data keys: email (string) required — customer email address first_name (string) optional — customer first name last_name (string) optional — customer last name phone (string) optional — customer phone number metadata (array) optional — custom key/value pairs

public function createCustomer(array $data): array;

getCustomer

Retrieve a single customer by email, code, or ID.

public function getCustomer(string $identifier): array;

listCustomers

List all customers with optional filters.

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

updateCustomer

Update an existing customer's details.

public function updateCustomer(string $code, array $data): array;

validateCustomer

Validate a customer's identity (e.g. BVN, bank account).

public function validateCustomer(string $code, array $data): array;

setCustomerRiskAction

Set a customer's risk action (whitelist or blacklist).

public function setCustomerRiskAction(string $code, string $action): array;