Subscription Yöntemi

Bir müşteri bu yöntemi seçtiğinde, sepetinde bulunan ne kadar periyodik ürün/hizmet varsa otomatik yenileme özelliği için etkinleştirilmiş olacaktır.

"Subscription" yöntemi "Third Party" ve "Merchant" yöntemleri ile aynı çalışmaktadır. Ek olarak sepetteki her bir öge için abonelik kimliği tanımlanmaktadır.

Abonelik Kimliği Atamak

Aşağıda belirtilen örnek kodu "capture", "area" , "callback" işlevlerinde kullanabilirsiniz. Abonelik kimliği, “Yönetim Paneli > Ürün/Hizmet Detay” sayfasında görünecektir.

if($items = $this->subscribable_items())
{
    $subscribed = [];
    foreach($items AS $item)
        $subscribed[$item['identifier']] = 'Here Subscription ID';
    if($subscribed) $this->set_subscribed_items($subscribed);
}

"subscribable_items" işlevinden dönen değer bir dizi döngüsüdür. Parametreler aşağıda belirlenmiştir:

"set_subscribed_items"işlevi ile satın alınan hizmetlere abonelik kimliği tanımlanır. Gönderilecek parametre bir dizi olmalıdır. Dizinin anahtar değerine "subscribable_items" işlevinden geri dönen dizi döngüsünde elde ettiğiniz "identifier" değerini tanımlayın. Daha sonra dizinin değerine ödeme hizmeti sağlayıcısından elde ettiğiniz "abone kimlik numarasını" tanımlayın.

Değişkenler

Aşağıda belirtilen parametreler "get_subscription" , "cancel_subscription" , "change_subscription_fee" , "capture_subscription", işlevlerinde kullanılmaktadır.

Abonelik Durumu

Aboneliğin durumu, tarihi ve ödenen tutar hakkında güncel bilgi edinmek için "get_subscription" işlevi kullanılır. Eğer bir hizmete abonelik kimliği tanımlanmışsa, işlevin kullanılması zorunludur.

Örnek

public function get_subscription($params=[])
{
    $sub_id             = $params["identifier"];

    /*
     * From here, you can send an API command to the payment service provider and report the status of the subscription according to the response you receive.
     */

    return [
        'status'            => 'active',
        'status_msg'        => '',
        'first_paid'        => [
            'time'              => '2021-07-01 13:00:00',
            'fee'               => [
                'amount'    => 15,
                'currency'  => 'USD',
            ],
        ],
        'last_paid'         => [
            'time'          => '2021-08-01 13:00:00',
            'fee'           => [
                'amount'    => 15,
                'currency'  => 'USD',
            ],
        ],
        'next_payable'      => [
            'time'              => '2021-09-01 13:00:00',
            'fee'               => [
                'amount'            => 15,
                'currency'          => 'USD',
            ],
        ],
        'failed_payments'   => 0,
    ];

}

Yanıt

"get_subscription" işlevinden geri döndürülmesi gereken parametreler aşağıda açıklanmıştır:

Ödeme Tahsil Etmek

Eğer ödeme hizmeti sağlayıcınız ödeme tahsil etme özelliğini destekliyorsa, gününde ödenmeyen abonelikleri "capture_subscription" işlevi sayesinde tetikleyebilir ve hemen ödeme işlemi yürütebilirsiniz.

Örnek

İşleve gönderilen parametreler yukarıdaki "Değişkenler" bölümüne açıklanmıştır.

public function capture_subscription($params=[])
{
    $sub_id     = $params["identifier"];
    $amount     = $params["next_payable_fee"];
    $curr       = $params["currency"];

    $request_fields        = [
        'note'          => 'pay the remaining balance',
        'currency'      => $this->currency($curr),
        'amount'        => $amount,
    ];

    $request            = "failed";

    if($request == "failed")
    {
        $this->error = 'Payment cannot be captured.';
        return false;
    }

    return true;
}

Yanıt

Geri döndürülmesi gereken yanıt bir "boolean" olmalıdır.

Abonelik Ücreti Güncelleme

Eğer ödeme hizmeti sağlayıcınız abonelik ücretini güncellemeyi destekliyorsa, "change_subscription_fee" işlevini kullanabilirsiniz.

Ürünlere uygulanan ücret değişiklikleri ve döviz kurundaki değişikliklerden dolayı aboneliğin ücret bilgisi bu işlev sayesinde güncellenebilmektedir.

Abonelikteki her bir "öğe/kalem" için işlev çalıştırılmaktadır.

Örnek

$params > değişken içeriği Değişkenler başlığında açıklanmıştır. (array)
$value > tutar bilgisi (float)
$currency > para birimi kimliği (int)

public function change_subscription_fee($params=[],$value = 0,$currency=0)
{
    $sub_id     = $params["identifier"];

    $request_fields    = [
        'sub_id'        => $sub_id,
        'amount'        => $value,
        'currency'      => $this->currency($currency),
    ];

    $request            = 'failed';

    if($request == 'failed')
    {
        $this->error = 'The subscription fee cannot change.';
        return false;
    }

    return true;
}

Yanıt

Geri döndürülmesi gereken yanıt bir "boolean" veri türü olmalıdır.

Abonelik İptali

Aboneliğin iptal edilmesi durumunda "cancel_subscription" işlevi tetiklenmektedir.

Örnek

İşleve gönderilen parametreler yukarıdaki "Değişkenler" bölümüne açıklanmıştır.

public function cancel_subscription($params=[])
{
    $sub_id = $params["identifier"];

    /*
     * From here you can send an API command to the payment service provider and, based on the response you receive, report the subscription cancellation.
     */
    $request = 'CRITICAL ERROR';

    if($request == 'CRITICAL ERROR')
    {
        $this->error = 'Subscription cannot be cancelled.';
        return false;
    }
    return true;
}

Yanıt

Geri döndürülmesi gereken yanıt bir "boolean" veri türü olmalıdır.