No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download

README.md

Build Status Coverage Status Code Climate Gem Version Dependency Status

Ruby Yandex.Money API SDK

Requirements

Supported ruby versions: 1.9.3, 2.0, 2.1, jruby, rbx-2

Links

  1. Yandex.Money API page: Ru, En

Getting started

Installation

Add this line to your Gemfile:

gem 'yandex-money-sdk'

And then execute:

bundle

Or install it manually with:

gem install yandex-money-sdk

Next, require it in application:

require 'yandex_money/api'

Payments from the Yandex.Money wallet

Using Yandex.Money API requires following steps

  1. Obtain token URL and redirect user's browser to Yandex.Money service. Note: client_id, redirect_uri, client_secret are constants that you get, when register app in Yandex.Money API.

    auth_url = YandexMoney::Wallet.build_obtain_token_url(
      CLIENT_ID,
      REDIRECT_URI,
      "account-info operation-history" # SCOPE
    )
  2. After that, user fills Yandex.Money HTML form and user is redirected back to REDIRECT_URI?code=CODE.

  3. You should immediately exchange CODE with ACCESS_TOKEN.

    access_token = YandexMoney::Wallet.get_access_token(
      CLIENT_ID,
      CODE,
      REDIRECT_URI
    )
    # or, if client secret defined:
    access_token = YandexMoney::Wallet.get_access_token(
      CLIENT_ID,
      CODE,
      REDIRECT_URI,
      CLIENT_SECRET
    )

    If access_token couldn't be obtained, YandexMoney::ApiError expection will be raised.

  4. Now you can use Yandex.Money API.

    api = YandexMoney::Wallet.new(access_token)
    account_info = api.account_info
    balance = account_info.balance # and so on
    
    request_options = {
        "pattern_id": "p2p",
        "to": "410011161616877",
        "amount_due": "0.02",
        "comment": "test payment comment from yandex-money-python",
        "message": "test payment message from yandex-money-python",
        "label": "testPayment",
        "test_payment": true,
        "test_result": "success"
    };
    request_result = api.request_payment(request_options)
    # check status
    
    process_payment = api.process_payment({
        request_id: request_result.request_id,
    })
    # check result
    if process_payment.status == "success"
      # show success page
    else
      # something went wrong
    end

Payments from bank cards without authorization

  1. Fetch instantce-id(ussually only once for every client. You can store result in DB).

    instance_id = YandexMoney::ExternalPayment.get_instance_id(CLIENT_ID)
  2. Make request payment

    api = YandexMoney::ExternalPayment.new(INSTANCE_ID)
    response = api.request_external_payment({
      pattern_id: "p2p",
      to: "410011285611534",
      amount_due: "1.00",
      message: "test"
    })
    if response.status == "success"
      request_id = response.request_id
    else
      # throw exception
    end
  3. Process the request with process-payment.

    api = YandexMoney::ExternalPayment.new(INSTANCE_ID)
    result = api.process_external_payment({
      request_id: REQUEST_ID,
      ext_auth_success_uri: "http://example.com/success",
      ext_auth_fail_uri: "http://example.com/fail"
    })
    # process result according to docs

Running tests

Fill values in spec/support/constants.rb file (example could be found in spec/support/constants.example.rb) and after this just run tests with bundle exec rake command.