Module: PaypalAPI::Payouts::APIs

Included in:

PaypalAPI::Payouts, PaypalAPI::Payouts

Defined in:

lib/paypal-api/api_collections/payouts.rb

Overview

Common methods for PaypalAPI::Payouts class and client.payouts instance

Instance Method Summary

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

  Create batch payout.

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

  Show payout batch details.

Instance Method Details

#create(query: nil, body: nil, headers: nil) ⇒ Response

Create batch payout

Parameters:

• 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_post

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

def create(query: nil, body: nil, headers: nil)
  client.post("/v1/payments/payouts", query: query, body: body, headers: headers)
end

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

Show payout batch details

Parameters:

• payout_batch_id (String) —

  The ID of the payout for which to show details.

• 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_get

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

def show(payout_batch_id, query: nil, body: nil, headers: nil)
  client.get("/v1/payments/payouts/#{encode(payout_batch_id)}", query: query, body: body, headers: headers)
end