class Stripe::BalanceTransactionsApi
- Stripe::BalanceTransactionsApi
- Reference
- Object
Defined in:
stripe/api/balance_transactions_api.crConstant Summary
-
GET_BALANCE_TRANSACTIONS_ID_MAX_LENGTH_FOR_ID =
5000 -
GET_BALANCE_TRANSACTIONS_MAX_LENGTH_FOR__TYPE =
5000 -
GET_BALANCE_TRANSACTIONS_MAX_LENGTH_FOR_ENDING_BEFORE =
5000 -
GET_BALANCE_TRANSACTIONS_MAX_LENGTH_FOR_PAYOUT =
5000 -
GET_BALANCE_TRANSACTIONS_MAX_LENGTH_FOR_SOURCE =
5000 -
GET_BALANCE_TRANSACTIONS_MAX_LENGTH_FOR_STARTING_AFTER =
5000
Constructors
Instance Method Summary
- #api_client : ApiClient
- #api_client=(api_client : ApiClient)
-
#build_api_request_for_get_balance_transactions(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, payout : String | Nil = nil, currency : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, source : String | Nil = nil, _type : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_balance_transactions_id(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
- #client_side_validation?(*args, **options)
- #client_side_validation?(*args, **options, &)
- #debugging?(*args, **options)
- #debugging?(*args, **options, &)
-
#get_balance_transactions(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, payout : String | Nil = nil, currency : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, source : String | Nil = nil, _type : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::BalanceTransactionsList
Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth).
-
#get_balance_transactions(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, payout : String | Nil = nil, currency : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, source : String | Nil = nil, _type : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth).
-
#get_balance_transactions_id(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::BalanceTransaction
Retrieves the balance transaction with the given ID.
Note that this endpoint previously used the path
@required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded./v1/balance/history/:id. -
#get_balance_transactions_id(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Retrieves the balance transaction with the given ID.</p> <p>Note that this endpoint previously used the path <code>/v1/balance/history/:id</code>.</p> @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_balance_transactions_id_with_http_info(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::BalanceTransaction, Int32, Hash(String, Array(String) | String))
<p>Retrieves the balance transaction with the given ID.</p> <p>Note that this endpoint previously used the path <code>/v1/balance/history/:id</code>.</p> @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_balance_transactions_with_http_info(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, payout : String | Nil = nil, currency : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, source : String | Nil = nil, _type : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::BalanceTransactionsList, Int32, Hash(String, Array(String) | String))
<p>Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth).
Constructor Detail
Instance Method Detail
@return Crest::Request
@return Crest::Request
Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.
Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.
<p>Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.</p> <p>Note that this endpoint was previously called “Balance history” and used the path <code>/v1/balance/history</code>.</p>
@optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param payout [String?] For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.
@optional @param currency [String?] Only return transactions in a certain currency. Three-letter ISO currency code, in lowercase. Must be a supported currency.
@optional @param created [Stripe::GetAccountsCreatedParameter?] Only return transactions that were created during the given date interval.
@optional @param source [String?] Only returns the original transaction.
@optional @param _type [String?] Only returns transactions of the given type. One of: adjustment, advance, advance_funding, anticipation_repayment, application_fee, application_fee_refund, charge, climate_order_purchase, climate_order_refund, connect_collection_transfer, contribution, issuing_authorization_hold, issuing_authorization_release, issuing_dispute, issuing_transaction, obligation_outbound, obligation_reversal_inbound, payment, payment_failure_refund, payment_network_reserve_hold, payment_network_reserve_release, payment_refund, payment_reversal, payment_unreconciled, payout, payout_cancel, payout_failure, refund, refund_failure, reserve_transaction, reserved_funds, stripe_fee, stripe_fx_fee, tax_fee, topup, topup_reversal, transfer, transfer_cancel, transfer_failure, or transfer_refund.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return nil
Retrieves the balance transaction with the given ID.
Note that this endpoint previously used the path /v1/balance/history/:id.
<p>Retrieves the balance transaction with the given ID.</p> <p>Note that this endpoint previously used the path <code>/v1/balance/history/:id</code>.</p> @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
<p>Retrieves the balance transaction with the given ID.</p> <p>Note that this endpoint previously used the path <code>/v1/balance/history/:id</code>.</p> @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::BalanceTransaction, Integer, Hash)] Stripe::BalanceTransaction, response status code and response headers
<p>Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.</p> <p>Note that this endpoint was previously called “Balance history” and used the path <code>/v1/balance/history</code>.</p>
@optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param payout [String?] For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.
@optional @param currency [String?] Only return transactions in a certain currency. Three-letter ISO currency code, in lowercase. Must be a supported currency.
@optional @param created [Stripe::GetAccountsCreatedParameter?] Only return transactions that were created during the given date interval.
@optional @param source [String?] Only returns the original transaction.
@optional @param _type [String?] Only returns transactions of the given type. One of: adjustment, advance, advance_funding, anticipation_repayment, application_fee, application_fee_refund, charge, climate_order_purchase, climate_order_refund, connect_collection_transfer, contribution, issuing_authorization_hold, issuing_authorization_release, issuing_dispute, issuing_transaction, obligation_outbound, obligation_reversal_inbound, payment, payment_failure_refund, payment_network_reserve_hold, payment_network_reserve_release, payment_refund, payment_reversal, payment_unreconciled, payout, payout_cancel, payout_failure, refund, refund_failure, reserve_transaction, reserved_funds, stripe_fee, stripe_fx_fee, tax_fee, topup, topup_reversal, transfer, transfer_cancel, transfer_failure, or transfer_refund.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return [Tuple(Stripe::BalanceTransactionsList, Integer, Hash)] Stripe::BalanceTransactionsList, response status code and response headers