Add refund invoice endpoint. Add getters to ApiKey result. (#123)

* Add refund invoice endpoint. * Add getters to ApiKey result.
btcpayserver · Apr 25, 2024 · c115b04 · c115b04
1 parent 385b7f6
commit c115b04
Show file tree

Hide file tree

Showing 2 changed files with 69 additions and 4 deletions.
diff --git a/src/Client/Invoice.php b/src/Client/Invoice.php
@@ -7,6 +7,7 @@
 use BTCPayServer\Result\Invoice as ResultInvoice;
 use BTCPayServer\Result\InvoiceList;
 use BTCPayServer\Result\InvoicePaymentMethod;
+use BTCPayServer\Result\PullPayment as ResultPullPayment;
 use BTCPayServer\Util\PreciseNumber;
 
 class Invoice extends AbstractClient
@@ -159,7 +160,8 @@ private function _getAllInvoicesWithFilter(
     public function getPaymentMethods(string $storeId, string $invoiceId): array
     {
         $method = 'GET';
-        $url = $this->getApiUrl() . 'stores/' . urlencode($storeId) . '/invoices/' . urlencode($invoiceId) . '/payment-methods';
+        $url = $this->getApiUrl() . 'stores/' . urlencode($storeId) . '/invoices/'
+            . urlencode($invoiceId) . '/payment-methods';
         $headers = $this->getRequestHeaders();
         $response = $this->getHttpClient()->request($method, $url, $headers);
 
@@ -181,11 +183,15 @@ public function getPaymentMethods(string $storeId, string $invoiceId): array
         }
     }
 
+    /**
+     * Mark an invoice status.
+     *
+     * @see https://docs.btcpayserver.org/API/Greenfield/v1/#operation/Invoices_MarkInvoiceStatus
+     * @throws \JsonException
+     */
     public function markInvoiceStatus(string $storeId, string $invoiceId, string $markAs): ResultInvoice
     {
-        $url = $this->getApiUrl() . 'stores/' . urlencode(
-            $storeId
-        ) . '/invoices/' . urlencode($invoiceId) . '/status';
+        $url = $this->getApiUrl() . 'stores/' . urlencode($storeId) . '/invoices/' . urlencode($invoiceId) . '/status';
         $headers = $this->getRequestHeaders();
         $method = 'POST';
 
@@ -206,4 +212,49 @@ public function markInvoiceStatus(string $storeId, string $invoiceId, string $ma
             throw $this->getExceptionByStatusCode($method, $url, $response);
         }
     }
+
+    /**
+     * Refund an invoice.
+     *
+     * @see https://docs.btcpayserver.org/API/Greenfield/v1/#operation/Invoices_Refund
+     * @throws \JsonException
+     */
+    public function refundInvoice(
+        string $storeId,
+        string $invoiceId,
+        ?string $refundVariant = 'CurrentRate',
+        ?string $paymentMethod = 'BTC',
+        ?string $name = null,
+        ?string $description = null,
+        ?float $subtractPercentage = 0.0,
+        ?PreciseNumber $customAmount = null,
+        ?string $customCurrency = null
+    ): ResultPullPayment {
+        $url = $this->getApiUrl() . 'stores/' . urlencode($storeId) . '/invoices/' . urlencode($invoiceId) . '/refund';
+        $headers = $this->getRequestHeaders();
+        $method = 'POST';
+
+        $body = json_encode(
+            [
+                'name' => $name,
+                'description' => $description,
+                'paymentMethod' => $paymentMethod,
+                'refundVariant' => $refundVariant,
+                'subtractPercentage' => $subtractPercentage,
+                'customAmount' => $customAmount?->__toString(),
+                'customCurrency' => $customCurrency
+            ],
+            JSON_THROW_ON_ERROR
+        );
+
+        $response = $this->getHttpClient()->request($method, $url, $headers, $body);
+
+        if ($response->getStatus() === 200) {
+            return new ResultPullPayment(
+                json_decode($response->getBody(), true, 512, JSON_THROW_ON_ERROR)
+            );
+        } else {
+            throw $this->getExceptionByStatusCode($method, $url, $response);
+        }
+    }
 }
diff --git a/src/Result/ApiKey.php b/src/Result/ApiKey.php
@@ -6,4 +6,18 @@
 
 class ApiKey extends AbstractResult
 {
+    public function getApiKey(): string
+    {
+        return $this->getData()['apiKey'];
+    }
+
+    public function getLabel(): string
+    {
+        return $this->getData()['label'];
+    }
+
+    public function getPermissions(): array
+    {
+        return $this->getData()['permissions'];
+    }
 }