Class: BtcPay::Client::Api::PullPayments

Inherits:

Base

• Object
• Service
• Base
• BtcPay::Client::Api::PullPayments

Defined in:

lib/btcpay/client/api/pull_payments.rb

Constant Summary

PATH =

'pull-payments'

Instance Method Summary

• #create_payout(pull_payment_id, payload, **opts) ⇒ Object
• #get(pull_payment_id, **opts) ⇒ Object (also: #find)
• #payouts(pull_payment_id, **opts) ⇒ Object

Methods inherited from Service

#initialize

Constructor Details

This class inherits a constructor from BtcPay::Client::Service

Instance Method Details

#create_payout(pull_payment_id, payload, **opts) ⇒ Object

See Also:

• https://docs.btcpayserver.org/API/Greenfield/v1/#tag/Pull-payments-(Public)/paths/~1api~1v1~1pull-payments~1{pullPaymentId}~1payouts/post

# File 'lib/btcpay/client/api/pull_payments.rb', line 22

def create_payout(pull_payment_id, payload, **opts)
  client.post(path(pull_payment_id, 'payouts'), payload: payload, options: opts)
end

#get(pull_payment_id, **opts) ⇒ Object Also known as: find

See Also:

• https://docs.btcpayserver.org/API/Greenfield/v1/#tag/Pull-payments-(Public)/paths/~1api~1v1~1pull-payments~1{pullPaymentId}/get

# File 'lib/btcpay/client/api/pull_payments.rb', line 10

def get(pull_payment_id, **opts)
  client.get(path(pull_payment_id), options: opts)
end

#payouts(pull_payment_id, **opts) ⇒ Object

See Also:

• https://docs.btcpayserver.org/API/Greenfield/v1/#tag/Pull-payments-(Public)/paths/~1api~1v1~1pull-payments~1{pullPaymentId}~1payouts/get

# File 'lib/btcpay/client/api/pull_payments.rb', line 17

def payouts(pull_payment_id, **opts)
  client.get(path(pull_payment_id, 'payouts'), options: opts)
end