vendor/stripe/stripe-php/lib/Service/AccountService.php line 403

Open in your IDE?
  1. <?php
  3. // File generated from our OpenAPI spec
  5. namespace Stripe\Service;
  7. /**
  8.  * @phpstan-import-type RequestOptionsArray from \Stripe\Util\RequestOptions
  9.  *
  10.  * @psalm-import-type RequestOptionsArray from \Stripe\Util\RequestOptions
  11.  */
  12. class AccountService extends AbstractService
  13. {
  14.     /**
  15.      * Returns a list of accounts connected to your platform via <a
  16.      * href="/docs/connect">Connect</a>. If you’re not a platform, the list is empty.
  17.      *
  18.      * @param null|array{created?: array|int, ending_before?: string, expand?: string[], limit?: int, starting_after?: string} $params
  19.      * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  20.      *
  21.      * @return \Stripe\Collection<\Stripe\Account>
  22.      *
  23.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  24.      */
  25.     public function all($params = null, $opts = null)
  26.     {
  27.         return $this->requestCollection('get', '/v1/accounts', $params, $opts);
  28.     }
  30.     /**
  31.      * Returns a list of capabilities associated with the account. The capabilities are
  32.      * returned sorted by creation date, with the most recent capability appearing
  33.      * first.
  34.      *
  35.      * @param string $parentId
  36.      * @param null|array{expand?: string[]} $params
  37.      * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  38.      *
  39.      * @return \Stripe\Collection<\Stripe\Capability>
  40.      *
  41.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  42.      */
  43.     public function allCapabilities($parentId, $params = null, $opts = null)
  44.     {
  45.         return $this->requestCollection('get', $this->buildPath('/v1/accounts/%s/capabilities', $parentId), $params, $opts);
  46.     }
  48.     /**
  49.      * List external accounts for an account.
  50.      *
  51.      * @param string $parentId
  52.      * @param null|array{ending_before?: string, expand?: string[], limit?: int, object?: string, starting_after?: string} $params
  53.      * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  54.      *
  55.      * @return \Stripe\Collection<\Stripe\BankAccount|\Stripe\Card>
  56.      *
  57.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  58.      */
  59.     public function allExternalAccounts($parentId, $params = null, $opts = null)
  60.     {
  61.         return $this->requestCollection('get', $this->buildPath('/v1/accounts/%s/external_accounts', $parentId), $params, $opts);
  62.     }
  64.     /**
  65.      * Returns a list of people associated with the account’s legal entity. The people
  66.      * are returned sorted by creation date, with the most recent people appearing
  67.      * first.
  68.      *
  69.      * @param string $parentId
  70.      * @param null|array{ending_before?: string, expand?: string[], limit?: int, relationship?: array{authorizer?: bool, director?: bool, executive?: bool, legal_guardian?: bool, owner?: bool, representative?: bool}, starting_after?: string} $params
  71.      * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  72.      *
  73.      * @return \Stripe\Collection<\Stripe\Person>
  74.      *
  75.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  76.      */
  77.     public function allPersons($parentId, $params = null, $opts = null)
  78.     {
  79.         return $this->requestCollection('get', $this->buildPath('/v1/accounts/%s/persons', $parentId), $params, $opts);
  80.     }
  82.     /**
  83.      * With <a href="/docs/connect">Connect</a>, you can create Stripe accounts for
  84.      * your users. To do this, you’ll first need to <a
  85.      * href="https://dashboard.stripe.com/account/applications/settings">register your
  86.      * platform</a>.
  87.      *
  88.      * If you’ve already collected information for your connected accounts, you <a
  89.      * href="/docs/connect/best-practices#onboarding">can prefill that information</a>
  90.      * when creating the account. Connect Onboarding won’t ask for the prefilled
  91.      * information during account onboarding. You can prefill any information on the
  92.      * account.
  93.      *
  94.      * @param null|array{account_token?: string, business_profile?: array{annual_revenue?: array{amount: int, currency: string, fiscal_year_end: string}, estimated_worker_count?: int, mcc?: string, minority_owned_business_designation?: string[], monthly_estimated_revenue?: array{amount: int, currency: string}, name?: string, product_description?: string, support_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, support_email?: string, support_phone?: string, support_url?: null|string, url?: string}, business_type?: string, capabilities?: array{acss_debit_payments?: array{requested?: bool}, affirm_payments?: array{requested?: bool}, afterpay_clearpay_payments?: array{requested?: bool}, alma_payments?: array{requested?: bool}, amazon_pay_payments?: array{requested?: bool}, au_becs_debit_payments?: array{requested?: bool}, bacs_debit_payments?: array{requested?: bool}, bancontact_payments?: array{requested?: bool}, bank_transfer_payments?: array{requested?: bool}, billie_payments?: array{requested?: bool}, blik_payments?: array{requested?: bool}, boleto_payments?: array{requested?: bool}, card_issuing?: array{requested?: bool}, card_payments?: array{requested?: bool}, cartes_bancaires_payments?: array{requested?: bool}, cashapp_payments?: array{requested?: bool}, crypto_payments?: array{requested?: bool}, eps_payments?: array{requested?: bool}, fpx_payments?: array{requested?: bool}, gb_bank_transfer_payments?: array{requested?: bool}, giropay_payments?: array{requested?: bool}, grabpay_payments?: array{requested?: bool}, ideal_payments?: array{requested?: bool}, india_international_payments?: array{requested?: bool}, jcb_payments?: array{requested?: bool}, jp_bank_transfer_payments?: array{requested?: bool}, kakao_pay_payments?: array{requested?: bool}, klarna_payments?: array{requested?: bool}, konbini_payments?: array{requested?: bool}, kr_card_payments?: array{requested?: bool}, legacy_payments?: array{requested?: bool}, link_payments?: array{requested?: bool}, mobilepay_payments?: array{requested?: bool}, multibanco_payments?: array{requested?: bool}, mx_bank_transfer_payments?: array{requested?: bool}, naver_pay_payments?: array{requested?: bool}, nz_bank_account_becs_debit_payments?: array{requested?: bool}, oxxo_payments?: array{requested?: bool}, p24_payments?: array{requested?: bool}, pay_by_bank_payments?: array{requested?: bool}, payco_payments?: array{requested?: bool}, paynow_payments?: array{requested?: bool}, pix_payments?: array{requested?: bool}, promptpay_payments?: array{requested?: bool}, revolut_pay_payments?: array{requested?: bool}, samsung_pay_payments?: array{requested?: bool}, satispay_payments?: array{requested?: bool}, sepa_bank_transfer_payments?: array{requested?: bool}, sepa_debit_payments?: array{requested?: bool}, sofort_payments?: array{requested?: bool}, swish_payments?: array{requested?: bool}, tax_reporting_us_1099_k?: array{requested?: bool}, tax_reporting_us_1099_misc?: array{requested?: bool}, transfers?: array{requested?: bool}, treasury?: array{requested?: bool}, twint_payments?: array{requested?: bool}, us_bank_account_ach_payments?: array{requested?: bool}, us_bank_transfer_payments?: array{requested?: bool}, zip_payments?: array{requested?: bool}}, company?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, directors_provided?: bool, directorship_declaration?: array{date?: int, ip?: string, user_agent?: string}, executives_provided?: bool, export_license_id?: string, export_purpose_code?: string, name?: string, name_kana?: string, name_kanji?: string, owners_provided?: bool, ownership_declaration?: array{date?: int, ip?: string, user_agent?: string}, ownership_exemption_reason?: null|string, phone?: string, registration_date?: null|array{day: int, month: int, year: int}, registration_number?: string, structure?: null|string, tax_id?: string, tax_id_registrar?: string, vat_id?: string, verification?: array{document?: array{back?: string, front?: string}}}, controller?: array{fees?: array{payer?: string}, losses?: array{payments?: string}, requirement_collection?: string, stripe_dashboard?: array{type?: string}}, country?: string, default_currency?: string, documents?: array{bank_account_ownership_verification?: array{files?: string[]}, company_license?: array{files?: string[]}, company_memorandum_of_association?: array{files?: string[]}, company_ministerial_decree?: array{files?: string[]}, company_registration_verification?: array{files?: string[]}, company_tax_id_verification?: array{files?: string[]}, proof_of_address?: array{files?: string[]}, proof_of_registration?: array{files?: string[]}, proof_of_ultimate_beneficial_ownership?: array{files?: string[]}}, email?: string, expand?: string[], external_account?: array|string, groups?: array{payments_pricing?: null|string}, individual?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, dob?: null|array{day: int, month: int, year: int}, email?: string, first_name?: string, first_name_kana?: string, first_name_kanji?: string, full_name_aliases?: null|string[], gender?: string, id_number?: string, id_number_secondary?: string, last_name?: string, last_name_kana?: string, last_name_kanji?: string, maiden_name?: string, metadata?: null|array<string, string>, phone?: string, political_exposure?: string, registered_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, relationship?: array{director?: bool, executive?: bool, owner?: bool, percent_ownership?: null|float, title?: string}, ssn_last_4?: string, verification?: array{additional_document?: array{back?: string, front?: string}, document?: array{back?: string, front?: string}}}, metadata?: null|array<string, string>, settings?: array{bacs_debit_payments?: array{display_name?: string}, branding?: array{icon?: string, logo?: string, primary_color?: string, secondary_color?: string}, card_issuing?: array{tos_acceptance?: array{date?: int, ip?: string, user_agent?: null|string}}, card_payments?: array{decline_on?: array{avs_failure?: bool, cvc_failure?: bool}, statement_descriptor_prefix?: string, statement_descriptor_prefix_kana?: null|string, statement_descriptor_prefix_kanji?: null|string}, invoices?: array{hosted_payment_method_save?: string}, payments?: array{statement_descriptor?: string, statement_descriptor_kana?: string, statement_descriptor_kanji?: string}, payouts?: array{debit_negative_balances?: bool, schedule?: array{delay_days?: array|int|string, interval?: string, monthly_anchor?: int, monthly_payout_days?: int[], weekly_anchor?: string, weekly_payout_days?: string[]}, statement_descriptor?: string}, treasury?: array{tos_acceptance?: array{date?: int, ip?: string, user_agent?: null|string}}}, tos_acceptance?: array{date?: int, ip?: string, service_agreement?: string, user_agent?: string}, type?: string} $params
  95.      * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  96.      *
  97.      * @return \Stripe\Account
  98.      *
  99.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  100.      */
  101.     public function create($params = null, $opts = null)
  102.     {
  103.         return $this->request('post', '/v1/accounts', $params, $opts);
  104.     }
  106.     /**
  107.      * Create an external account for a given account.
  108.      *
  109.      * @param string $parentId
  110.      * @param null|array{default_for_currency?: bool, expand?: string[], external_account: array|string, metadata?: array<string, string>} $params
  111.      * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  112.      *
  113.      * @return \Stripe\BankAccount|\Stripe\Card
  114.      *
  115.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  116.      */
  117.     public function createExternalAccount($parentId, $params = null, $opts = null)
  118.     {
  119.         return $this->request('post', $this->buildPath('/v1/accounts/%s/external_accounts', $parentId), $params, $opts);
  120.     }
  122.     /**
  123.      * Creates a login link for a connected account to access the Express Dashboard.
  124.      *
  125.      * <strong>You can only create login links for accounts that use the <a
  126.      * href="/connect/express-dashboard">Express Dashboard</a> and are connected to
  127.      * your platform</strong>.
  128.      *
  129.      * @param string $parentId
  130.      * @param null|array{expand?: string[]} $params
  131.      * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  132.      *
  133.      * @return \Stripe\LoginLink
  134.      *
  135.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  136.      */
  137.     public function createLoginLink($parentId, $params = null, $opts = null)
  138.     {
  139.         return $this->request('post', $this->buildPath('/v1/accounts/%s/login_links', $parentId), $params, $opts);
  140.     }
  142.     /**
  143.      * Creates a new person.
  144.      *
  145.      * @param string $parentId
  146.      * @param null|array{additional_tos_acceptances?: array{account?: array{date?: int, ip?: string, user_agent?: null|string}}, address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, dob?: null|array{day: int, month: int, year: int}, documents?: array{company_authorization?: array{files?: string[]}, passport?: array{files?: string[]}, visa?: array{files?: string[]}}, email?: string, expand?: string[], first_name?: string, first_name_kana?: string, first_name_kanji?: string, full_name_aliases?: null|string[], gender?: string, id_number?: string, id_number_secondary?: string, last_name?: string, last_name_kana?: string, last_name_kanji?: string, maiden_name?: string, metadata?: null|array<string, string>, nationality?: string, person_token?: string, phone?: string, political_exposure?: string, registered_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, relationship?: array{authorizer?: bool, director?: bool, executive?: bool, legal_guardian?: bool, owner?: bool, percent_ownership?: null|float, representative?: bool, title?: string}, ssn_last_4?: string, us_cfpb_data?: array{ethnicity_details?: array{ethnicity?: string[], ethnicity_other?: string}, race_details?: array{race?: string[], race_other?: string}, self_identified_gender?: string}, verification?: array{additional_document?: array{back?: string, front?: string}, document?: array{back?: string, front?: string}}} $params
  147.      * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  148.      *
  149.      * @return \Stripe\Person
  150.      *
  151.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  152.      */
  153.     public function createPerson($parentId, $params = null, $opts = null)
  154.     {
  155.         return $this->request('post', $this->buildPath('/v1/accounts/%s/persons', $parentId), $params, $opts);
  156.     }
  158.     /**
  159.      * With <a href="/connect">Connect</a>, you can delete accounts you manage.
  160.      *
  161.      * Test-mode accounts can be deleted at any time.
  162.      *
  163.      * Live-mode accounts that have access to the standard dashboard and Stripe is
  164.      * responsible for negative account balances cannot be deleted, which includes
  165.      * Standard accounts. All other Live-mode accounts, can be deleted when all <a
  166.      * href="/api/balance/balance_object">balances</a> are zero.
  167.      *
  168.      * If you want to delete your own account, use the <a
  169.      * href="https://dashboard.stripe.com/settings/account">account information tab in
  170.      * your account settings</a> instead.
  171.      *
  172.      * @param string $id
  173.      * @param null|array $params
  174.      * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  175.      *
  176.      * @return \Stripe\Account
  177.      *
  178.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  179.      */
  180.     public function delete($id, $params = null, $opts = null)
  181.     {
  182.         return $this->request('delete', $this->buildPath('/v1/accounts/%s', $id), $params, $opts);
  183.     }
  185.     /**
  186.      * Delete a specified external account for a given account.
  187.      *
  188.      * @param string $parentId
  189.      * @param string $id
  190.      * @param null|array $params
  191.      * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  192.      *
  193.      * @return \Stripe\BankAccount|\Stripe\Card
  194.      *
  195.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  196.      */
  197.     public function deleteExternalAccount($parentId, $id, $params = null, $opts = null)
  198.     {
  199.         return $this->request('delete', $this->buildPath('/v1/accounts/%s/external_accounts/%s', $parentId, $id), $params, $opts);
  200.     }
  202.     /**
  203.      * Deletes an existing person’s relationship to the account’s legal entity. Any
  204.      * person with a relationship for an account can be deleted through the API, except
  205.      * if the person is the <code>account_opener</code>. If your integration is using
  206.      * the <code>executive</code> parameter, you cannot delete the only verified
  207.      * <code>executive</code> on file.
  208.      *
  209.      * @param string $parentId
  210.      * @param string $id
  211.      * @param null|array $params
  212.      * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  213.      *
  214.      * @return \Stripe\Person
  215.      *
  216.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  217.      */
  218.     public function deletePerson($parentId, $id, $params = null, $opts = null)
  219.     {
  220.         return $this->request('delete', $this->buildPath('/v1/accounts/%s/persons/%s', $parentId, $id), $params, $opts);
  221.     }
  223.     /**
  224.      * With <a href="/connect">Connect</a>, you can reject accounts that you have
  225.      * flagged as suspicious.
  226.      *
  227.      * Only accounts where your platform is liable for negative account balances, which
  228.      * includes Custom and Express accounts, can be rejected. Test-mode accounts can be
  229.      * rejected at any time. Live-mode accounts can only be rejected after all balances
  230.      * are zero.
  231.      *
  232.      * @param string $id
  233.      * @param null|array{expand?: string[], reason: string} $params
  234.      * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  235.      *
  236.      * @return \Stripe\Account
  237.      *
  238.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  239.      */
  240.     public function reject($id, $params = null, $opts = null)
  241.     {
  242.         return $this->request('post', $this->buildPath('/v1/accounts/%s/reject', $id), $params, $opts);
  243.     }
  245.     /**
  246.      * Retrieves information about the specified Account Capability.
  247.      *
  248.      * @param string $parentId
  249.      * @param string $id
  250.      * @param null|array{expand?: string[]} $params
  251.      * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  252.      *
  253.      * @return \Stripe\Capability
  254.      *
  255.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  256.      */
  257.     public function retrieveCapability($parentId, $id, $params = null, $opts = null)
  258.     {
  259.         return $this->request('get', $this->buildPath('/v1/accounts/%s/capabilities/%s', $parentId, $id), $params, $opts);
  260.     }
  262.     /**
  263.      * Retrieve a specified external account for a given account.
  264.      *
  265.      * @param string $parentId
  266.      * @param string $id
  267.      * @param null|array{expand?: string[]} $params
  268.      * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  269.      *
  270.      * @return \Stripe\BankAccount|\Stripe\Card
  271.      *
  272.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  273.      */
  274.     public function retrieveExternalAccount($parentId, $id, $params = null, $opts = null)
  275.     {
  276.         return $this->request('get', $this->buildPath('/v1/accounts/%s/external_accounts/%s', $parentId, $id), $params, $opts);
  277.     }
  279.     /**
  280.      * Retrieves an existing person.
  281.      *
  282.      * @param string $parentId
  283.      * @param string $id
  284.      * @param null|array{expand?: string[]} $params
  285.      * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  286.      *
  287.      * @return \Stripe\Person
  288.      *
  289.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  290.      */
  291.     public function retrievePerson($parentId, $id, $params = null, $opts = null)
  292.     {
  293.         return $this->request('get', $this->buildPath('/v1/accounts/%s/persons/%s', $parentId, $id), $params, $opts);
  294.     }
  296.     /**
  297.      * Updates a <a href="/connect/accounts">connected account</a> by setting the
  298.      * values of the parameters passed. Any parameters not provided are left unchanged.
  299.      *
  300.      * For accounts where <a
  301.      * href="/api/accounts/object#account_object-controller-requirement_collection">controller.requirement_collection</a>
  302.      * is <code>application</code>, which includes Custom accounts, you can update any
  303.      * information on the account.
  304.      *
  305.      * For accounts where <a
  306.      * href="/api/accounts/object#account_object-controller-requirement_collection">controller.requirement_collection</a>
  307.      * is <code>stripe</code>, which includes Standard and Express accounts, you can
  308.      * update all information until you create an <a href="/api/account_links">Account
  309.      * Link</a> or <a href="/api/account_sessions">Account Session</a> to start Connect
  310.      * onboarding, after which some properties can no longer be updated.
  311.      *
  312.      * To update your own account, use the <a
  313.      * href="https://dashboard.stripe.com/settings/account">Dashboard</a>. Refer to our
  314.      * <a href="/docs/connect/updating-accounts">Connect</a> documentation to learn
  315.      * more about updating accounts.
  316.      *
  317.      * @param string $id
  318.      * @param null|array{account_token?: string, business_profile?: array{annual_revenue?: array{amount: int, currency: string, fiscal_year_end: string}, estimated_worker_count?: int, mcc?: string, minority_owned_business_designation?: string[], monthly_estimated_revenue?: array{amount: int, currency: string}, name?: string, product_description?: string, support_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, support_email?: string, support_phone?: string, support_url?: null|string, url?: string}, business_type?: string, capabilities?: array{acss_debit_payments?: array{requested?: bool}, affirm_payments?: array{requested?: bool}, afterpay_clearpay_payments?: array{requested?: bool}, alma_payments?: array{requested?: bool}, amazon_pay_payments?: array{requested?: bool}, au_becs_debit_payments?: array{requested?: bool}, bacs_debit_payments?: array{requested?: bool}, bancontact_payments?: array{requested?: bool}, bank_transfer_payments?: array{requested?: bool}, billie_payments?: array{requested?: bool}, blik_payments?: array{requested?: bool}, boleto_payments?: array{requested?: bool}, card_issuing?: array{requested?: bool}, card_payments?: array{requested?: bool}, cartes_bancaires_payments?: array{requested?: bool}, cashapp_payments?: array{requested?: bool}, crypto_payments?: array{requested?: bool}, eps_payments?: array{requested?: bool}, fpx_payments?: array{requested?: bool}, gb_bank_transfer_payments?: array{requested?: bool}, giropay_payments?: array{requested?: bool}, grabpay_payments?: array{requested?: bool}, ideal_payments?: array{requested?: bool}, india_international_payments?: array{requested?: bool}, jcb_payments?: array{requested?: bool}, jp_bank_transfer_payments?: array{requested?: bool}, kakao_pay_payments?: array{requested?: bool}, klarna_payments?: array{requested?: bool}, konbini_payments?: array{requested?: bool}, kr_card_payments?: array{requested?: bool}, legacy_payments?: array{requested?: bool}, link_payments?: array{requested?: bool}, mobilepay_payments?: array{requested?: bool}, multibanco_payments?: array{requested?: bool}, mx_bank_transfer_payments?: array{requested?: bool}, naver_pay_payments?: array{requested?: bool}, nz_bank_account_becs_debit_payments?: array{requested?: bool}, oxxo_payments?: array{requested?: bool}, p24_payments?: array{requested?: bool}, pay_by_bank_payments?: array{requested?: bool}, payco_payments?: array{requested?: bool}, paynow_payments?: array{requested?: bool}, pix_payments?: array{requested?: bool}, promptpay_payments?: array{requested?: bool}, revolut_pay_payments?: array{requested?: bool}, samsung_pay_payments?: array{requested?: bool}, satispay_payments?: array{requested?: bool}, sepa_bank_transfer_payments?: array{requested?: bool}, sepa_debit_payments?: array{requested?: bool}, sofort_payments?: array{requested?: bool}, swish_payments?: array{requested?: bool}, tax_reporting_us_1099_k?: array{requested?: bool}, tax_reporting_us_1099_misc?: array{requested?: bool}, transfers?: array{requested?: bool}, treasury?: array{requested?: bool}, twint_payments?: array{requested?: bool}, us_bank_account_ach_payments?: array{requested?: bool}, us_bank_transfer_payments?: array{requested?: bool}, zip_payments?: array{requested?: bool}}, company?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, directors_provided?: bool, directorship_declaration?: array{date?: int, ip?: string, user_agent?: string}, executives_provided?: bool, export_license_id?: string, export_purpose_code?: string, name?: string, name_kana?: string, name_kanji?: string, owners_provided?: bool, ownership_declaration?: array{date?: int, ip?: string, user_agent?: string}, ownership_exemption_reason?: null|string, phone?: string, registration_date?: null|array{day: int, month: int, year: int}, registration_number?: string, structure?: null|string, tax_id?: string, tax_id_registrar?: string, vat_id?: string, verification?: array{document?: array{back?: string, front?: string}}}, default_currency?: string, documents?: array{bank_account_ownership_verification?: array{files?: string[]}, company_license?: array{files?: string[]}, company_memorandum_of_association?: array{files?: string[]}, company_ministerial_decree?: array{files?: string[]}, company_registration_verification?: array{files?: string[]}, company_tax_id_verification?: array{files?: string[]}, proof_of_address?: array{files?: string[]}, proof_of_registration?: array{files?: string[]}, proof_of_ultimate_beneficial_ownership?: array{files?: string[]}}, email?: string, expand?: string[], external_account?: null|array|string, groups?: array{payments_pricing?: null|string}, individual?: array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, dob?: null|array{day: int, month: int, year: int}, email?: string, first_name?: string, first_name_kana?: string, first_name_kanji?: string, full_name_aliases?: null|string[], gender?: string, id_number?: string, id_number_secondary?: string, last_name?: string, last_name_kana?: string, last_name_kanji?: string, maiden_name?: string, metadata?: null|array<string, string>, phone?: string, political_exposure?: string, registered_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, relationship?: array{director?: bool, executive?: bool, owner?: bool, percent_ownership?: null|float, title?: string}, ssn_last_4?: string, verification?: array{additional_document?: array{back?: string, front?: string}, document?: array{back?: string, front?: string}}}, metadata?: null|array<string, string>, settings?: array{bacs_debit_payments?: array{display_name?: string}, branding?: array{icon?: string, logo?: string, primary_color?: string, secondary_color?: string}, card_issuing?: array{tos_acceptance?: array{date?: int, ip?: string, user_agent?: null|string}}, card_payments?: array{decline_on?: array{avs_failure?: bool, cvc_failure?: bool}, statement_descriptor_prefix?: string, statement_descriptor_prefix_kana?: null|string, statement_descriptor_prefix_kanji?: null|string}, invoices?: array{default_account_tax_ids?: null|string[], hosted_payment_method_save?: string}, payments?: array{statement_descriptor?: string, statement_descriptor_kana?: string, statement_descriptor_kanji?: string}, payouts?: array{debit_negative_balances?: bool, schedule?: array{delay_days?: array|int|string, interval?: string, monthly_anchor?: int, monthly_payout_days?: int[], weekly_anchor?: string, weekly_payout_days?: string[]}, statement_descriptor?: string}, treasury?: array{tos_acceptance?: array{date?: int, ip?: string, user_agent?: null|string}}}, tos_acceptance?: array{date?: int, ip?: string, service_agreement?: string, user_agent?: string}} $params
  319.      * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  320.      *
  321.      * @return \Stripe\Account
  322.      *
  323.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  324.      */
  325.     public function update($id, $params = null, $opts = null)
  326.     {
  327.         return $this->request('post', $this->buildPath('/v1/accounts/%s', $id), $params, $opts);
  328.     }
  330.     /**
  331.      * Updates an existing Account Capability. Request or remove a capability by
  332.      * updating its <code>requested</code> parameter.
  333.      *
  334.      * @param string $parentId
  335.      * @param string $id
  336.      * @param null|array{expand?: string[], requested?: bool} $params
  337.      * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  338.      *
  339.      * @return \Stripe\Capability
  340.      *
  341.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  342.      */
  343.     public function updateCapability($parentId, $id, $params = null, $opts = null)
  344.     {
  345.         return $this->request('post', $this->buildPath('/v1/accounts/%s/capabilities/%s', $parentId, $id), $params, $opts);
  346.     }
  348.     /**
  349.      * Updates the metadata, account holder name, account holder type of a bank account
  350.      * belonging to a connected account and optionally sets it as the default for its
  351.      * currency. Other bank account details are not editable by design.
  352.      *
  353.      * You can only update bank accounts when <a
  354.      * href="/api/accounts/object#account_object-controller-requirement_collection">account.controller.requirement_collection</a>
  355.      * is <code>application</code>, which includes <a
  356.      * href="/connect/custom-accounts">Custom accounts</a>.
  357.      *
  358.      * You can re-enable a disabled bank account by performing an update call without
  359.      * providing any arguments or changes.
  360.      *
  361.      * @param string $parentId
  362.      * @param string $id
  363.      * @param null|array{account_holder_name?: string, account_holder_type?: null|string, account_type?: string, address_city?: string, address_country?: string, address_line1?: string, address_line2?: string, address_state?: string, address_zip?: string, default_for_currency?: bool, documents?: array{bank_account_ownership_verification?: array{files?: string[]}}, exp_month?: string, exp_year?: string, expand?: string[], metadata?: null|array<string, string>, name?: string} $params
  364.      * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  365.      *
  366.      * @return \Stripe\BankAccount|\Stripe\Card
  367.      *
  368.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  369.      */
  370.     public function updateExternalAccount($parentId, $id, $params = null, $opts = null)
  371.     {
  372.         return $this->request('post', $this->buildPath('/v1/accounts/%s/external_accounts/%s', $parentId, $id), $params, $opts);
  373.     }
  375.     /**
  376.      * Updates an existing person.
  377.      *
  378.      * @param string $parentId
  379.      * @param string $id
  380.      * @param null|array{additional_tos_acceptances?: array{account?: array{date?: int, ip?: string, user_agent?: null|string}}, address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, address_kana?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, address_kanji?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string, town?: string}, dob?: null|array{day: int, month: int, year: int}, documents?: array{company_authorization?: array{files?: string[]}, passport?: array{files?: string[]}, visa?: array{files?: string[]}}, email?: string, expand?: string[], first_name?: string, first_name_kana?: string, first_name_kanji?: string, full_name_aliases?: null|string[], gender?: string, id_number?: string, id_number_secondary?: string, last_name?: string, last_name_kana?: string, last_name_kanji?: string, maiden_name?: string, metadata?: null|array<string, string>, nationality?: string, person_token?: string, phone?: string, political_exposure?: string, registered_address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, relationship?: array{authorizer?: bool, director?: bool, executive?: bool, legal_guardian?: bool, owner?: bool, percent_ownership?: null|float, representative?: bool, title?: string}, ssn_last_4?: string, us_cfpb_data?: array{ethnicity_details?: array{ethnicity?: string[], ethnicity_other?: string}, race_details?: array{race?: string[], race_other?: string}, self_identified_gender?: string}, verification?: array{additional_document?: array{back?: string, front?: string}, document?: array{back?: string, front?: string}}} $params
  381.      * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  382.      *
  383.      * @return \Stripe\Person
  384.      *
  385.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  386.      */
  387.     public function updatePerson($parentId, $id, $params = null, $opts = null)
  388.     {
  389.         return $this->request('post', $this->buildPath('/v1/accounts/%s/persons/%s', $parentId, $id), $params, $opts);
  390.     }
  392.     /**
  393.      * Retrieves the details of an account.
  394.      *
  395.      * @param null|string $id
  396.      * @param null|array $params
  397.      * @param null|array|\Stripe\Util\RequestOptions $opts
  398.      *
  399.      * @return \Stripe\Account
  400.      *
  401.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  402.      */
  403.     public function retrieve($id = null, $params = null, $opts = null)
  404.     {
  405.         if (null === $id) {
  406.             return $this->request('get', '/v1/account', $params, $opts);
  407.         }
  409.         return $this->request('get', $this->buildPath('/v1/accounts/%s', $id), $params, $opts);
  410.     }
  411. }