Class: Onlyfans::Resources::Banking::Details

Inherits:
Object
  • Object
show all
Defined in:
lib/onlyfans/resources/banking/details.rb

Overview

Operations related to user banking details, payout methods, legal and tax information, and account country settings.

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Details

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Details.

Parameters:



122
123
124
 
# File 'lib/onlyfans/resources/banking/details.rb', line 122

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve_account_country_details(account, request_options: {}) ⇒ Onlyfans::Models::Banking::DetailRetrieveAccountCountryDetailsResponse

Returns the account owner’s country details for banking, including country code, name, whether the country has states and zip codes, payout eligibility, and W9 form availability.

Parameters:

Returns:

See Also:



22
23
24
25
26
27
28
29
 
# File 'lib/onlyfans/resources/banking/details.rb', line 22

def (, params = {})
  @client.request(
    method: :get,
    path: ["api/%1$s/banking/details/account-country", ],
    model: Onlyfans::Models::Banking::DetailRetrieveAccountCountryDetailsResponse,
    options: params[:request_options]
  )
end

#retrieve_bank_details(account, request_options: {}) ⇒ Onlyfans::Models::Banking::DetailRetrieveBankDetailsResponse

Returns the account owner’s bank payout details, including whether payout data is filled, available payout methods with their descriptions, and required bank fields.

Parameters:

Returns:

See Also:



44
45
46
47
48
49
50
51
 
# File 'lib/onlyfans/resources/banking/details.rb', line 44

def retrieve_bank_details(, params = {})
  @client.request(
    method: :get,
    path: ["api/%1$s/banking/details/bank", ],
    model: Onlyfans::Models::Banking::DetailRetrieveBankDetailsResponse,
    options: params[:request_options]
  )
end

#retrieve_dac7_form_details(account, request_options: {}) ⇒ Onlyfans::Models::Banking::DetailRetrieveDac7FormDetailsResponse

If available, returns the account owner’s DAC7 form information required for tax reporting, including personal details, address, tax identification, country information, and DAC7 status.

Parameters:

Returns:

See Also:



66
67
68
69
70
71
72
73
 
# File 'lib/onlyfans/resources/banking/details.rb', line 66

def retrieve_dac7_form_details(, params = {})
  @client.request(
    method: :get,
    path: ["api/%1$s/banking/details/dac7-form", ],
    model: Onlyfans::Models::Banking::DetailRetrieveDac7FormDetailsResponse,
    options: params[:request_options]
  )
end

#retrieve_legal_and_tax_status(account, request_options: {}) ⇒ Onlyfans::Models::Banking::DetailRetrieveLegalAndTaxStatusResponse

Returns the account owner’s legal and tax status required for banking and payout configuration, including W9 requirements, identity verification status, DAC7 compliance, and tax information.

Parameters:

Returns:

See Also:



88
89
90
91
92
93
94
95
 
# File 'lib/onlyfans/resources/banking/details.rb', line 88

def retrieve_legal_and_tax_status(, params = {})
  @client.request(
    method: :get,
    path: ["api/%1$s/banking/details/legal-info", ],
    model: Onlyfans::Models::Banking::DetailRetrieveLegalAndTaxStatusResponse,
    options: params[:request_options]
  )
end

#retrieve_legal_form_details(account, request_options: {}) ⇒ Onlyfans::Models::Banking::DetailRetrieveLegalFormDetailsResponse

Returns the account owner’s legal form details for banking, including personal or business name, address, social media links, date of birth, and available document types for identity verification.

Parameters:

Returns:

See Also:



110
111
112
113
114
115
116
117
 
# File 'lib/onlyfans/resources/banking/details.rb', line 110

def retrieve_legal_form_details(, params = {})
  @client.request(
    method: :get,
    path: ["api/%1$s/banking/details/legal-form", ],
    model: Onlyfans::Models::Banking::DetailRetrieveLegalFormDetailsResponse,
    options: params[:request_options]
  )
end