payment urls

doc/create-payment.md

@@ -67,6 +67,20 @@ Payment method buttons should look like this, second image is with hover.
 ![default](img/payment_method_button.png)
 ![hover](img/payment_method_button_hover.png)
 
+### Redirect user to gate with payment method selected for already created payment
+
+Method **getPaymentButtonsForPayment** returns HTML code.
+
+```php
+    // used default rendering
+    $paymentButtons = $client->getPaymentButtonsForPayment($paymentUid);
+```
+
+Payment method buttons should look like this, second image is with hover.
+
+![default](img/payment_method_button.png)
+![hover](img/payment_method_button_hover.png)
+
 #### Buttons css customization
 
 Example of rendered HTML for one button, values with **some** word can dynamically change in HTML rendering.

doc/get-pay-urls-for-existing-payment.md

@@ -0,0 +1,22 @@
+# Get pay URLs for existing payments
+
+Returns an array of available payment methods with pay URLs for certain payment.
+
+```php
+/** @var \ThePay\ApiClient\TheClient $client */
+$paymentMethod = $client->getPaymentUrlsForPayment('uid-454548', 'cs');
+```
+
+### Preformatted buttons
+
+Method **getPaymentButtonsForPayment** returns HTML code.
+
+```php
+    // used default rendering
+    $paymentButtons = $client->getPaymentButtonsForPayment($paymentUid);
+```
+
+Payment method buttons should look like this, second image is with hover.
+
+![default](img/payment_method_button.png)
+![hover](img/payment_method_button_hover.png)

doc/index.md

@@ -12,6 +12,7 @@
 | getPayments | https://dataapi21.docs.apiary.io/#reference/0/project-level-resources/get-payments |
 | getPaymentButtons | |
 | getPaymentButton | |
+| getPaymentButtons | |
 | createPayment | https://dataapi21.docs.apiary.io/#reference/0/project-level-resources/create-new-payment |
 | realizePreauthorizedPayment | https://dataapi21.docs.apiary.io/#reference/0/project-level-resources/realize-preauthorized-payment |
 | cancelPreauthorizedPayment | https://dataapi21.docs.apiary.io/#reference/0/project-level-resources/cancel-preauthorized-payment |
@@ -22,6 +23,7 @@
 | realizeIrregularSubscriptionPayment | https://dataapi21.docs.apiary.io/#reference/0/project-level-resources/realize-irregular-subscription-payment |
 | realizeUsageBasedSubscriptionPayment | https://dataapi21.docs.apiary.io/#reference/0/project-level-resources/realize-usage-based-subscription-payment |
 | realizePaymentBySavedAuthorization | https://dataapi21.docs.apiary.io/#reference/0/project-level-resources/realize-payment-by-saved-authorization |
+| getPaymentUrlsForPayment | https://dataapi21.docs.apiary.io/#reference/payment-creation/saved-card-authorization/change-method-for-payment/get-available-payment-methods |
 
 ## Usage examples
 
@@ -54,6 +56,8 @@
 
 [Saving authorization](saving-authorization.md)
 
+[Get pay URLs for existing payments](get-pay-urls-for-existing-payment.md)
+
 ## Methods
 
 ### getProjects
@@ -113,6 +117,18 @@ Returns HTML markup with list of payment buttons.
 
 Returns HTML markup with "Pay!" button.
 
+### getPaymentButtonsForPayment
+
+Returns HTML markup with list of payment buttons for already existing payment.
+
+#### Parameters
+
+| name | type |  | desc |
+| --- | --- | --- | --- |
+| $uid | string | required | Payment's UID |
+| $languageCode | PaymentMethodFilter | optional | Language code in ISO 6391 (2 chars) format |
+| $useInlineAssets | bool | optional | will generate basic css & js |
+
 #### Parameters
 
 | name | type |  | desc |
@@ -234,3 +250,14 @@ Create new payment using saved authorization.
 | --- | --- | --- | --- |
 | $uid | string | required | UID of parent payment |
 | $params | RealizePaymentBySavedAuthorizationParams | required | |
+
+### getPaymentUrlsForPayment
+
+Returns an array of available payment methods with pay URLs for certain payment.
+
+#### Parameters
+
+| name | type |  | description |
+| --- | --- | --- | --- |
+| $uid | string | required | Payment's UID |
+| $languageCode | PaymentMethodFilter | optional | Language code in ISO 6391 (2 chars) format |

src/Model/IPaymentMethod.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace ThePay\ApiClient\Model;
+
+use ThePay\ApiClient\ValueObject\Url;
+
+interface IPaymentMethod
+{
+    /**
+     * @return string
+     */
+    public function getCode();
+
+    /**
+     * @return string
+     */
+    public function getTitle();
+
+    /**
+     * @return Url
+     */
+    public function getImageUrl();
+
+    /**
+     * @return array<string>
+     */
+    public function getTags();
+
+    /**
+     * @return array<string, mixed>
+     */
+    public function toArray();
+}

src/Model/PaymentMethod.php

@@ -5,7 +5,7 @@
 use ThePay\ApiClient\Utils\Json;
 use ThePay\ApiClient\ValueObject\Url;
 
-class PaymentMethod
+class PaymentMethod implements IPaymentMethod
 {
     /**
      * @deprecated use ThePay\ApiClient\ValueObject\PaymentMethodTag::CARD

src/Model/PaymentMethodWithPayUrl.php

@@ -0,0 +1,84 @@
+<?php
+
+namespace ThePay\ApiClient\Model;
+
+use ThePay\ApiClient\Utils\Json;
+use ThePay\ApiClient\ValueObject\Url;
+
+class PaymentMethodWithPayUrl implements IPaymentMethod
+{
+    /** @var string */
+    private $code;
+
+    /** @var string */
+    private $title;
+
+    /** @var array<string> */
+    private $tags;
+
+    /** @var Url|null */
+    private $imageUrl;
+
+    /** @var Url */
+    private $payUrl;
+
+    /**
+     * @param string|array<string, mixed> $values Json in string or associative array
+     */
+    public function __construct($values)
+    {
+        $data = is_array($values) ? $values : Json::decode($values, true);
+
+        $this->code = $data['code'];
+        $this->title = $data['title'];
+        $this->imageUrl = new Url($data['image']['src']);
+        $this->tags = $data['tags'];
+        $this->payUrl = new Url($data['url']);
+    }
+
+    /** @return string */
+    public function getCode()
+    {
+        return $this->code;
+    }
+
+    /** @return string */
+    public function getTitle()
+    {
+        return $this->title;
+    }
+
+    /** @return Url */
+    public function getImageUrl()
+    {
+        return $this->imageUrl;
+    }
+
+    /** @return Url */
+    public function getPayUrl()
+    {
+        return $this->payUrl;
+    }
+
+    /**
+     * @return array<string>
+     */
+    public function getTags()
+    {
+        return $this->tags;
+    }
+
+    /**
+     * @return array<string, mixed>
+     */
+    public function toArray()
+    {
+        return array(
+            'code' => $this->code,
+            'title' => $this->title,
+            'tags' => $this->tags,
+            'imageUrl' => (string) $this->imageUrl,
+            'payUrl' => (string) $this->payUrl,
+        );
+    }
+}

src/Service/ApiService.php

@@ -15,6 +15,7 @@
 use ThePay\ApiClient\Model\CreatePaymentResponse;
 use ThePay\ApiClient\Model\PaginatedCollectionParams;
 use ThePay\ApiClient\Model\Payment;
+use ThePay\ApiClient\Model\PaymentMethodWithPayUrl;
 use ThePay\ApiClient\Model\PaymentRefund;
 use ThePay\ApiClient\Model\PaymentRefundInfo;
 use ThePay\ApiClient\Model\Project;
@@ -95,7 +96,7 @@ public function getActivePaymentMethods(LanguageCode $languageCode = null)
             $arguments['language'] = $languageCode->getValue();
         }
 
-        $url = $this->url(array('methods'));
+        $url = $this->url(array('methods'), $arguments);
         $response = $this
             ->httpService
             ->get($url);
@@ -420,6 +421,36 @@ public function createPaymentRefund(Identifier $uid, Amount $amount, StringValue
         }
     }
 
+    /**
+     * Returns an array of available payment methods with pay URLs for certain payment.
+     *
+     * @return array<PaymentMethodWithPayUrl>
+     */
+    public function getPaymentUrlsForPayment(Identifier $uid, LanguageCode $languageCode = null)
+    {
+        $arguments = array();
+        if ($languageCode) {
+            $arguments['language'] = $languageCode->getValue();
+        }
+
+        $url = $this->url(array('payments', $uid->getValue(), 'payment_urls'), $arguments);
+        $response = $this->httpService->get($url);
+
+        if ($response->getCode() !== 200) {
+            throw $this->buildException($url, $response);
+        }
+
+        $responseData = Json::decode($response->getBody(), true);
+
+        $paymentMethods = array();
+        foreach ($responseData as $paymentMethod) {
+            $paymentMethods[] = new PaymentMethodWithPayUrl($paymentMethod);
+        }
+
+        return $paymentMethods;
+    }
+
+
 
     /**
      * Build URL for API requests

src/Service/ApiServiceInterface.php

@@ -13,6 +13,7 @@
 use ThePay\ApiClient\Model\CreatePaymentParams;
 use ThePay\ApiClient\Model\CreatePaymentResponse;
 use ThePay\ApiClient\Model\Payment;
+use ThePay\ApiClient\Model\PaymentMethodWithPayUrl;
 use ThePay\ApiClient\Model\PaymentRefundInfo;
 use ThePay\ApiClient\Model\Project;
 use ThePay\ApiClient\Model\RealizeIrregularSubscriptionPaymentParams;
@@ -153,4 +154,11 @@ public function getPaymentRefund(Identifier $uid);
      * @return void
      */
     public function createPaymentRefund(Identifier $uid, Amount $amount, StringValue $reason);
+
+    /**
+     * Returns an array of available payment methods with pay URLs for certain payment.
+     *
+     * @return array<PaymentMethodWithPayUrl>
+     */
+    public function getPaymentUrlsForPayment(Identifier $uid, LanguageCode $languageCode = null);
 }

src/Service/GateService.php

@@ -4,8 +4,11 @@
 
 use ThePay\ApiClient\Model\Collection\PaymentMethodCollection;
 use ThePay\ApiClient\Model\CreatePaymentParams;
+use ThePay\ApiClient\Model\IPaymentMethod;
 use ThePay\ApiClient\Model\PaymentMethod;
 use ThePay\ApiClient\TheConfig;
+use ThePay\ApiClient\ValueObject\Identifier;
+use ThePay\ApiClient\ValueObject\LanguageCode;
 
 /**
  * Class GateService is responsible for rendering payment forms.
@@ -21,8 +24,6 @@ class GateService implements GateServiceInterface
 
     /**
      * @var ApiServiceInterface
-     *
-     * @phpstan-ignore-next-line never read (never mind, backward compatibility is more important)
      */
     private $api;
 
@@ -95,6 +96,7 @@ public function getPaymentButtons(CreatePaymentParams $params, PaymentMethodColl
         }
 
         $result .= '<div class="tp-btn-grid" >';
+        /** @var IPaymentMethod $method */
         foreach ($methods as $method) {
             $btnAttrs['data-payment-method'] = $method->getCode();
             $result .= $this->buildButton($this->getUrlForPayment($paymentData, $method->getCode()), $this->getButtonMethodContent($method), $btnAttrs);
@@ -104,6 +106,27 @@ public function getPaymentButtons(CreatePaymentParams $params, PaymentMethodColl
         return $result;
     }
 
+    /**
+     * @param Identifier $uid UID of payment
+     * @return string HTML
+     */
+    public function getPaymentButtonsForPayment(Identifier $uid, LanguageCode $languageCode = null)
+    {
+        $paymentMethods = $this->api->getPaymentUrlsForPayment($uid, $languageCode);
+        $result = '';
+
+        $btnAttrs = array();
+
+        $result .= '<div class="tp-btn-grid" >';
+        foreach ($paymentMethods as $method) {
+            $btnAttrs['data-payment-method'] = $method->getCode();
+            $result .= $this->buildButton($method->getPayUrl(), $this->getButtonMethodContent($method), $btnAttrs);
+        }
+        $result .= '</div>';
+
+        return $result;
+    }
+
 
     public function getInlineAssets()
     {
@@ -202,10 +225,10 @@ private function buildPaymentDataForm(array $paymentData, array $attributes = ar
 
     /**
      * Returns content of method for button link
-     * @param PaymentMethod $method
+     * @param IPaymentMethod $method
      * @return string HTML
      */
-    private function getButtonMethodContent(PaymentMethod $method)
+    private function getButtonMethodContent(IPaymentMethod $method)
     {
         return '<span class="tp-icon" >'
             . '<img ' . $this->htmlAttributes(array('src' => $method->getImageUrl(), 'alt' => $method->getTitle())) . ' />'

src/Service/GateServiceInterface.php

@@ -5,6 +5,8 @@
 use ThePay\ApiClient\Model\Collection\PaymentMethodCollection;
 use ThePay\ApiClient\Model\CreatePaymentParams;
 use ThePay\ApiClient\TheConfig;
+use ThePay\ApiClient\ValueObject\Identifier;
+use ThePay\ApiClient\ValueObject\LanguageCode;
 
 interface GateServiceInterface
 {
@@ -19,6 +21,12 @@ public function __construct(TheConfig $config, ApiServiceInterface $api);
      */
     public function getPaymentButtons(CreatePaymentParams $params, PaymentMethodCollection $methods);
 
+    /**
+     * @param Identifier $uid UID of payment
+     * @return string HTML
+     */
+    public function getPaymentButtonsForPayment(Identifier $uid, LanguageCode $languageCode = null);
+
     /**
      * @param string $content HTML content of button
      * @param string|null $methodCode