Sha256: 91efa97016fae3a11514d20e54f29a38fe387971eaf5c6d88f8fa5aa012d05df

Contents?: true

Size: 1.35 KB

Versions: 7

Compression:

Stored size: 1.35 KB

Contents

# frozen_string_literal: true

module PaypalAPI
  #
  # Captured payments APIs `/v2/payments/captures`
  #
  # @see https://developer.paypal.com/docs/api/payments/v2
  #
  class CapturedPayments < APICollection
    #
    # Common class and instance methods
    #
    module APIs
      # @!macro [new] request
      #   @param query [Hash, nil] Request query parameters
      #   @param body [Hash, nil] Request body parameters
      #   @param headers [Hash, nil] Request headers
      #   @return [Response] Response object

      #
      # Show captured payment details
      #
      # @see https://developer.paypal.com/docs/api/payments/v2/#captures_get
      #
      # @param capture_id [String] Capture ID
      # @macro request
      #
      def show(capture_id, query: nil, body: nil, headers: nil)
        client.get("/v2/payments/captures/#{encode(capture_id)}", query: query, body: body, headers: headers)
      end

      #
      # Refund captured payment
      #
      # @see https://developer.paypal.com/docs/api/payments/v2/#captures_refund
      #
      # @param capture_id [String] Capture ID
      # @macro request
      #
      def refund(capture_id, query: nil, body: nil, headers: nil)
        client.post("/v2/payments/captures/#{encode(capture_id)}/refund", query: query, body: body, headers: headers)
      end
    end

    include APIs
    extend APIs
  end
end

Version data entries

7 entries across 7 versions & 1 rubygems

Version Path
paypal-rest-api-0.3.1 lib/paypal-api/api_collections/captured_payments.rb
paypal-rest-api-0.3.0 lib/paypal-api/api_collections/captured_payments.rb
paypal-rest-api-0.2.1 lib/paypal-api/api_collections/captured_payments.rb
paypal-rest-api-0.2.0 lib/paypal-api/api_collections/captured_payments.rb
paypal-rest-api-0.1.1 lib/paypal-api/api_collections/captured_payments.rb
paypal-rest-api-0.1.0 lib/paypal-api/api_collections/captured_payments.rb
paypal-rest-api-0.0.4 lib/paypal-api/api_collections/captured_payments.rb