Payment

Overview

Available Operations

create_payment_link - Create a link
create_payment_payment - Create a payment
get_payment_link - Retrieve a link
get_payment_payment - Retrieve a payment
get_payment_payout - Retrieve a payout
get_payment_refund - Retrieve a refund
list_payment_links - List all links
list_payment_payments - List all payments
list_payment_payouts - List all payouts
list_payment_refunds - List all refunds
patch_payment_link - Update a link
patch_payment_payment - Update a payment
remove_payment_link - Remove a link
remove_payment_payment - Remove a payment
update_payment_link - Update a link
update_payment_payment - Update a payment

create_payment_link

Create a link

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.payment.create_payment_link(connection_id="<value>", payment_link=::UnifiedRubySDK::Shared::PaymentLink.new(), fields_=[
    "<value>",
  ])

if ! res.payment_link.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`payment_link`	::UnifiedRubySDK::Shared::PaymentLink	➖	N/A
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::CreatePaymentLinkResponse)

create_payment_payment

Create a payment

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.payment.create_payment_payment(connection_id="<value>", payment_payment=::UnifiedRubySDK::Shared::PaymentPayment.new(), fields_=[
    "<value>",
  ])

if ! res.payment_payment.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`payment_payment`	::UnifiedRubySDK::Shared::PaymentPayment	➖	N/A
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::CreatePaymentPaymentResponse)

get_payment_link

Retrieve a link

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.payment.get_payment_link(connection_id="<value>", id="<value>", fields_=[
    "<value>",
  ])

if ! res.payment_link.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Link
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::GetPaymentLinkResponse)

get_payment_payment

Retrieve a payment

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.payment.get_payment_payment(connection_id="<value>", id="<value>", fields_=[
    "<value>",
  ])

if ! res.payment_payment.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Payment
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::GetPaymentPaymentResponse)

get_payment_payout

Retrieve a payout

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.payment.get_payment_payout(connection_id="<value>", id="<value>", fields_=[
    "<value>",
  ])

if ! res.payment_payout.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Payout
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::GetPaymentPayoutResponse)

get_payment_refund

Retrieve a refund

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.payment.get_payment_refund(connection_id="<value>", id="<value>", fields_=[
    "<value>",
  ])

if ! res.payment_refund.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Refund
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::GetPaymentRefundResponse)

list_payment_links

List all links

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)


req = ::UnifiedRubySDK::Operations::ListPaymentLinksRequest.new(
  connection_id: "<value>",
)
    
res = s.payment.list_payment_links(req)

if ! res.payment_links.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	::UnifiedRubySDK::Operations::ListPaymentLinksRequest	✔️	The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListPaymentLinksResponse)

list_payment_payments

List all payments

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)


req = ::UnifiedRubySDK::Operations::ListPaymentPaymentsRequest.new(
  connection_id: "<value>",
)
    
res = s.payment.list_payment_payments(req)

if ! res.payment_payments.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	::UnifiedRubySDK::Operations::ListPaymentPaymentsRequest	✔️	The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListPaymentPaymentsResponse)

list_payment_payouts

List all payouts

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)


req = ::UnifiedRubySDK::Operations::ListPaymentPayoutsRequest.new(
  connection_id: "<value>",
)
    
res = s.payment.list_payment_payouts(req)

if ! res.payment_payouts.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	::UnifiedRubySDK::Operations::ListPaymentPayoutsRequest	✔️	The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListPaymentPayoutsResponse)

list_payment_refunds

List all refunds

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)


req = ::UnifiedRubySDK::Operations::ListPaymentRefundsRequest.new(
  connection_id: "<value>",
)
    
res = s.payment.list_payment_refunds(req)

if ! res.payment_refunds.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	::UnifiedRubySDK::Operations::ListPaymentRefundsRequest	✔️	The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListPaymentRefundsResponse)

patch_payment_link

Update a link

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.payment.patch_payment_link(connection_id="<value>", id="<value>", payment_link=::UnifiedRubySDK::Shared::PaymentLink.new(), fields_=[
    "<value>",
  ])

if ! res.payment_link.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Link
`payment_link`	::UnifiedRubySDK::Shared::PaymentLink	➖	N/A
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::PatchPaymentLinkResponse)

patch_payment_payment

Update a payment

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.payment.patch_payment_payment(connection_id="<value>", id="<value>", payment_payment=::UnifiedRubySDK::Shared::PaymentPayment.new(), fields_=[
    "<value>",
  ])

if ! res.payment_payment.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Payment
`payment_payment`	::UnifiedRubySDK::Shared::PaymentPayment	➖	N/A
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::PatchPaymentPaymentResponse)

remove_payment_link

Remove a link

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.payment.remove_payment_link(connection_id="<value>", id="<value>")

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Link

Response

T.nilable(::UnifiedRubySDK::Operations::RemovePaymentLinkResponse)

remove_payment_payment

Remove a payment

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.payment.remove_payment_payment(connection_id="<value>", id="<value>")

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Payment

Response

T.nilable(::UnifiedRubySDK::Operations::RemovePaymentPaymentResponse)

update_payment_link

Update a link

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.payment.update_payment_link(connection_id="<value>", id="<value>", payment_link=::UnifiedRubySDK::Shared::PaymentLink.new(), fields_=[
    "<value>",
  ])

if ! res.payment_link.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Link
`payment_link`	::UnifiedRubySDK::Shared::PaymentLink	➖	N/A
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::UpdatePaymentLinkResponse)

update_payment_payment

Update a payment

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.payment.update_payment_payment(connection_id="<value>", id="<value>", payment_payment=::UnifiedRubySDK::Shared::PaymentPayment.new(), fields_=[
    "<value>",
  ])

if ! res.payment_payment.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Payment
`payment_payment`	::UnifiedRubySDK::Shared::PaymentPayment	➖	N/A
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::UpdatePaymentPaymentResponse)

Files

README.md

Latest commit

History

README.md

File metadata and controls

Payment

Overview

Available Operations

create_payment_link

Example Usage

Parameters

Response

create_payment_payment

Example Usage

Parameters

Response

get_payment_link

Example Usage

Parameters

Response

get_payment_payment

Example Usage

Parameters

Response

get_payment_payout

Example Usage

Parameters

Response

get_payment_refund

Example Usage

Parameters

Response

list_payment_links

Example Usage

Parameters

Response

list_payment_payments

Example Usage

Parameters

Response

list_payment_payouts

Example Usage

Parameters

Response

list_payment_refunds

Example Usage

Parameters

Response

patch_payment_link

Example Usage

Parameters

Response

patch_payment_payment

Example Usage

Parameters

Response

remove_payment_link

Example Usage

Parameters

Response

remove_payment_payment

Example Usage

Parameters

Response

update_payment_link

Example Usage

Parameters

Response

update_payment_payment

Example Usage

Parameters

Response