Module: PaypalAPI::PayoutItems::APIs

Included in:

PaypalAPI::PayoutItems, PaypalAPI::PayoutItems

Defined in:

lib/paypal-api/api_collections/payout_items.rb

Overview

Common methods for PaypalAPI::PayoutItems class and client.payout_items instance

Instance Method Summary

• #cancel(payout_item_id, query: nil, body: nil, headers: nil) ⇒ Response

  Cancel unclaimed payout item.

• #show(payout_item_id, query: nil, body: nil, headers: nil) ⇒ Response

  Show payout item details.

Instance Method Details

#cancel(payout_item_id, query: nil, body: nil, headers: nil) ⇒ Response

Cancel unclaimed payout item

Parameters:

• payout_item_id (String) —

  The ID of the payout item to cancel

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/payments.payouts-batch/v1/#payouts-item_cancel

# File 'lib/paypal-api/api_collections/payout_items.rb', line 27

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_id, query: nil, body: nil, headers: nil) ⇒ Response

Show payout item details

Parameters:

• payout_item_id (String) —

  The ID of the payout item

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/payments.payouts-batch/v1/#payouts-item_get

# File 'lib/paypal-api/api_collections/payout_items.rb', line 39

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