feat: add support for refunds

Author: mychidarko

src/Paystack/Refund.php

@@ -0,0 +1,103 @@
+<?php
+
+namespace Leaf\Billing\Paystack;
+
+/**
+ * PayStack Refund
+ * ----
+ * API wrapper for PayStack Refund API
+ */
+class Refund
+{
+    public Transaction $transaction;
+    public $integration;
+    public $deducted_amount;
+    public $channel;
+    public $currency;
+    public $amount;
+    public $fully_deducted;
+    public $refunded_by;
+    public $expected_at;
+    public $merchant_note;
+    public $customer_note;
+    public $id;
+    public $status;
+    public $createdAt;
+    public $updatedAt;
+
+    public function __construct(array $refund)
+    {
+        $this->transaction = $refund['transaction'];
+        $this->integration = $refund['integration'];
+        $this->deducted_amount = $refund['deducted_amount'];
+        $this->channel = $refund['channel'];
+        $this->currency = $refund['currency'];
+        $this->amount = $refund['amount'];
+        $this->fully_deducted = $refund['fully_deducted'];
+        $this->refunded_by = $refund['refunded_by'];
+        $this->expected_at = $refund['expected_at'];
+        $this->merchant_note = $refund['merchant_note'];
+        $this->customer_note = $refund['customer_note'];
+        $this->id = $refund['id'];
+        $this->status = $refund['status'];
+        $this->createdAt = $refund['createdAt'];
+        $this->updatedAt = $refund['updatedAt'];
+    }
+
+    /**
+     * Refund initiated?
+     * @return bool
+     */
+    public function isPending(): bool
+    {
+        return $this->status === 'pending';
+    }
+
+    /**
+     * Refund received by bank?
+     * @return bool
+     */
+    public function isProcessing(): bool
+    {
+        return $this->status === 'processing';
+    }
+
+    /**
+     * Refund successful?
+     * @return bool
+     */
+    public function isSuccessful(): bool
+    {
+        return $this->status === 'success';
+    }
+
+    /**
+     * Refund failed?
+     * @return bool
+     */
+    public function isFailed(): bool
+    {
+        return $this->status === 'failed';
+    }
+
+    public function toArray()
+    {
+        return [
+            'id' => $this->id,
+            'transaction' => $this->transaction->toArray(),
+            'integration' => $this->integration,
+            'deducted_amount' => $this->deducted_amount,
+            'channel' => $this->channel,
+            'currency' => $this->currency,
+            'amount' => $this->amount,
+            'fully_deducted' => $this->fully_deducted,
+            'refunded_by' => $this->refunded_by,
+            'expected_at' => $this->expected_at,
+            'merchant_note' => $this->merchant_note,
+            'customer_note' => $this->customer_note,
+            'status' => $this->status,
+            'createdAt' => $this->createdAt,
+            'updatedAt' => $this->updatedAt,
+        ];
+    }
+}

src/Paystack/Refunds.php

@@ -0,0 +1,70 @@
+<?php
+
+namespace Leaf\Billing\Paystack;
+
+/**
+ * PayStack Refunds
+ * ----
+ * API wrapper for PayStack Refunds API
+ */
+class Refunds
+{
+    protected $client;
+
+    public function __construct($client)
+    {
+        $this->client = $client;
+    }
+
+    /**
+     * Create a new paystack refund
+     */
+    public function create(array $params): Refund
+    {
+        $response = $this->client->post('/refund', [
+            'body' => json_encode($params)
+        ]);
+
+        $refund = json_decode($response->getBody(), true);
+        $refund = $refund['data'];
+
+        $refund['transaction'] = (is_numeric($refund['transaction']))
+            ? (new Transactions($this->client))->get($refund['transaction'])
+            : new Transaction($refund['transaction']);
+
+        return new Refund($refund);
+    }
+
+    /**
+     * Get all paystack refunds
+     */
+    public function all(): array
+    {
+        $response = $this->client->get('/refund');
+
+        $refunds = json_decode($response->getBody(), true);
+
+        return array_map(function ($refund) {
+            return new Refund($refund);
+        }, $refunds['data']);
+    }
+
+    /**
+     * Get a paystack refund by id
+     */
+    public function get($id): Refund
+    {
+        $response = $this->client->get("/refund/$id");
+
+        $refund = json_decode($response->getBody(), true);
+
+        return new Refund($refund['data']);
+    }
+
+    public function toArray()
+    {
+        return array_map(function ($transaction) {
+            return $transaction->toArray();
+        }, $this->all());
+    }
+}