1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace Iamolayemi\Paystack\Endpoints; |
4
|
|
|
|
5
|
|
|
class Customer extends Endpoint |
6
|
|
|
{ |
7
|
|
|
protected const ENDPOINT = '/customer'; |
8
|
|
|
|
9
|
|
|
/** |
10
|
|
|
* Create a customer on your integration. |
11
|
|
|
* |
12
|
|
|
* @param array<string, mixed> $payload |
13
|
|
|
* |
14
|
|
|
* @link https://paystack.com/docs/api/#customer-create |
15
|
|
|
*/ |
16
|
|
|
public function create(array $payload): self |
17
|
|
|
{ |
18
|
|
|
$this->post($this->url(self::ENDPOINT), $payload); |
19
|
|
|
|
20
|
|
|
return $this; |
21
|
|
|
} |
22
|
|
|
|
23
|
|
|
/** |
24
|
|
|
* List customers available on your integration. |
25
|
|
|
* |
26
|
|
|
* @param array<string, mixed> $query |
27
|
|
|
* |
28
|
|
|
* @link https://paystack.com/docs/api/#customer-list |
29
|
|
|
*/ |
30
|
|
|
public function list(array $query = []): self |
31
|
|
|
{ |
32
|
|
|
$this->get($this->url(self::ENDPOINT), $query); |
33
|
|
|
|
34
|
|
|
return $this; |
35
|
|
|
} |
36
|
|
|
|
37
|
|
|
/** |
38
|
|
|
* Get details of a customer on your integration. |
39
|
|
|
* |
40
|
|
|
* @link https://paystack.com/docs/api/#customer-fetch |
41
|
|
|
*/ |
42
|
|
|
public function fetch(string $customer_email): self |
43
|
|
|
{ |
44
|
|
|
$this->get($this->url(self::ENDPOINT).'/'.$customer_email); |
45
|
|
|
|
46
|
|
|
return $this; |
47
|
|
|
} |
48
|
|
|
|
49
|
|
|
/** |
50
|
|
|
* Update a customer's details on your integration. |
51
|
|
|
* |
52
|
|
|
* @param array<string, mixed> $payload |
53
|
|
|
* |
54
|
|
|
* @link https://paystack.com/docs/api/#customer-update |
55
|
|
|
*/ |
56
|
|
|
public function update(string $customer_code, array $payload = []): self |
57
|
|
|
{ |
58
|
|
|
$this->put($this->url(self::ENDPOINT).'/'.$customer_code, $payload); |
59
|
|
|
|
60
|
|
|
return $this; |
61
|
|
|
} |
62
|
|
|
|
63
|
|
|
/** |
64
|
|
|
* Validate a customer's identity. |
65
|
|
|
* |
66
|
|
|
* @param array<string, mixed> $payload |
67
|
|
|
* |
68
|
|
|
* @link https://paystack.com/docs/api/#customer-validate |
69
|
|
|
*/ |
70
|
|
|
public function validate(string $customer_code, array $payload = []): self |
71
|
|
|
{ |
72
|
|
|
$this->post($this->url(self::ENDPOINT).'/'.$customer_code.'/identification', $payload); |
73
|
|
|
|
74
|
|
|
return $this; |
75
|
|
|
} |
76
|
|
|
|
77
|
|
|
/** |
78
|
|
|
* Whitelist or blacklist a customer on your integration. |
79
|
|
|
* |
80
|
|
|
* @param array<string, mixed> $payload |
81
|
|
|
* |
82
|
|
|
* @link https://paystack.com/docs/api/#customer-whitelist-blacklist |
83
|
|
|
*/ |
84
|
|
|
public function whitelist(array $payload): self |
85
|
|
|
{ |
86
|
|
|
$this->post($this->url(self::ENDPOINT).'/set_risk_action', $payload); |
87
|
|
|
|
88
|
|
|
return $this; |
89
|
|
|
} |
90
|
|
|
|
91
|
|
|
/** |
92
|
|
|
* Deactivate an authorization when the card needs to be forgotten. |
93
|
|
|
* |
94
|
|
|
* @param array<string, mixed> $payload |
95
|
|
|
* |
96
|
|
|
* @link https://paystack.com/docs/api/#customer-deactivate-authorization |
97
|
|
|
*/ |
98
|
|
|
public function deactivateAuthorization(array $payload): self |
99
|
|
|
{ |
100
|
|
|
$this->post($this->url(self::ENDPOINT).'/deactivate_authorization', $payload); |
101
|
|
|
|
102
|
|
|
return $this; |
103
|
|
|
} |
104
|
|
|
} |
105
|
|
|
|