Sha256: ec2f1a65f81d450fe7a956e6e911c1e97f6af39062aab4da2c73f18d729c34b1

Contents?: true

Size: 1.47 KB

Versions: 7

Compression:

Stored size: 1.47 KB

Contents

# frozen_string_literal: true

module PaypalAPI
  #
  # Makes payments to multiple PayPal or Venmo recipients
  #
  # @see https://developer.paypal.com/docs/api/payments.payouts-batch/v1/
  #
  class PayoutItems < 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

      #
      # Cancel unclaimed payout item
      #
      # @see https://developer.paypal.com/docs/api/payments.payouts-batch/v1/#payouts-item_cancel
      # @param payout_item_id [String] The ID of the payout item to cancel
      # @macro request
      #
      def cancel(payout_item_id, query: nil, body: nil, headers: nil)
        client.post("/v1/payments/payouts-item/#{encode(payout_item_id)}/cancel", query: query, body: body, headers: headers)
      end

      #
      # Show payout item details
      #
      # @see https://developer.paypal.com/docs/api/payments.payouts-batch/v1/#payouts-item_get
      #
      # @param payout_item_id [String] The ID of the payout item
      # @macro request
      #
      def show(payout_item_id, query: nil, body: nil, headers: nil)
        client.get("/v1/payments/payouts-item/#{encode(payout_item_id)}", 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/payout_items.rb
paypal-rest-api-0.3.0 lib/paypal-api/api_collections/payout_items.rb
paypal-rest-api-0.2.1 lib/paypal-api/api_collections/payout_items.rb
paypal-rest-api-0.2.0 lib/paypal-api/api_collections/payout_items.rb
paypal-rest-api-0.1.1 lib/paypal-api/api_collections/payout_items.rb
paypal-rest-api-0.1.0 lib/paypal-api/api_collections/payout_items.rb
paypal-rest-api-0.0.4 lib/paypal-api/api_collections/payout_items.rb