code
stringlengths 15
9.96M
| docstring
stringlengths 1
10.1k
| func_name
stringlengths 1
124
| language
stringclasses 1
value | repo
stringlengths 7
63
| path
stringlengths 6
186
| url
stringlengths 50
236
| license
stringclasses 4
values |
|---|---|---|---|---|---|---|---|
public function allOwners($id, $params = null, $opts = null)
{
return $this->requestCollection('get', $this->buildPath('/v1/financial_connections/accounts/%s/owners', $id), $params, $opts);
} | Lists all owners for a given <code>Account</code>.
@param string $id
@param null|array{ending_before?: string, expand?: string[], limit?: int, ownership: string, starting_after?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\FinancialConnections\AccountOwner>
@throws \Stripe\Exception\ApiErrorException if the request fails | allOwners | php | stripe/stripe-php | lib/Service/FinancialConnections/AccountService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/FinancialConnections/AccountService.php | MIT |
public function disconnect($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/financial_connections/accounts/%s/disconnect', $id), $params, $opts);
} | Disables your access to a Financial Connections <code>Account</code>. You will
no longer be able to access data associated with the account (e.g. balances,
transactions).
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\FinancialConnections\Account
@throws \Stripe\Exception\ApiErrorException if the request fails | disconnect | php | stripe/stripe-php | lib/Service/FinancialConnections/AccountService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/FinancialConnections/AccountService.php | MIT |
public function refresh($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/financial_connections/accounts/%s/refresh', $id), $params, $opts);
} | Refreshes the data associated with a Financial Connections <code>Account</code>.
@param string $id
@param null|array{expand?: string[], features: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\FinancialConnections\Account
@throws \Stripe\Exception\ApiErrorException if the request fails | refresh | php | stripe/stripe-php | lib/Service/FinancialConnections/AccountService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/FinancialConnections/AccountService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/financial_connections/accounts/%s', $id), $params, $opts);
} | Retrieves the details of an Financial Connections <code>Account</code>.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\FinancialConnections\Account
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/FinancialConnections/AccountService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/FinancialConnections/AccountService.php | MIT |
public function subscribe($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/financial_connections/accounts/%s/subscribe', $id), $params, $opts);
} | Subscribes to periodic refreshes of data associated with a Financial Connections
<code>Account</code>.
@param string $id
@param null|array{expand?: string[], features: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\FinancialConnections\Account
@throws \Stripe\Exception\ApiErrorException if the request fails | subscribe | php | stripe/stripe-php | lib/Service/FinancialConnections/AccountService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/FinancialConnections/AccountService.php | MIT |
public function unsubscribe($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/financial_connections/accounts/%s/unsubscribe', $id), $params, $opts);
} | Unsubscribes from periodic refreshes of data associated with a Financial
Connections <code>Account</code>.
@param string $id
@param null|array{expand?: string[], features: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\FinancialConnections\Account
@throws \Stripe\Exception\ApiErrorException if the request fails | unsubscribe | php | stripe/stripe-php | lib/Service/FinancialConnections/AccountService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/FinancialConnections/AccountService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/financial_connections/transactions', $params, $opts);
} | Returns a list of Financial Connections <code>Transaction</code> objects.
@param null|array{account: string, ending_before?: string, expand?: string[], limit?: int, starting_after?: string, transacted_at?: array|int, transaction_refresh?: array{after: string}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\FinancialConnections\Transaction>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/FinancialConnections/TransactionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/FinancialConnections/TransactionService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/financial_connections/transactions/%s', $id), $params, $opts);
} | Retrieves the details of a Financial Connections <code>Transaction</code>.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\FinancialConnections\Transaction
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/FinancialConnections/TransactionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/FinancialConnections/TransactionService.php | MIT |
public function expire($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/test_helpers/refunds/%s/expire', $id), $params, $opts);
} | Expire a refund with a status of <code>requires_action</code>.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Refund
@throws \Stripe\Exception\ApiErrorException if the request fails | expire | php | stripe/stripe-php | lib/Service/TestHelpers/RefundService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/RefundService.php | MIT |
public function advance($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/test_helpers/test_clocks/%s/advance', $id), $params, $opts);
} | Starts advancing a test clock to a specified time in the future. Advancement is
done when status changes to <code>Ready</code>.
@param string $id
@param null|array{expand?: string[], frozen_time: int} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\TestHelpers\TestClock
@throws \Stripe\Exception\ApiErrorException if the request fails | advance | php | stripe/stripe-php | lib/Service/TestHelpers/TestClockService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/TestClockService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/test_helpers/test_clocks', $params, $opts);
} | Returns a list of your test clocks.
@param null|array{ending_before?: string, expand?: string[], limit?: int, starting_after?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\TestHelpers\TestClock>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/TestHelpers/TestClockService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/TestClockService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/test_helpers/test_clocks', $params, $opts);
} | Creates a new test clock that can be attached to new customers and quotes.
@param null|array{expand?: string[], frozen_time: int, name?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\TestHelpers\TestClock
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/TestHelpers/TestClockService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/TestClockService.php | MIT |
public function delete($id, $params = null, $opts = null)
{
return $this->request('delete', $this->buildPath('/v1/test_helpers/test_clocks/%s', $id), $params, $opts);
} | Deletes a test clock.
@param string $id
@param null|array $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\TestHelpers\TestClock
@throws \Stripe\Exception\ApiErrorException if the request fails | delete | php | stripe/stripe-php | lib/Service/TestHelpers/TestClockService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/TestClockService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/test_helpers/test_clocks/%s', $id), $params, $opts);
} | Retrieves a test clock.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\TestHelpers\TestClock
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/TestHelpers/TestClockService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/TestClockService.php | MIT |
public function fundCashBalance($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/test_helpers/customers/%s/fund_cash_balance', $id), $params, $opts);
} | Create an incoming testmode bank transfer.
@param string $id
@param null|array{amount: int, currency: string, expand?: string[], reference?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\CustomerCashBalanceTransaction
@throws \Stripe\Exception\ApiErrorException if the request fails | fundCashBalance | php | stripe/stripe-php | lib/Service/TestHelpers/CustomerService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/CustomerService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/test_helpers/confirmation_tokens', $params, $opts);
} | Creates a test mode Confirmation Token server side for your integration tests.
@param null|array{expand?: string[], payment_method?: string, payment_method_data?: array{acss_debit?: array{account_number: string, institution_number: string, transit_number: string}, affirm?: array{}, afterpay_clearpay?: array{}, alipay?: array{}, allow_redisplay?: string, alma?: array{}, amazon_pay?: array{}, au_becs_debit?: array{account_number: string, bsb_number: string}, bacs_debit?: array{account_number?: string, sort_code?: string}, bancontact?: array{}, billie?: array{}, billing_details?: array{address?: null|array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, email?: null|string, name?: null|string, phone?: null|string, tax_id?: string}, blik?: array{}, boleto?: array{tax_id: string}, cashapp?: array{}, customer_balance?: array{}, eps?: array{bank?: string}, fpx?: array{account_holder_type?: string, bank: string}, giropay?: array{}, grabpay?: array{}, ideal?: array{bank?: string}, interac_present?: array{}, kakao_pay?: array{}, klarna?: array{dob?: array{day: int, month: int, year: int}}, konbini?: array{}, kr_card?: array{}, link?: array{}, metadata?: \Stripe\StripeObject, mobilepay?: array{}, multibanco?: array{}, naver_pay?: array{funding?: string}, nz_bank_account?: array{account_holder_name?: string, account_number: string, bank_code: string, branch_code: string, reference?: string, suffix: string}, oxxo?: array{}, p24?: array{bank?: string}, pay_by_bank?: array{}, payco?: array{}, paynow?: array{}, paypal?: array{}, pix?: array{}, promptpay?: array{}, radar_options?: array{session?: string}, revolut_pay?: array{}, samsung_pay?: array{}, satispay?: array{}, sepa_debit?: array{iban: string}, sofort?: array{country: string}, swish?: array{}, twint?: array{}, type: string, us_bank_account?: array{account_holder_type?: string, account_number?: string, account_type?: string, financial_connections_account?: string, routing_number?: string}, wechat_pay?: array{}, zip?: array{}}, payment_method_options?: array{card?: array{installments?: array{plan: array{count?: int, interval?: string, type: string}}}}, return_url?: string, setup_future_usage?: string, shipping?: array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, name: string, phone?: null|string}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\ConfirmationToken
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/TestHelpers/ConfirmationTokenService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/ConfirmationTokenService.php | MIT |
public function presentPaymentMethod($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/test_helpers/terminal/readers/%s/present_payment_method', $id), $params, $opts);
} | Presents a payment method on a simulated reader. Can be used to simulate
accepting a payment, saving a card or refunding a transaction.
@param string $id
@param null|array{amount_tip?: int, card_present?: array{number?: string}, expand?: string[], interac_present?: array{number?: string}, type?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Terminal\Reader
@throws \Stripe\Exception\ApiErrorException if the request fails | presentPaymentMethod | php | stripe/stripe-php | lib/Service/TestHelpers/Terminal/ReaderService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Terminal/ReaderService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/test_helpers/treasury/received_credits', $params, $opts);
} | Use this endpoint to simulate a test mode ReceivedCredit initiated by a third
party. In live mode, you can’t directly create ReceivedCredits initiated by
third parties.
@param null|array{amount: int, currency: string, description?: string, expand?: string[], financial_account: string, initiating_payment_method_details?: array{type: string, us_bank_account?: array{account_holder_name?: string, account_number?: string, routing_number?: string}}, network: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\ReceivedCredit
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/TestHelpers/Treasury/ReceivedCreditService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Treasury/ReceivedCreditService.php | MIT |
public function fail($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/test_helpers/treasury/outbound_payments/%s/fail', $id), $params, $opts);
} | Transitions a test mode created OutboundPayment to the <code>failed</code>
status. The OutboundPayment must already be in the <code>processing</code>
state.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\OutboundPayment
@throws \Stripe\Exception\ApiErrorException if the request fails | fail | php | stripe/stripe-php | lib/Service/TestHelpers/Treasury/OutboundPaymentService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Treasury/OutboundPaymentService.php | MIT |
public function post($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/test_helpers/treasury/outbound_payments/%s/post', $id), $params, $opts);
} | Transitions a test mode created OutboundPayment to the <code>posted</code>
status. The OutboundPayment must already be in the <code>processing</code>
state.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\OutboundPayment
@throws \Stripe\Exception\ApiErrorException if the request fails | post | php | stripe/stripe-php | lib/Service/TestHelpers/Treasury/OutboundPaymentService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Treasury/OutboundPaymentService.php | MIT |
public function returnOutboundPayment($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/test_helpers/treasury/outbound_payments/%s/return', $id), $params, $opts);
} | Transitions a test mode created OutboundPayment to the <code>returned</code>
status. The OutboundPayment must already be in the <code>processing</code>
state.
@param string $id
@param null|array{expand?: string[], returned_details?: array{code?: string}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\OutboundPayment
@throws \Stripe\Exception\ApiErrorException if the request fails | returnOutboundPayment | php | stripe/stripe-php | lib/Service/TestHelpers/Treasury/OutboundPaymentService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Treasury/OutboundPaymentService.php | MIT |
public function update($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/test_helpers/treasury/outbound_payments/%s', $id), $params, $opts);
} | Updates a test mode created OutboundPayment with tracking details. The
OutboundPayment must not be cancelable, and cannot be in the
<code>canceled</code> or <code>failed</code> states.
@param string $id
@param null|array{expand?: string[], tracking_details: array{ach?: array{trace_id: string}, type: string, us_domestic_wire?: array{chips?: string, imad?: string, omad?: string}}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\OutboundPayment
@throws \Stripe\Exception\ApiErrorException if the request fails | update | php | stripe/stripe-php | lib/Service/TestHelpers/Treasury/OutboundPaymentService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Treasury/OutboundPaymentService.php | MIT |
public function fail($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/test_helpers/treasury/outbound_transfers/%s/fail', $id), $params, $opts);
} | Transitions a test mode created OutboundTransfer to the <code>failed</code>
status. The OutboundTransfer must already be in the <code>processing</code>
state.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\OutboundTransfer
@throws \Stripe\Exception\ApiErrorException if the request fails | fail | php | stripe/stripe-php | lib/Service/TestHelpers/Treasury/OutboundTransferService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Treasury/OutboundTransferService.php | MIT |
public function post($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/test_helpers/treasury/outbound_transfers/%s/post', $id), $params, $opts);
} | Transitions a test mode created OutboundTransfer to the <code>posted</code>
status. The OutboundTransfer must already be in the <code>processing</code>
state.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\OutboundTransfer
@throws \Stripe\Exception\ApiErrorException if the request fails | post | php | stripe/stripe-php | lib/Service/TestHelpers/Treasury/OutboundTransferService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Treasury/OutboundTransferService.php | MIT |
public function returnOutboundTransfer($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/test_helpers/treasury/outbound_transfers/%s/return', $id), $params, $opts);
} | Transitions a test mode created OutboundTransfer to the <code>returned</code>
status. The OutboundTransfer must already be in the <code>processing</code>
state.
@param string $id
@param null|array{expand?: string[], returned_details?: array{code?: string}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\OutboundTransfer
@throws \Stripe\Exception\ApiErrorException if the request fails | returnOutboundTransfer | php | stripe/stripe-php | lib/Service/TestHelpers/Treasury/OutboundTransferService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Treasury/OutboundTransferService.php | MIT |
public function update($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/test_helpers/treasury/outbound_transfers/%s', $id), $params, $opts);
} | Updates a test mode created OutboundTransfer with tracking details. The
OutboundTransfer must not be cancelable, and cannot be in the
<code>canceled</code> or <code>failed</code> states.
@param string $id
@param null|array{expand?: string[], tracking_details: array{ach?: array{trace_id: string}, type: string, us_domestic_wire?: array{chips?: string, imad?: string, omad?: string}}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\OutboundTransfer
@throws \Stripe\Exception\ApiErrorException if the request fails | update | php | stripe/stripe-php | lib/Service/TestHelpers/Treasury/OutboundTransferService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Treasury/OutboundTransferService.php | MIT |
public function fail($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/test_helpers/treasury/inbound_transfers/%s/fail', $id), $params, $opts);
} | Transitions a test mode created InboundTransfer to the <code>failed</code>
status. The InboundTransfer must already be in the <code>processing</code>
state.
@param string $id
@param null|array{expand?: string[], failure_details?: array{code?: string}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\InboundTransfer
@throws \Stripe\Exception\ApiErrorException if the request fails | fail | php | stripe/stripe-php | lib/Service/TestHelpers/Treasury/InboundTransferService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Treasury/InboundTransferService.php | MIT |
public function returnInboundTransfer($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/test_helpers/treasury/inbound_transfers/%s/return', $id), $params, $opts);
} | Marks the test mode InboundTransfer object as returned and links the
InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the
<code>succeeded</code> state.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\InboundTransfer
@throws \Stripe\Exception\ApiErrorException if the request fails | returnInboundTransfer | php | stripe/stripe-php | lib/Service/TestHelpers/Treasury/InboundTransferService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Treasury/InboundTransferService.php | MIT |
public function succeed($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/test_helpers/treasury/inbound_transfers/%s/succeed', $id), $params, $opts);
} | Transitions a test mode created InboundTransfer to the <code>succeeded</code>
status. The InboundTransfer must already be in the <code>processing</code>
state.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\InboundTransfer
@throws \Stripe\Exception\ApiErrorException if the request fails | succeed | php | stripe/stripe-php | lib/Service/TestHelpers/Treasury/InboundTransferService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Treasury/InboundTransferService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/test_helpers/treasury/received_debits', $params, $opts);
} | Use this endpoint to simulate a test mode ReceivedDebit initiated by a third
party. In live mode, you can’t directly create ReceivedDebits initiated by third
parties.
@param null|array{amount: int, currency: string, description?: string, expand?: string[], financial_account: string, initiating_payment_method_details?: array{type: string, us_bank_account?: array{account_holder_name?: string, account_number?: string, routing_number?: string}}, network: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\ReceivedDebit
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/TestHelpers/Treasury/ReceivedDebitService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Treasury/ReceivedDebitService.php | MIT |
public function deliverCard($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/test_helpers/issuing/cards/%s/shipping/deliver', $id), $params, $opts);
} | Updates the shipping status of the specified Issuing <code>Card</code> object to
<code>delivered</code>.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Card
@throws \Stripe\Exception\ApiErrorException if the request fails | deliverCard | php | stripe/stripe-php | lib/Service/TestHelpers/Issuing/CardService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Issuing/CardService.php | MIT |
public function failCard($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/test_helpers/issuing/cards/%s/shipping/fail', $id), $params, $opts);
} | Updates the shipping status of the specified Issuing <code>Card</code> object to
<code>failure</code>.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Card
@throws \Stripe\Exception\ApiErrorException if the request fails | failCard | php | stripe/stripe-php | lib/Service/TestHelpers/Issuing/CardService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Issuing/CardService.php | MIT |
public function returnCard($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/test_helpers/issuing/cards/%s/shipping/return', $id), $params, $opts);
} | Updates the shipping status of the specified Issuing <code>Card</code> object to
<code>returned</code>.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Card
@throws \Stripe\Exception\ApiErrorException if the request fails | returnCard | php | stripe/stripe-php | lib/Service/TestHelpers/Issuing/CardService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Issuing/CardService.php | MIT |
public function shipCard($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/test_helpers/issuing/cards/%s/shipping/ship', $id), $params, $opts);
} | Updates the shipping status of the specified Issuing <code>Card</code> object to
<code>shipped</code>.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Card
@throws \Stripe\Exception\ApiErrorException if the request fails | shipCard | php | stripe/stripe-php | lib/Service/TestHelpers/Issuing/CardService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Issuing/CardService.php | MIT |
public function submitCard($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/test_helpers/issuing/cards/%s/shipping/submit', $id), $params, $opts);
} | Updates the shipping status of the specified Issuing <code>Card</code> object to
<code>submitted</code>. This method requires Stripe Version ‘2024-09-30.acacia’
or later.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Card
@throws \Stripe\Exception\ApiErrorException if the request fails | submitCard | php | stripe/stripe-php | lib/Service/TestHelpers/Issuing/CardService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Issuing/CardService.php | MIT |
public function createForceCapture($params = null, $opts = null)
{
return $this->request('post', '/v1/test_helpers/issuing/transactions/create_force_capture', $params, $opts);
} | Allows the user to capture an arbitrary amount, also known as a forced capture.
@param null|array{amount: int, card: string, currency?: string, expand?: string[], merchant_data?: array{category?: string, city?: string, country?: string, name?: string, network_id?: string, postal_code?: string, state?: string, terminal_id?: string, url?: string}, purchase_details?: array{fleet?: array{cardholder_prompt_data?: array{driver_id?: string, odometer?: int, unspecified_id?: string, user_id?: string, vehicle_number?: string}, purchase_type?: string, reported_breakdown?: array{fuel?: array{gross_amount_decimal?: string}, non_fuel?: array{gross_amount_decimal?: string}, tax?: array{local_amount_decimal?: string, national_amount_decimal?: string}}, service_type?: string}, flight?: array{departure_at?: int, passenger_name?: string, refundable?: bool, segments?: array{arrival_airport_code?: string, carrier?: string, departure_airport_code?: string, flight_number?: string, service_class?: string, stopover_allowed?: bool}[], travel_agency?: string}, fuel?: array{industry_product_code?: string, quantity_decimal?: string, type?: string, unit?: string, unit_cost_decimal?: string}, lodging?: array{check_in_at?: int, nights?: int}, receipt?: array{description?: string, quantity?: string, total?: int, unit_cost?: int}[], reference?: string}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Transaction
@throws \Stripe\Exception\ApiErrorException if the request fails | createForceCapture | php | stripe/stripe-php | lib/Service/TestHelpers/Issuing/TransactionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Issuing/TransactionService.php | MIT |
public function createUnlinkedRefund($params = null, $opts = null)
{
return $this->request('post', '/v1/test_helpers/issuing/transactions/create_unlinked_refund', $params, $opts);
} | Allows the user to refund an arbitrary amount, also known as a unlinked refund.
@param null|array{amount: int, card: string, currency?: string, expand?: string[], merchant_data?: array{category?: string, city?: string, country?: string, name?: string, network_id?: string, postal_code?: string, state?: string, terminal_id?: string, url?: string}, purchase_details?: array{fleet?: array{cardholder_prompt_data?: array{driver_id?: string, odometer?: int, unspecified_id?: string, user_id?: string, vehicle_number?: string}, purchase_type?: string, reported_breakdown?: array{fuel?: array{gross_amount_decimal?: string}, non_fuel?: array{gross_amount_decimal?: string}, tax?: array{local_amount_decimal?: string, national_amount_decimal?: string}}, service_type?: string}, flight?: array{departure_at?: int, passenger_name?: string, refundable?: bool, segments?: array{arrival_airport_code?: string, carrier?: string, departure_airport_code?: string, flight_number?: string, service_class?: string, stopover_allowed?: bool}[], travel_agency?: string}, fuel?: array{industry_product_code?: string, quantity_decimal?: string, type?: string, unit?: string, unit_cost_decimal?: string}, lodging?: array{check_in_at?: int, nights?: int}, receipt?: array{description?: string, quantity?: string, total?: int, unit_cost?: int}[], reference?: string}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Transaction
@throws \Stripe\Exception\ApiErrorException if the request fails | createUnlinkedRefund | php | stripe/stripe-php | lib/Service/TestHelpers/Issuing/TransactionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Issuing/TransactionService.php | MIT |
public function refund($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/test_helpers/issuing/transactions/%s/refund', $id), $params, $opts);
} | Refund a test-mode Transaction.
@param string $id
@param null|array{expand?: string[], refund_amount?: int} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Transaction
@throws \Stripe\Exception\ApiErrorException if the request fails | refund | php | stripe/stripe-php | lib/Service/TestHelpers/Issuing/TransactionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Issuing/TransactionService.php | MIT |
public function capture($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/test_helpers/issuing/authorizations/%s/capture', $id), $params, $opts);
} | Capture a test-mode authorization.
@param string $id
@param null|array{capture_amount?: int, close_authorization?: bool, expand?: string[], purchase_details?: array{fleet?: array{cardholder_prompt_data?: array{driver_id?: string, odometer?: int, unspecified_id?: string, user_id?: string, vehicle_number?: string}, purchase_type?: string, reported_breakdown?: array{fuel?: array{gross_amount_decimal?: string}, non_fuel?: array{gross_amount_decimal?: string}, tax?: array{local_amount_decimal?: string, national_amount_decimal?: string}}, service_type?: string}, flight?: array{departure_at?: int, passenger_name?: string, refundable?: bool, segments?: array{arrival_airport_code?: string, carrier?: string, departure_airport_code?: string, flight_number?: string, service_class?: string, stopover_allowed?: bool}[], travel_agency?: string}, fuel?: array{industry_product_code?: string, quantity_decimal?: string, type?: string, unit?: string, unit_cost_decimal?: string}, lodging?: array{check_in_at?: int, nights?: int}, receipt?: array{description?: string, quantity?: string, total?: int, unit_cost?: int}[], reference?: string}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Authorization
@throws \Stripe\Exception\ApiErrorException if the request fails | capture | php | stripe/stripe-php | lib/Service/TestHelpers/Issuing/AuthorizationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Issuing/AuthorizationService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/test_helpers/issuing/authorizations', $params, $opts);
} | Create a test-mode authorization.
@param null|array{amount?: int, amount_details?: array{atm_fee?: int, cashback_amount?: int}, authorization_method?: string, card: string, currency?: string, expand?: string[], fleet?: array{cardholder_prompt_data?: array{driver_id?: string, odometer?: int, unspecified_id?: string, user_id?: string, vehicle_number?: string}, purchase_type?: string, reported_breakdown?: array{fuel?: array{gross_amount_decimal?: string}, non_fuel?: array{gross_amount_decimal?: string}, tax?: array{local_amount_decimal?: string, national_amount_decimal?: string}}, service_type?: string}, fuel?: array{industry_product_code?: string, quantity_decimal?: string, type?: string, unit?: string, unit_cost_decimal?: string}, is_amount_controllable?: bool, merchant_amount?: int, merchant_currency?: string, merchant_data?: array{category?: string, city?: string, country?: string, name?: string, network_id?: string, postal_code?: string, state?: string, terminal_id?: string, url?: string}, network_data?: array{acquiring_institution_id?: string}, verification_data?: array{address_line1_check?: string, address_postal_code_check?: string, authentication_exemption?: array{claimed_by: string, type: string}, cvc_check?: string, expiry_check?: string, three_d_secure?: array{result: string}}, wallet?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Authorization
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/TestHelpers/Issuing/AuthorizationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Issuing/AuthorizationService.php | MIT |
public function expire($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/test_helpers/issuing/authorizations/%s/expire', $id), $params, $opts);
} | Expire a test-mode Authorization.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Authorization
@throws \Stripe\Exception\ApiErrorException if the request fails | expire | php | stripe/stripe-php | lib/Service/TestHelpers/Issuing/AuthorizationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Issuing/AuthorizationService.php | MIT |
public function finalizeAmount($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/test_helpers/issuing/authorizations/%s/finalize_amount', $id), $params, $opts);
} | Finalize the amount on an Authorization prior to capture, when the initial
authorization was for an estimated amount.
@param string $id
@param null|array{expand?: string[], final_amount: int, fleet?: array{cardholder_prompt_data?: array{driver_id?: string, odometer?: int, unspecified_id?: string, user_id?: string, vehicle_number?: string}, purchase_type?: string, reported_breakdown?: array{fuel?: array{gross_amount_decimal?: string}, non_fuel?: array{gross_amount_decimal?: string}, tax?: array{local_amount_decimal?: string, national_amount_decimal?: string}}, service_type?: string}, fuel?: array{industry_product_code?: string, quantity_decimal?: string, type?: string, unit?: string, unit_cost_decimal?: string}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Authorization
@throws \Stripe\Exception\ApiErrorException if the request fails | finalizeAmount | php | stripe/stripe-php | lib/Service/TestHelpers/Issuing/AuthorizationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Issuing/AuthorizationService.php | MIT |
public function increment($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/test_helpers/issuing/authorizations/%s/increment', $id), $params, $opts);
} | Increment a test-mode Authorization.
@param string $id
@param null|array{expand?: string[], increment_amount: int, is_amount_controllable?: bool} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Authorization
@throws \Stripe\Exception\ApiErrorException if the request fails | increment | php | stripe/stripe-php | lib/Service/TestHelpers/Issuing/AuthorizationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Issuing/AuthorizationService.php | MIT |
public function respond($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/test_helpers/issuing/authorizations/%s/fraud_challenges/respond', $id), $params, $opts);
} | Respond to a fraud challenge on a testmode Issuing authorization, simulating
either a confirmation of fraud or a correction of legitimacy.
@param string $id
@param null|array{confirmed: bool, expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Authorization
@throws \Stripe\Exception\ApiErrorException if the request fails | respond | php | stripe/stripe-php | lib/Service/TestHelpers/Issuing/AuthorizationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Issuing/AuthorizationService.php | MIT |
public function reverse($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/test_helpers/issuing/authorizations/%s/reverse', $id), $params, $opts);
} | Reverse a test-mode Authorization.
@param string $id
@param null|array{expand?: string[], reverse_amount?: int} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Authorization
@throws \Stripe\Exception\ApiErrorException if the request fails | reverse | php | stripe/stripe-php | lib/Service/TestHelpers/Issuing/AuthorizationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Issuing/AuthorizationService.php | MIT |
public function activate($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/test_helpers/issuing/personalization_designs/%s/activate', $id), $params, $opts);
} | Updates the <code>status</code> of the specified testmode personalization design
object to <code>active</code>.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\PersonalizationDesign
@throws \Stripe\Exception\ApiErrorException if the request fails | activate | php | stripe/stripe-php | lib/Service/TestHelpers/Issuing/PersonalizationDesignService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Issuing/PersonalizationDesignService.php | MIT |
public function deactivate($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/test_helpers/issuing/personalization_designs/%s/deactivate', $id), $params, $opts);
} | Updates the <code>status</code> of the specified testmode personalization design
object to <code>inactive</code>.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\PersonalizationDesign
@throws \Stripe\Exception\ApiErrorException if the request fails | deactivate | php | stripe/stripe-php | lib/Service/TestHelpers/Issuing/PersonalizationDesignService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Issuing/PersonalizationDesignService.php | MIT |
public function reject($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/test_helpers/issuing/personalization_designs/%s/reject', $id), $params, $opts);
} | Updates the <code>status</code> of the specified testmode personalization design
object to <code>rejected</code>.
@param string $id
@param null|array{expand?: string[], rejection_reasons: array{card_logo?: string[], carrier_text?: string[]}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\PersonalizationDesign
@throws \Stripe\Exception\ApiErrorException if the request fails | reject | php | stripe/stripe-php | lib/Service/TestHelpers/Issuing/PersonalizationDesignService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/TestHelpers/Issuing/PersonalizationDesignService.php | MIT |
public static function create($params = null, $options = null)
{
self::_validateParams($params);
$url = static::classUrl();
list($response, $opts) = static::_staticRequest('post', $url, $params, $options);
$obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
} | Creates a new object and begin running the report. (Certain report types require
a <a href="https://stripe.com/docs/keys#test-live-modes">live-mode API key</a>.).
@param null|array{expand?: string[], parameters?: array{columns?: string[], connected_account?: string, currency?: string, interval_end?: int, interval_start?: int, payout?: string, reporting_category?: string, timezone?: string}, report_type: string} $params
@param null|array|string $options
@return ReportRun the created resource
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Reporting/ReportRun.php | https://github.com/stripe/stripe-php/blob/master/lib/Reporting/ReportRun.php | MIT |
public static function all($params = null, $opts = null)
{
$url = static::classUrl();
return static::_requestPage($url, \Stripe\Collection::class, $params, $opts);
} | Returns a list of Report Runs, with the most recent appearing first.
@param null|array{created?: array|int, ending_before?: string, expand?: string[], limit?: int, starting_after?: string} $params
@param null|array|string $opts
@return \Stripe\Collection<ReportRun> of ApiResources
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Reporting/ReportRun.php | https://github.com/stripe/stripe-php/blob/master/lib/Reporting/ReportRun.php | MIT |
public static function retrieve($id, $opts = null)
{
$opts = \Stripe\Util\RequestOptions::parse($opts);
$instance = new static($id, $opts);
$instance->refresh();
return $instance;
} | Retrieves the details of an existing Report Run.
@param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
@param null|array|string $opts
@return ReportRun
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Reporting/ReportRun.php | https://github.com/stripe/stripe-php/blob/master/lib/Reporting/ReportRun.php | MIT |
public static function all($params = null, $opts = null)
{
$url = static::classUrl();
return static::_requestPage($url, \Stripe\Collection::class, $params, $opts);
} | Returns a full list of Report Types.
@param null|array{expand?: string[]} $params
@param null|array|string $opts
@return \Stripe\Collection<ReportType> of ApiResources
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Reporting/ReportType.php | https://github.com/stripe/stripe-php/blob/master/lib/Reporting/ReportType.php | MIT |
public static function retrieve($id, $opts = null)
{
$opts = \Stripe\Util\RequestOptions::parse($opts);
$instance = new static($id, $opts);
$instance->refresh();
return $instance;
} | Retrieves the details of a Report Type. (Certain report types require a <a
href="https://stripe.com/docs/keys#test-live-modes">live-mode API key</a>.).
@param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
@param null|array|string $opts
@return ReportType
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Reporting/ReportType.php | https://github.com/stripe/stripe-php/blob/master/lib/Reporting/ReportType.php | MIT |
public static function create($params = null, $options = null)
{
self::_validateParams($params);
$url = static::classUrl();
list($response, $opts) = static::_staticRequest('post', $url, $params, $options);
$obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
} | Creates a ForwardingRequest object.
@param null|array{expand?: string[], metadata?: \Stripe\StripeObject, payment_method: string, replacements: string[], request: array{body?: string, headers?: array{name: string, value: string}[]}, url: string} $params
@param null|array|string $options
@return Request the created resource
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Forwarding/Request.php | https://github.com/stripe/stripe-php/blob/master/lib/Forwarding/Request.php | MIT |
public static function all($params = null, $opts = null)
{
$url = static::classUrl();
return static::_requestPage($url, \Stripe\Collection::class, $params, $opts);
} | Lists all ForwardingRequest objects.
@param null|array{created?: array{gt?: int, gte?: int, lt?: int, lte?: int}, ending_before?: string, expand?: string[], limit?: int, starting_after?: string} $params
@param null|array|string $opts
@return \Stripe\Collection<Request> of ApiResources
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Forwarding/Request.php | https://github.com/stripe/stripe-php/blob/master/lib/Forwarding/Request.php | MIT |
public static function retrieve($id, $opts = null)
{
$opts = \Stripe\Util\RequestOptions::parse($opts);
$instance = new static($id, $opts);
$instance->refresh();
return $instance;
} | Retrieves a ForwardingRequest object.
@param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
@param null|array|string $opts
@return Request
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Forwarding/Request.php | https://github.com/stripe/stripe-php/blob/master/lib/Forwarding/Request.php | MIT |
public static function create($params = null, $options = null)
{
self::_validateParams($params);
$url = static::classUrl();
list($response, $opts) = static::_staticRequest('post', $url, $params, $options);
$obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
} | Creates an OutboundPayment.
@param null|array{amount: int, currency: string, customer?: string, description?: string, destination_payment_method?: string, destination_payment_method_data?: array{billing_details?: array{address?: null|array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, email?: null|string, name?: null|string, phone?: null|string, tax_id?: string}, financial_account?: string, metadata?: \Stripe\StripeObject, type: string, us_bank_account?: array{account_holder_type?: string, account_number?: string, account_type?: string, financial_connections_account?: string, routing_number?: string}}, destination_payment_method_options?: array{us_bank_account?: null|array{network?: string}}, end_user_details?: array{ip_address?: string, present: bool}, expand?: string[], financial_account: string, metadata?: \Stripe\StripeObject, statement_descriptor?: string} $params
@param null|array|string $options
@return OutboundPayment the created resource
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Treasury/OutboundPayment.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/OutboundPayment.php | MIT |
public static function all($params = null, $opts = null)
{
$url = static::classUrl();
return static::_requestPage($url, \Stripe\Collection::class, $params, $opts);
} | Returns a list of OutboundPayments sent from the specified FinancialAccount.
@param null|array{created?: array|int, customer?: string, ending_before?: string, expand?: string[], financial_account: string, limit?: int, starting_after?: string, status?: string} $params
@param null|array|string $opts
@return \Stripe\Collection<OutboundPayment> of ApiResources
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Treasury/OutboundPayment.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/OutboundPayment.php | MIT |
public static function retrieve($id, $opts = null)
{
$opts = \Stripe\Util\RequestOptions::parse($opts);
$instance = new static($id, $opts);
$instance->refresh();
return $instance;
} | Retrieves the details of an existing OutboundPayment by passing the unique
OutboundPayment ID from either the OutboundPayment creation request or
OutboundPayment list.
@param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
@param null|array|string $opts
@return OutboundPayment
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Treasury/OutboundPayment.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/OutboundPayment.php | MIT |
public function cancel($params = null, $opts = null)
{
$url = $this->instanceUrl() . '/cancel';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
return $this;
} | @param null|array $params
@param null|array|string $opts
@return OutboundPayment the canceled outbound payment
@throws \Stripe\Exception\ApiErrorException if the request fails | cancel | php | stripe/stripe-php | lib/Treasury/OutboundPayment.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/OutboundPayment.php | MIT |
public static function create($params = null, $options = null)
{
self::_validateParams($params);
$url = static::classUrl();
list($response, $opts) = static::_staticRequest('post', $url, $params, $options);
$obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
} | Creates a new FinancialAccount. Each connected account can have up to three
FinancialAccounts by default.
@param null|array{expand?: string[], features?: array{card_issuing?: array{requested: bool}, deposit_insurance?: array{requested: bool}, financial_addresses?: array{aba?: array{requested: bool}}, inbound_transfers?: array{ach?: array{requested: bool}}, intra_stripe_flows?: array{requested: bool}, outbound_payments?: array{ach?: array{requested: bool}, us_domestic_wire?: array{requested: bool}}, outbound_transfers?: array{ach?: array{requested: bool}, us_domestic_wire?: array{requested: bool}}}, metadata?: \Stripe\StripeObject, nickname?: null|string, platform_restrictions?: array{inbound_flows?: string, outbound_flows?: string}, supported_currencies: string[]} $params
@param null|array|string $options
@return FinancialAccount the created resource
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Treasury/FinancialAccount.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/FinancialAccount.php | MIT |
public static function all($params = null, $opts = null)
{
$url = static::classUrl();
return static::_requestPage($url, \Stripe\Collection::class, $params, $opts);
} | Returns a list of FinancialAccounts.
@param null|array{created?: array|int, ending_before?: string, expand?: string[], limit?: int, starting_after?: string} $params
@param null|array|string $opts
@return \Stripe\Collection<FinancialAccount> of ApiResources
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Treasury/FinancialAccount.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/FinancialAccount.php | MIT |
public static function retrieve($id, $opts = null)
{
$opts = \Stripe\Util\RequestOptions::parse($opts);
$instance = new static($id, $opts);
$instance->refresh();
return $instance;
} | Retrieves the details of a FinancialAccount.
@param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
@param null|array|string $opts
@return FinancialAccount
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Treasury/FinancialAccount.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/FinancialAccount.php | MIT |
public static function update($id, $params = null, $opts = null)
{
self::_validateParams($params);
$url = static::resourceUrl($id);
list($response, $opts) = static::_staticRequest('post', $url, $params, $opts);
$obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
} | Updates the details of a FinancialAccount.
@param string $id the ID of the resource to update
@param null|array{expand?: string[], features?: array{card_issuing?: array{requested: bool}, deposit_insurance?: array{requested: bool}, financial_addresses?: array{aba?: array{requested: bool}}, inbound_transfers?: array{ach?: array{requested: bool}}, intra_stripe_flows?: array{requested: bool}, outbound_payments?: array{ach?: array{requested: bool}, us_domestic_wire?: array{requested: bool}}, outbound_transfers?: array{ach?: array{requested: bool}, us_domestic_wire?: array{requested: bool}}}, forwarding_settings?: array{financial_account?: string, payment_method?: string, type: string}, metadata?: \Stripe\StripeObject, nickname?: null|string, platform_restrictions?: array{inbound_flows?: string, outbound_flows?: string}} $params
@param null|array|string $opts
@return FinancialAccount the updated resource
@throws \Stripe\Exception\ApiErrorException if the request fails | update | php | stripe/stripe-php | lib/Treasury/FinancialAccount.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/FinancialAccount.php | MIT |
public function close($params = null, $opts = null)
{
$url = $this->instanceUrl() . '/close';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
return $this;
} | @param null|array $params
@param null|array|string $opts
@return FinancialAccount the closed financial account
@throws \Stripe\Exception\ApiErrorException if the request fails | close | php | stripe/stripe-php | lib/Treasury/FinancialAccount.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/FinancialAccount.php | MIT |
public function retrieveFeatures($params = null, $opts = null)
{
$url = $this->instanceUrl() . '/features';
list($response, $opts) = $this->_request('get', $url, $params, $opts);
$obj = \Stripe\Util\Util::convertToStripeObject($response, $opts);
$obj->setLastResponse($response);
return $obj;
} | @param null|array $params
@param null|array|string $opts
@return FinancialAccountFeatures the retrieved financial account features
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieveFeatures | php | stripe/stripe-php | lib/Treasury/FinancialAccount.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/FinancialAccount.php | MIT |
public function updateFeatures($params = null, $opts = null)
{
$url = $this->instanceUrl() . '/features';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
return $this;
} | @param null|array $params
@param null|array|string $opts
@return FinancialAccountFeatures the updated financial account features
@throws \Stripe\Exception\ApiErrorException if the request fails | updateFeatures | php | stripe/stripe-php | lib/Treasury/FinancialAccount.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/FinancialAccount.php | MIT |
public static function create($params = null, $options = null)
{
self::_validateParams($params);
$url = static::classUrl();
list($response, $opts) = static::_staticRequest('post', $url, $params, $options);
$obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
} | Creates an InboundTransfer.
@param null|array{amount: int, currency: string, description?: string, expand?: string[], financial_account: string, metadata?: \Stripe\StripeObject, origin_payment_method: string, statement_descriptor?: string} $params
@param null|array|string $options
@return InboundTransfer the created resource
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Treasury/InboundTransfer.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/InboundTransfer.php | MIT |
public static function all($params = null, $opts = null)
{
$url = static::classUrl();
return static::_requestPage($url, \Stripe\Collection::class, $params, $opts);
} | Returns a list of InboundTransfers sent from the specified FinancialAccount.
@param null|array{ending_before?: string, expand?: string[], financial_account: string, limit?: int, starting_after?: string, status?: string} $params
@param null|array|string $opts
@return \Stripe\Collection<InboundTransfer> of ApiResources
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Treasury/InboundTransfer.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/InboundTransfer.php | MIT |
public static function retrieve($id, $opts = null)
{
$opts = \Stripe\Util\RequestOptions::parse($opts);
$instance = new static($id, $opts);
$instance->refresh();
return $instance;
} | Retrieves the details of an existing InboundTransfer.
@param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
@param null|array|string $opts
@return InboundTransfer
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Treasury/InboundTransfer.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/InboundTransfer.php | MIT |
public function cancel($params = null, $opts = null)
{
$url = $this->instanceUrl() . '/cancel';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
return $this;
} | @param null|array $params
@param null|array|string $opts
@return InboundTransfer the canceled inbound transfer
@throws \Stripe\Exception\ApiErrorException if the request fails | cancel | php | stripe/stripe-php | lib/Treasury/InboundTransfer.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/InboundTransfer.php | MIT |
public static function create($params = null, $options = null)
{
self::_validateParams($params);
$url = static::classUrl();
list($response, $opts) = static::_staticRequest('post', $url, $params, $options);
$obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
} | Reverses a ReceivedCredit and creates a CreditReversal object.
@param null|array{expand?: string[], metadata?: \Stripe\StripeObject, received_credit: string} $params
@param null|array|string $options
@return CreditReversal the created resource
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Treasury/CreditReversal.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/CreditReversal.php | MIT |
public static function all($params = null, $opts = null)
{
$url = static::classUrl();
return static::_requestPage($url, \Stripe\Collection::class, $params, $opts);
} | Returns a list of CreditReversals.
@param null|array{ending_before?: string, expand?: string[], financial_account: string, limit?: int, received_credit?: string, starting_after?: string, status?: string} $params
@param null|array|string $opts
@return \Stripe\Collection<CreditReversal> of ApiResources
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Treasury/CreditReversal.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/CreditReversal.php | MIT |
public static function retrieve($id, $opts = null)
{
$opts = \Stripe\Util\RequestOptions::parse($opts);
$instance = new static($id, $opts);
$instance->refresh();
return $instance;
} | Retrieves the details of an existing CreditReversal by passing the unique
CreditReversal ID from either the CreditReversal creation request or
CreditReversal list.
@param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
@param null|array|string $opts
@return CreditReversal
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Treasury/CreditReversal.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/CreditReversal.php | MIT |
public static function all($params = null, $opts = null)
{
$url = static::classUrl();
return static::_requestPage($url, \Stripe\Collection::class, $params, $opts);
} | Returns a list of ReceivedDebits.
@param null|array{ending_before?: string, expand?: string[], financial_account: string, limit?: int, starting_after?: string, status?: string} $params
@param null|array|string $opts
@return \Stripe\Collection<ReceivedDebit> of ApiResources
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Treasury/ReceivedDebit.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/ReceivedDebit.php | MIT |
public static function retrieve($id, $opts = null)
{
$opts = \Stripe\Util\RequestOptions::parse($opts);
$instance = new static($id, $opts);
$instance->refresh();
return $instance;
} | Retrieves the details of an existing ReceivedDebit by passing the unique
ReceivedDebit ID from the ReceivedDebit list.
@param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
@param null|array|string $opts
@return ReceivedDebit
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Treasury/ReceivedDebit.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/ReceivedDebit.php | MIT |
public static function all($params = null, $opts = null)
{
$url = static::classUrl();
return static::_requestPage($url, \Stripe\Collection::class, $params, $opts);
} | Returns a list of ReceivedCredits.
@param null|array{ending_before?: string, expand?: string[], financial_account: string, limit?: int, linked_flows?: array{source_flow_type: string}, starting_after?: string, status?: string} $params
@param null|array|string $opts
@return \Stripe\Collection<ReceivedCredit> of ApiResources
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Treasury/ReceivedCredit.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/ReceivedCredit.php | MIT |
public static function retrieve($id, $opts = null)
{
$opts = \Stripe\Util\RequestOptions::parse($opts);
$instance = new static($id, $opts);
$instance->refresh();
return $instance;
} | Retrieves the details of an existing ReceivedCredit by passing the unique
ReceivedCredit ID from the ReceivedCredit list.
@param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
@param null|array|string $opts
@return ReceivedCredit
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Treasury/ReceivedCredit.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/ReceivedCredit.php | MIT |
public static function create($params = null, $options = null)
{
self::_validateParams($params);
$url = static::classUrl();
list($response, $opts) = static::_staticRequest('post', $url, $params, $options);
$obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
} | Reverses a ReceivedDebit and creates a DebitReversal object.
@param null|array{expand?: string[], metadata?: \Stripe\StripeObject, received_debit: string} $params
@param null|array|string $options
@return DebitReversal the created resource
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Treasury/DebitReversal.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/DebitReversal.php | MIT |
public static function all($params = null, $opts = null)
{
$url = static::classUrl();
return static::_requestPage($url, \Stripe\Collection::class, $params, $opts);
} | Returns a list of DebitReversals.
@param null|array{ending_before?: string, expand?: string[], financial_account: string, limit?: int, received_debit?: string, resolution?: string, starting_after?: string, status?: string} $params
@param null|array|string $opts
@return \Stripe\Collection<DebitReversal> of ApiResources
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Treasury/DebitReversal.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/DebitReversal.php | MIT |
public static function retrieve($id, $opts = null)
{
$opts = \Stripe\Util\RequestOptions::parse($opts);
$instance = new static($id, $opts);
$instance->refresh();
return $instance;
} | Retrieves a DebitReversal object.
@param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
@param null|array|string $opts
@return DebitReversal
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Treasury/DebitReversal.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/DebitReversal.php | MIT |
public static function create($params = null, $options = null)
{
self::_validateParams($params);
$url = static::classUrl();
list($response, $opts) = static::_staticRequest('post', $url, $params, $options);
$obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
} | Creates an OutboundTransfer.
@param null|array{amount: int, currency: string, description?: string, destination_payment_method?: string, destination_payment_method_data?: array{financial_account?: string, type: string}, destination_payment_method_options?: array{us_bank_account?: null|array{network?: string}}, expand?: string[], financial_account: string, metadata?: \Stripe\StripeObject, statement_descriptor?: string} $params
@param null|array|string $options
@return OutboundTransfer the created resource
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Treasury/OutboundTransfer.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/OutboundTransfer.php | MIT |
public static function all($params = null, $opts = null)
{
$url = static::classUrl();
return static::_requestPage($url, \Stripe\Collection::class, $params, $opts);
} | Returns a list of OutboundTransfers sent from the specified FinancialAccount.
@param null|array{ending_before?: string, expand?: string[], financial_account: string, limit?: int, starting_after?: string, status?: string} $params
@param null|array|string $opts
@return \Stripe\Collection<OutboundTransfer> of ApiResources
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Treasury/OutboundTransfer.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/OutboundTransfer.php | MIT |
public static function retrieve($id, $opts = null)
{
$opts = \Stripe\Util\RequestOptions::parse($opts);
$instance = new static($id, $opts);
$instance->refresh();
return $instance;
} | Retrieves the details of an existing OutboundTransfer by passing the unique
OutboundTransfer ID from either the OutboundTransfer creation request or
OutboundTransfer list.
@param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
@param null|array|string $opts
@return OutboundTransfer
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Treasury/OutboundTransfer.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/OutboundTransfer.php | MIT |
public function cancel($params = null, $opts = null)
{
$url = $this->instanceUrl() . '/cancel';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
return $this;
} | @param null|array $params
@param null|array|string $opts
@return OutboundTransfer the canceled outbound transfer
@throws \Stripe\Exception\ApiErrorException if the request fails | cancel | php | stripe/stripe-php | lib/Treasury/OutboundTransfer.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/OutboundTransfer.php | MIT |
public static function all($params = null, $opts = null)
{
$url = static::classUrl();
return static::_requestPage($url, \Stripe\Collection::class, $params, $opts);
} | Retrieves a list of Transaction objects.
@param null|array{created?: array|int, ending_before?: string, expand?: string[], financial_account: string, limit?: int, order_by?: string, starting_after?: string, status?: string, status_transitions?: array{posted_at?: array|int}} $params
@param null|array|string $opts
@return \Stripe\Collection<Transaction> of ApiResources
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Treasury/Transaction.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/Transaction.php | MIT |
public static function retrieve($id, $opts = null)
{
$opts = \Stripe\Util\RequestOptions::parse($opts);
$instance = new static($id, $opts);
$instance->refresh();
return $instance;
} | Retrieves the details of an existing Transaction.
@param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
@param null|array|string $opts
@return Transaction
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Treasury/Transaction.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/Transaction.php | MIT |
public static function all($params = null, $opts = null)
{
$url = static::classUrl();
return static::_requestPage($url, \Stripe\Collection::class, $params, $opts);
} | Retrieves a list of TransactionEntry objects.
@param null|array{created?: array|int, effective_at?: array|int, ending_before?: string, expand?: string[], financial_account: string, limit?: int, order_by?: string, starting_after?: string, transaction?: string} $params
@param null|array|string $opts
@return \Stripe\Collection<TransactionEntry> of ApiResources
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Treasury/TransactionEntry.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/TransactionEntry.php | MIT |
public static function retrieve($id, $opts = null)
{
$opts = \Stripe\Util\RequestOptions::parse($opts);
$instance = new static($id, $opts);
$instance->refresh();
return $instance;
} | Retrieves a TransactionEntry object.
@param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
@param null|array|string $opts
@return TransactionEntry
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Treasury/TransactionEntry.php | https://github.com/stripe/stripe-php/blob/master/lib/Treasury/TransactionEntry.php | MIT |
public static function create($params = null, $options = null)
{
self::_validateParams($params);
$url = static::classUrl();
list($response, $opts) = static::_staticRequest('post', $url, $params, $options);
$obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
} | Creates a session of the customer portal.
@param null|array{configuration?: string, customer: string, expand?: string[], flow_data?: array{after_completion?: array{hosted_confirmation?: array{custom_message?: string}, redirect?: array{return_url: string}, type: string}, subscription_cancel?: array{retention?: array{coupon_offer: array{coupon: string}, type: string}, subscription: string}, subscription_update?: array{subscription: string}, subscription_update_confirm?: array{discounts?: array{coupon?: string, promotion_code?: string}[], items: array{id: string, price?: string, quantity?: int}[], subscription: string}, type: string}, locale?: string, on_behalf_of?: string, return_url?: string} $params
@param null|array|string $options
@return Session the created resource
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/BillingPortal/Session.php | https://github.com/stripe/stripe-php/blob/master/lib/BillingPortal/Session.php | MIT |
public static function create($params = null, $options = null)
{
self::_validateParams($params);
$url = static::classUrl();
list($response, $opts) = static::_staticRequest('post', $url, $params, $options);
$obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
} | Creates a configuration that describes the functionality and behavior of a
PortalSession.
@param null|array{business_profile?: array{headline?: null|string, privacy_policy_url?: string, terms_of_service_url?: string}, default_return_url?: null|string, expand?: string[], features: array{customer_update?: array{allowed_updates?: null|string[], enabled: bool}, invoice_history?: array{enabled: bool}, payment_method_update?: array{enabled: bool}, subscription_cancel?: array{cancellation_reason?: array{enabled: bool, options: null|string[]}, enabled: bool, mode?: string, proration_behavior?: string}, subscription_update?: array{default_allowed_updates?: null|string[], enabled: bool, products?: null|array{prices: string[], product: string}[], proration_behavior?: string, schedule_at_period_end?: array{conditions?: array{type: string}[]}}}, login_page?: array{enabled: bool}, metadata?: \Stripe\StripeObject} $params
@param null|array|string $options
@return Configuration the created resource
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/BillingPortal/Configuration.php | https://github.com/stripe/stripe-php/blob/master/lib/BillingPortal/Configuration.php | MIT |
public static function all($params = null, $opts = null)
{
$url = static::classUrl();
return static::_requestPage($url, \Stripe\Collection::class, $params, $opts);
} | Returns a list of configurations that describe the functionality of the customer
portal.
@param null|array{active?: bool, ending_before?: string, expand?: string[], is_default?: bool, limit?: int, starting_after?: string} $params
@param null|array|string $opts
@return \Stripe\Collection<Configuration> of ApiResources
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/BillingPortal/Configuration.php | https://github.com/stripe/stripe-php/blob/master/lib/BillingPortal/Configuration.php | MIT |
public static function retrieve($id, $opts = null)
{
$opts = \Stripe\Util\RequestOptions::parse($opts);
$instance = new static($id, $opts);
$instance->refresh();
return $instance;
} | Retrieves a configuration that describes the functionality of the customer
portal.
@param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
@param null|array|string $opts
@return Configuration
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/BillingPortal/Configuration.php | https://github.com/stripe/stripe-php/blob/master/lib/BillingPortal/Configuration.php | MIT |
public static function update($id, $params = null, $opts = null)
{
self::_validateParams($params);
$url = static::resourceUrl($id);
list($response, $opts) = static::_staticRequest('post', $url, $params, $opts);
$obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
} | Updates a configuration that describes the functionality of the customer portal.
@param string $id the ID of the resource to update
@param null|array{active?: bool, business_profile?: array{headline?: null|string, privacy_policy_url?: null|string, terms_of_service_url?: null|string}, default_return_url?: null|string, expand?: string[], features?: array{customer_update?: array{allowed_updates?: null|string[], enabled?: bool}, invoice_history?: array{enabled: bool}, payment_method_update?: array{enabled: bool}, subscription_cancel?: array{cancellation_reason?: array{enabled: bool, options?: null|string[]}, enabled?: bool, mode?: string, proration_behavior?: string}, subscription_update?: array{default_allowed_updates?: null|string[], enabled?: bool, products?: null|array{prices: string[], product: string}[], proration_behavior?: string, schedule_at_period_end?: array{conditions?: null|array{type: string}[]}}}, login_page?: array{enabled: bool}, metadata?: null|\Stripe\StripeObject} $params
@param null|array|string $opts
@return Configuration the updated resource
@throws \Stripe\Exception\ApiErrorException if the request fails | update | php | stripe/stripe-php | lib/BillingPortal/Configuration.php | https://github.com/stripe/stripe-php/blob/master/lib/BillingPortal/Configuration.php | MIT |
public static function create($params = null, $options = null)
{
self::_validateParams($params);
$url = static::classUrl();
list($response, $opts) = static::_staticRequest('post', $url, $params, $options);
$obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
} | Creates a Checkout Session object.
@param null|array{adaptive_pricing?: array{enabled?: bool}, after_expiration?: array{recovery?: array{allow_promotion_codes?: bool, enabled: bool}}, allow_promotion_codes?: bool, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_address_collection?: string, cancel_url?: string, client_reference_id?: string, consent_collection?: array{payment_method_reuse_agreement?: array{position: string}, promotions?: string, terms_of_service?: string}, currency?: string, custom_fields?: array{dropdown?: array{default_value?: string, options: array{label: string, value: string}[]}, key: string, label: array{custom: string, type: string}, numeric?: array{default_value?: string, maximum_length?: int, minimum_length?: int}, optional?: bool, text?: array{default_value?: string, maximum_length?: int, minimum_length?: int}, type: string}[], custom_text?: array{after_submit?: null|array{message: string}, shipping_address?: null|array{message: string}, submit?: null|array{message: string}, terms_of_service_acceptance?: null|array{message: string}}, customer?: string, customer_creation?: string, customer_email?: string, customer_update?: array{address?: string, name?: string, shipping?: string}, discounts?: array{coupon?: string, promotion_code?: string}[], expand?: string[], expires_at?: int, invoice_creation?: array{enabled: bool, invoice_data?: array{account_tax_ids?: null|string[], custom_fields?: null|array{name: string, value: string}[], description?: string, footer?: string, issuer?: array{account?: string, type: string}, metadata?: \Stripe\StripeObject, rendering_options?: null|array{amount_tax_display?: null|string}}}, line_items?: array{adjustable_quantity?: array{enabled: bool, maximum?: int, minimum?: int}, dynamic_tax_rates?: string[], price?: string, price_data?: array{currency: string, product?: string, product_data?: array{description?: string, images?: string[], metadata?: \Stripe\StripeObject, name: string, tax_code?: string}, recurring?: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: string[]}[], locale?: string, metadata?: \Stripe\StripeObject, mode?: string, optional_items?: array{adjustable_quantity?: array{enabled: bool, maximum?: int, minimum?: int}, price: string, quantity: int}[], payment_intent_data?: array{application_fee_amount?: int, capture_method?: string, description?: string, metadata?: \Stripe\StripeObject, on_behalf_of?: string, receipt_email?: string, setup_future_usage?: string, shipping?: array{address: array{city?: string, country?: string, line1: string, line2?: string, postal_code?: string, state?: string}, carrier?: string, name: string, phone?: string, tracking_number?: string}, statement_descriptor?: string, statement_descriptor_suffix?: string, transfer_data?: array{amount?: int, destination: string}, transfer_group?: string}, payment_method_collection?: string, payment_method_configuration?: string, payment_method_data?: array{allow_redisplay?: string}, payment_method_options?: array{acss_debit?: array{currency?: string, mandate_options?: array{custom_mandate_url?: null|string, default_for?: string[], interval_description?: string, payment_schedule?: string, transaction_type?: string}, setup_future_usage?: string, target_date?: string, verification_method?: string}, affirm?: array{setup_future_usage?: string}, afterpay_clearpay?: array{setup_future_usage?: string}, alipay?: array{setup_future_usage?: string}, amazon_pay?: array{setup_future_usage?: string}, au_becs_debit?: array{setup_future_usage?: string, target_date?: string}, bacs_debit?: array{mandate_options?: array{reference_prefix?: null|string}, setup_future_usage?: string, target_date?: string}, bancontact?: array{setup_future_usage?: string}, boleto?: array{expires_after_days?: int, setup_future_usage?: string}, card?: array{installments?: array{enabled?: bool}, request_extended_authorization?: string, request_incremental_authorization?: string, request_multicapture?: string, request_overcapture?: string, request_three_d_secure?: string, restrictions?: array{brands_blocked?: string[]}, setup_future_usage?: string, statement_descriptor_suffix_kana?: string, statement_descriptor_suffix_kanji?: string}, cashapp?: array{setup_future_usage?: string}, customer_balance?: array{bank_transfer?: array{eu_bank_transfer?: array{country: string}, requested_address_types?: string[], type: string}, funding_type?: string, setup_future_usage?: string}, eps?: array{setup_future_usage?: string}, fpx?: array{setup_future_usage?: string}, giropay?: array{setup_future_usage?: string}, grabpay?: array{setup_future_usage?: string}, ideal?: array{setup_future_usage?: string}, kakao_pay?: array{capture_method?: string, setup_future_usage?: string}, klarna?: array{setup_future_usage?: string}, konbini?: array{expires_after_days?: int, setup_future_usage?: string}, kr_card?: array{capture_method?: string, setup_future_usage?: string}, link?: array{setup_future_usage?: string}, mobilepay?: array{setup_future_usage?: string}, multibanco?: array{setup_future_usage?: string}, naver_pay?: array{capture_method?: string, setup_future_usage?: string}, oxxo?: array{expires_after_days?: int, setup_future_usage?: string}, p24?: array{setup_future_usage?: string, tos_shown_and_accepted?: bool}, pay_by_bank?: array{}, payco?: array{capture_method?: string}, paynow?: array{setup_future_usage?: string}, paypal?: array{capture_method?: null|string, preferred_locale?: string, reference?: string, risk_correlation_id?: string, setup_future_usage?: null|string}, pix?: array{expires_after_seconds?: int}, revolut_pay?: array{setup_future_usage?: string}, samsung_pay?: array{capture_method?: string}, sepa_debit?: array{mandate_options?: array{reference_prefix?: null|string}, setup_future_usage?: string, target_date?: string}, sofort?: array{setup_future_usage?: string}, swish?: array{reference?: string}, us_bank_account?: array{financial_connections?: array{permissions?: string[], prefetch?: string[]}, setup_future_usage?: string, target_date?: string, verification_method?: string}, wechat_pay?: array{app_id?: string, client: string, setup_future_usage?: string}}, payment_method_types?: string[], permissions?: array{update_shipping_details?: string}, phone_number_collection?: array{enabled: bool}, redirect_on_completion?: string, return_url?: string, saved_payment_method_options?: array{allow_redisplay_filters?: string[], payment_method_save?: string}, setup_intent_data?: array{description?: string, metadata?: \Stripe\StripeObject, on_behalf_of?: string}, shipping_address_collection?: array{allowed_countries: string[]}, shipping_options?: array{shipping_rate?: string, shipping_rate_data?: array{delivery_estimate?: array{maximum?: array{unit: string, value: int}, minimum?: array{unit: string, value: int}}, display_name: string, fixed_amount?: array{amount: int, currency: string, currency_options?: \Stripe\StripeObject}, metadata?: \Stripe\StripeObject, tax_behavior?: string, tax_code?: string, type?: string}}[], submit_type?: string, subscription_data?: array{application_fee_percent?: float, billing_cycle_anchor?: int, default_tax_rates?: string[], description?: string, invoice_settings?: array{issuer?: array{account?: string, type: string}}, metadata?: \Stripe\StripeObject, on_behalf_of?: string, proration_behavior?: string, transfer_data?: array{amount_percent?: float, destination: string}, trial_end?: int, trial_period_days?: int, trial_settings?: array{end_behavior: array{missing_payment_method: string}}}, success_url?: string, tax_id_collection?: array{enabled: bool, required?: string}, ui_mode?: string, wallet_options?: array{link?: array{display?: string}}} $params
@param null|array|string $options
@return Session the created resource
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Checkout/Session.php | https://github.com/stripe/stripe-php/blob/master/lib/Checkout/Session.php | MIT |
public static function all($params = null, $opts = null)
{
$url = static::classUrl();
return static::_requestPage($url, \Stripe\Collection::class, $params, $opts);
} | Returns a list of Checkout Sessions.
@param null|array{created?: array|int, customer?: string, customer_details?: array{email: string}, ending_before?: string, expand?: string[], limit?: int, payment_intent?: string, payment_link?: string, starting_after?: string, status?: string, subscription?: string} $params
@param null|array|string $opts
@return \Stripe\Collection<Session> of ApiResources
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Checkout/Session.php | https://github.com/stripe/stripe-php/blob/master/lib/Checkout/Session.php | MIT |
public static function retrieve($id, $opts = null)
{
$opts = \Stripe\Util\RequestOptions::parse($opts);
$instance = new static($id, $opts);
$instance->refresh();
return $instance;
} | Retrieves a Checkout Session object.
@param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
@param null|array|string $opts
@return Session
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Checkout/Session.php | https://github.com/stripe/stripe-php/blob/master/lib/Checkout/Session.php | MIT |
public static function update($id, $params = null, $opts = null)
{
self::_validateParams($params);
$url = static::resourceUrl($id);
list($response, $opts) = static::_staticRequest('post', $url, $params, $opts);
$obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
} | Updates a Checkout Session object.
@param string $id the ID of the resource to update
@param null|array{collected_information?: array{shipping_details?: array{address: array{city?: string, country: string, line1: string, line2?: string, postal_code?: string, state?: string}, name: string}}, expand?: string[], metadata?: null|\Stripe\StripeObject, shipping_options?: null|array{shipping_rate?: string, shipping_rate_data?: array{delivery_estimate?: array{maximum?: array{unit: string, value: int}, minimum?: array{unit: string, value: int}}, display_name: string, fixed_amount?: array{amount: int, currency: string, currency_options?: \Stripe\StripeObject}, metadata?: \Stripe\StripeObject, tax_behavior?: string, tax_code?: string, type?: string}}[]} $params
@param null|array|string $opts
@return Session the updated resource
@throws \Stripe\Exception\ApiErrorException if the request fails | update | php | stripe/stripe-php | lib/Checkout/Session.php | https://github.com/stripe/stripe-php/blob/master/lib/Checkout/Session.php | MIT |
public function expire($params = null, $opts = null)
{
$url = $this->instanceUrl() . '/expire';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
return $this;
} | @param null|array $params
@param null|array|string $opts
@return Session the expired session
@throws \Stripe\Exception\ApiErrorException if the request fails | expire | php | stripe/stripe-php | lib/Checkout/Session.php | https://github.com/stripe/stripe-php/blob/master/lib/Checkout/Session.php | MIT |
public static function allLineItems($id, $params = null, $opts = null)
{
$url = static::resourceUrl($id) . '/line_items';
list($response, $opts) = static::_staticRequest('get', $url, $params, $opts);
$obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
} | @param string $id
@param null|array $params
@param null|array|string $opts
@return \Stripe\Collection<\Stripe\LineItem> list of line items
@throws \Stripe\Exception\ApiErrorException if the request fails | allLineItems | php | stripe/stripe-php | lib/Checkout/Session.php | https://github.com/stripe/stripe-php/blob/master/lib/Checkout/Session.php | MIT |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.