Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.
", + "operationId": "PayoutAll", + "parameters": [ + { + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", + "in": "query", + "name": "limit", + "required": false, + "type": "integer" + }, + { + "description": "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.", + "in": "query", + "name": "starting_after", + "required": false, + "type": "string" + }, + { + "description": "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.", + "in": "query", + "name": "ending_before", + "required": false, + "type": "string" + }, + { + "description": "", + "in": "query", + "name": "arrival_date", + "required": false, + "type": "integer" + }, + { + "description": "", + "in": "query", + "name": "created", + "required": false, + "type": "integer" + }, + { + "description": "The ID of an external account - only return payouts sent to this external account.", + "in": "query", + "name": "destination", + "required": false, + "type": "string" + }, + { + "description": "Only return payouts that have the given status: `pending`, `paid`, `failed`, `in_transit`, or `canceled`.", + "in": "query", + "name": "status", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/payout" + }, + "type": [ + "array" + ] + }, + "has_more": { + "description": "True if this list has another page of items after this one that can be fetched.", + "type": [ + "boolean" + ] + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value. Always has the value \"list\".", + "enum": [ + "list" + ], + "type": [ + "string" + ] + }, + "total_count": { + "description": "The total number of items available. This value is not included by default, but you can request it by specifying ?include[]=total_count.", + "type": [ + "integer" + ] + }, + "url": { + "description": "The URL where this list can be accessed.", + "enum": [ + "/v1/payouts" + ], + "type": [ + "string" + ] + } + }, + "required": [ + "data", + "has_more", + "object", + "url" + ], + "title": "PayoutList", + "type": [ + "object" + ] + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/error" + } + } + } + }, + "post": { + "description": "To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.
If your API key is in test mode, money won’t actually be sent, though everything else will occur as if in live mode.
If you are creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type.
", + "operationId": "PayoutCreate", + "parameters": [ + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": true, + "schema": { + "properties": { + "amount": { + "description": "A positive integer in cents representing how much to payout.", + "title": "amount", + "type": [ + "integer" + ] + }, + "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).", + "title": "currency", + "type": [ + "string" + ] + }, + "destination": { + "description": "The id of a bank account or a card to send the payout to. If no destination is supplied, the default external account for the specified currency will be used.", + "title": "destination", + "type": [ + "string" + ] + }, + "metadata": { + "description": "A set of key/value pairs that you can attach to a payout object. It can be useful for storing additional information about the payout in a structured format.", + "title": "metadata", + "type": [ + "object" + ] + }, + "method": { + "description": "The method used to send this payout, which can be `standard` or `instant`. `instant` is only supported for payouts to debit cards. (See [Instant payouts for marketplaces for more information](https://stripe.com/blog/instant-payouts-for-marketplaces).)", + "title": "method", + "type": [ + "string" + ] + }, + "source_type": { + "description": "The source balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the balances API. Valid options are: `alipay_account`, `bank_account`, `bitcoin_receiver`, and `card`.", + "title": "source_type", + "type": [ + "string" + ] + }, + "statement_descriptor": { + "description": "A string to be displayed on the recipient's bank or card statement. This may be at most 22 characters. Attempting to use a `statement_descriptor` longer than 22 characters will return an error. Note: Most banks will truncate this information and/or display it inconsistently. Some may not display it at all.", + "title": "statement_descriptor", + "type": [ + "string" + ] + } + }, + "required": [ + "amount", + "currency" + ] + } + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/payout" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/error" + } + } + } + } + }, + "/v1/payouts/{id}": { + "get": { + "description": "Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list, and Stripe will return the corresponding payout information.
", + "operationId": "PayoutRetrieve", + "parameters": [ + { + "description": "The identifier of the payout to be retrieved.", + "in": "path", + "name": "id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/payout" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/error" + } + } + } + }, + "post": { + "description": "Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.
", + "operationId": "PayoutUpdate", + "parameters": [ + { + "description": "The identifier of the payout to be updated.", + "in": "path", + "name": "id", + "required": true, + "type": "string" + }, + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": false, + "schema": { + "properties": { + "metadata": { + "description": "A set of key/value pairs that you can attach to a payout object. It can be useful for storing additional information about the payout in a structured format.", + "title": "metadata", + "type": [ + "object" + ] + } + } + } + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/payout" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/error" + } + } + } + } + }, + "/v1/payouts/{id}/cancel": { + "post": { + "description": "A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance, and the fees you were originally charged on the payout will be refunded. You may not cancel automatic Stripe payouts.
", + "operationId": "PayoutCancel", + "parameters": [ + { + "description": "The identifier of the payout to be canceled.", + "in": "path", + "name": "id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/payout" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/error" + } + } + } + } + }, "/v1/plans": { "get": { "description": "Returns a list of your plans.
", @@ -16021,7 +16458,7 @@ ] }, "currency": { - "description": "Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).", + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).", "title": "currency", "type": [ "string" @@ -17811,7 +18248,7 @@ ] }, "currency": { - "description": "Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).", + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).", "title": "currency", "type": [ "string" @@ -17980,7 +18417,7 @@ ] }, "currency": { - "description": "Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).", + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).", "title": "currency", "type": [ "string" @@ -19186,7 +19623,7 @@ }, "/v1/transfers": { "get": { - "description": "", + "description": "Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.
", "operationId": "AllTransfers", "parameters": [ { @@ -19210,13 +19647,6 @@ "required": false, "type": "string" }, - { - "description": "", - "in": "query", - "name": "amount", - "required": false, - "type": "integer" - }, { "description": "", "in": "query", @@ -19225,25 +19655,18 @@ "type": "integer" }, { - "description": "", + "description": "Only return transfers for the destination specified by this account ID.", "in": "query", "name": "destination", "required": false, "type": "string" }, { - "description": "", + "description": "Only return transfers with the specified transfer group.", "in": "query", "name": "transfer_group", "required": false, "type": "string" - }, - { - "description": "", - "in": "query", - "name": "currency", - "required": false, - "type": "string" } ], "responses": { @@ -19396,11 +19819,11 @@ }, "/v1/transfers/{id}": { "get": { - "description": "", + "description": "Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.
", "operationId": "RetrieveTransfer", "parameters": [ { - "description": "", + "description": "The identifier of the transfer to be retrieved.", "in": "path", "name": "id", "required": true, diff --git a/openapi/spec2.yaml b/openapi/spec2.yaml index 3a792eec..7d4db152 100644 --- a/openapi/spec2.yaml +++ b/openapi/spec2.yaml @@ -114,6 +114,20 @@ definitions: - string orders: "$ref": "#/definitions/settings" + payout_schedule: + "$ref": "#/definitions/transfer_schedule" + payout_statement_descriptor: + description: The text that will appear on the account's bank account statement + for payouts. If not set, this will default to your platform's bank descriptor + set on the Dashboard. + type: + - string + payouts_enabled: + description: Whether or not Stripe will send automatic transfers for this + account. This is only false when Stripe is waiting for additional information + from the account holder. + type: + - boolean product_description: description: An internal-only description of the product or service provided. This is used by Stripe in the event the account gets flagged for potential @@ -141,20 +155,6 @@ definitions: - string tos_acceptance: "$ref": "#/definitions/account_tos_acceptance" - transfer_schedule: - "$ref": "#/definitions/transfer_schedule" - transfer_statement_descriptor: - description: The text that will appear on the account's bank account statement - for payouts. If not set, this will default to your platform's bank descriptor - set on the Dashboard. - type: - - string - transfers_enabled: - description: Whether or not Stripe will send automatic transfers for this - account. This is only false when Stripe is waiting for additional information - from the account holder. - type: - - boolean verification: "$ref": "#/definitions/account_verification" required: @@ -170,9 +170,9 @@ definitions: - legal_entity - managed - object + - payout_schedule + - payouts_enabled - tos_acceptance - - transfer_schedule - - transfers_enabled - verification title: Account type: @@ -363,6 +363,20 @@ definitions: - string orders: "$ref": "#/definitions/settings" + payout_schedule: + "$ref": "#/definitions/transfer_schedule" + payout_statement_descriptor: + description: The text that will appear on the account's bank account statement + for payouts. If not set, this will default to your platform's bank descriptor + set on the Dashboard. + type: + - string + payouts_enabled: + description: Whether or not Stripe will send automatic transfers for this + account. This is only false when Stripe is waiting for additional information + from the account holder. + type: + - boolean product_description: description: An internal-only description of the product or service provided. This is used by Stripe in the event the account gets flagged for potential @@ -390,20 +404,6 @@ definitions: - string tos_acceptance: "$ref": "#/definitions/account_tos_acceptance" - transfer_schedule: - "$ref": "#/definitions/transfer_schedule" - transfer_statement_descriptor: - description: The text that will appear on the account's bank account statement - for payouts. If not set, this will default to your platform's bank descriptor - set on the Dashboard. - type: - - string - transfers_enabled: - description: Whether or not Stripe will send automatic transfers for this - account. This is only false when Stripe is waiting for additional information - from the account holder. - type: - - boolean verification: "$ref": "#/definitions/account_verification" required: @@ -420,9 +420,9 @@ definitions: - legal_entity - managed - object + - payout_schedule + - payouts_enabled - tos_acceptance - - transfer_schedule - - transfers_enabled - verification title: AccountWithKeys type: @@ -643,7 +643,7 @@ definitions: type: - integer currency: - description: Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). type: - string @@ -1255,7 +1255,7 @@ definitions: type: - integer currency: - description: Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). type: - string @@ -2022,7 +2022,7 @@ definitions: type: - integer currency: - description: Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). type: - string @@ -2303,7 +2303,7 @@ definitions: type: - string currency: - description: Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). type: - string @@ -2342,7 +2342,7 @@ definitions: type: - integer currency: - description: Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). type: - string @@ -2451,7 +2451,7 @@ definitions: type: - boolean currency: - description: Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). type: - string @@ -2650,7 +2650,7 @@ definitions: type: - integer currency: - description: Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). type: - string @@ -2744,7 +2744,7 @@ definitions: type: - integer currency: - description: Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). type: - string @@ -2852,7 +2852,7 @@ definitions: type: - integer currency: - description: Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). type: - string @@ -3289,7 +3289,7 @@ definitions: type: - integer currency: - description: Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). type: - string @@ -3413,7 +3413,7 @@ definitions: type: - integer currency: - description: Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). type: - string @@ -3482,7 +3482,7 @@ definitions: type: - integer currency: - description: Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). type: - string @@ -3549,6 +3549,121 @@ definitions: type: - object x-resourceId: package_dimensions + payout: + properties: + amount: + description: Amount (in %s) to be transferred to your bank account or debit + card. + type: + - integer + arrival_date: + description: Date the payout is expected to arrive in the bank. This factors + in delays like weekends or bank holidays. + type: + - integer + balance_transaction: + description: ID of the balance transaction that describes the impact of this + payout on your account balance. + type: + - string + created: + description: Time at which the object was created. Measured in seconds since + the Unix epoch. + type: + - integer + currency: + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), + in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). + type: + - string + destination: + description: ID of the bank account or card the payout was sent to. + type: + - string + failure_balance_transaction: + description: If the payout failed or was canceled, this will be the ID of + the balance transaction that reversed the initial balance transaction, and + puts the funds from the failed payout back in your balance. + type: + - string + failure_code: + description: Error code explaining reason for payout failure if available. + See [Types of payout failures](/docs/api#payout_failures) for a list of + failure codes. + type: + - string + failure_message: + description: Message to user further explaining reason for payout failure + if available. + type: + - string + id: + description: Unique identifier for the object. + type: + - string + livemode: + description: Flag indicating whether the object exists in live mode or test + mode. + type: + - boolean + metadata: + description: Set of key/value pairs that you can attach to an object. It can + be useful for storing additional information about the object in a structured + format. + type: + - object + method: + description: The method used to send this payout, which can be `standard` + or `instant`. `instant` is only supported for payouts to debit cards. (See + [Instant payouts for marketplaces](/blog/instant-payouts-for-marketplaces) + for more information.) + type: + - string + object: + description: String representing the object's type. Objects of the same type + share the same value. + type: + - string + source_type: + description: The source balance this payout came from. One of `card`, `bank_account`, + `bitcoin_receiver`, or `alipay_account`. + type: + - string + statement_descriptor: + description: Extra information about a payout to be displayed on the user's + bank statement. + type: + - string + status: + description: Current status of the payout (`paid`, `pending`, `in_transit`, + `canceled` or `failed`). A payout will be `pending` until it is submitted + to the bank, at which point it becomes `in_transit`. It will then change + to `paid` if the transaction goes through. If it does not go through successfully, + its status will change to `failed` or `canceled`. + type: + - string + type: + description: Can be `bank_account` or `card`. + type: + - string + required: + - amount + - arrival_date + - created + - currency + - destination + - id + - livemode + - metadata + - method + - object + - source_type + - status + - type + title: Payout + type: + - object + x-resourceId: payout plan: properties: amount: @@ -3561,7 +3676,7 @@ definitions: type: - integer currency: - description: Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). type: - string @@ -3659,7 +3774,7 @@ definitions: type: - integer currency: - description: Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). type: - string @@ -3887,7 +4002,7 @@ definitions: type: - integer currency: - description: Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). type: - string @@ -4010,7 +4125,7 @@ definitions: type: - integer currency: - description: Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). type: - string @@ -4093,7 +4208,7 @@ definitions: type: - integer currency: - description: Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). type: - string @@ -4129,7 +4244,7 @@ definitions: type: - integer currency: - description: Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). type: - string @@ -4685,7 +4800,7 @@ definitions: type: - integer currency: - description: Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). type: - string @@ -4937,7 +5052,7 @@ definitions: type: - string currency: - description: Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). type: - string @@ -5021,33 +5136,35 @@ definitions: transfer: properties: amount: - description: '' + description: Amount in %s to be transferred. type: - integer amount_reversed: - description: '' + description: Amount in %s reversed (can be less than the amount attribute + on the transfer if a partial reversal was issued). type: - integer balance_transaction: - description: '' + description: Balance transaction that describes the impact of this transfer + on your account balance. type: - string created: - description: Time at which the object was created. Measured in seconds since - the Unix epoch. + description: Time that this record of the transfer was first created. type: - integer currency: - description: Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). type: - string destination: - description: '' + description: ID of the Stripe account the transfer was sent to. type: - string destination_payment: - description: '' + description: If the destination is a Stripe account, this will be the ID of + the payment that the destination account received for the transfer. type: - string id: @@ -5060,9 +5177,9 @@ definitions: type: - boolean metadata: - description: Set of key/value pairs that you can attach to an object. It can - be useful for storing additional information about the object in a structured - format. + description: A set of key/value pairs that you can attach to a transfer object. + It can be useful for storing additional information about the transfer in + a structured format. type: - object object: @@ -5107,7 +5224,8 @@ definitions: type: - object reversed: - description: '' + description: Whether or not the transfer has been fully reversed. If the transfer + is only partially reversed, this attribute will still be false. type: - boolean source_type: @@ -5115,7 +5233,9 @@ definitions: type: - string transfer_group: - description: '' + description: A string that identifies this transaction as part of a group. + See the [Connect documentation](/docs/connect/charges-transfers#grouping-transactions) + for details. type: - string required: @@ -5262,7 +5382,7 @@ definitions: type: - integer currency: - description: Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). type: - string @@ -5427,7 +5547,7 @@ definitions: type: - boolean currency: - description: Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). type: - string @@ -5624,7 +5744,7 @@ info: details. termsOfService: https://stripe.com/us/terms/ title: Stripe API - version: '2017-02-14' + version: '2017-04-06' paths: "/v1/3d_secure": post: @@ -5650,7 +5770,7 @@ paths: type: - string currency: - description: Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). title: currency type: @@ -5851,6 +5971,21 @@ paths: title: orders type: - object + payout_schedule: + description: Details on when this account will make funds from charges + available, and when they will be paid out to the account holder's + bank account. See our [managed account bank transfer guide](/docs/connect/bank-transfers#payout-information) + for more information. + title: payout_schedule + type: + - object + payout_statement_descriptor: + description: The text that will appear on the account's bank account + statement for payouts. If not set, this will default to your platform's + bank descriptor set on the Dashboard. + title: payout_statement_descriptor + type: + - string product_description: description: Internal-only description of the product being sold or service being provided by this account. It's used by Stripe for risk @@ -5889,21 +6024,6 @@ paths: title: tos_acceptance type: - object - transfer_schedule: - description: Details on when this account will make funds from charges - available, and when they will be paid out to the account holder's - bank account. See our [managed account bank transfer guide](/docs/connect/bank-transfers#payout-information) - for more information. - title: transfer_schedule - type: - - object - transfer_statement_descriptor: - description: The text that will appear on the account's bank account - statement for payouts. If not set, this will default to your platform's - bank descriptor set on the Dashboard. - title: transfer_statement_descriptor - type: - - string responses: '200': description: Successful response. @@ -6364,6 +6484,21 @@ paths: title: orders type: - object + payout_schedule: + description: Details on when this account will make funds from charges + available, and when they will be paid out to the account holder's + bank account. See our [managed account bank transfer guide](/docs/connect/bank-transfers#payout-information) + for more information. + title: payout_schedule + type: + - object + payout_statement_descriptor: + description: The text that will appear on the account's bank account + statement for payouts. If not set, this will default to your platform's + bank descriptor set on the Dashboard. + title: payout_statement_descriptor + type: + - string platform_account: description: '' title: platform_account @@ -6407,21 +6542,6 @@ paths: title: tos_acceptance type: - object - transfer_schedule: - description: Details on when this account will make funds from charges - available, and when they will be paid out to the account holder's - bank account. See our [managed account bank transfer guide](/docs/connect/bank-transfers#payout-information) - for more information. - title: transfer_schedule - type: - - object - transfer_statement_descriptor: - description: The text that will appear on the account's bank account - statement for payouts. If not set, this will default to your platform's - bank descriptor set on the Dashboard. - title: transfer_statement_descriptor - type: - - string responses: '200': description: Successful response. @@ -6578,6 +6698,21 @@ paths: title: orders type: - object + payout_schedule: + description: Details on when this account will make funds from charges + available, and when they will be paid out to the account holder's + bank account. See our [managed account bank transfer guide](/docs/connect/bank-transfers#payout-information) + for more information. + title: payout_schedule + type: + - object + payout_statement_descriptor: + description: The text that will appear on the account's bank account + statement for payouts. If not set, this will default to your platform's + bank descriptor set on the Dashboard. + title: payout_statement_descriptor + type: + - string product_description: description: Internal-only description of the product being sold or service being provided by this account. It's used by Stripe for risk @@ -6616,21 +6751,6 @@ paths: title: tos_acceptance type: - object - transfer_schedule: - description: Details on when this account will make funds from charges - available, and when they will be paid out to the account holder's - bank account. See our [managed account bank transfer guide](/docs/connect/bank-transfers#payout-information) - for more information. - title: transfer_schedule - type: - - object - transfer_statement_descriptor: - description: The text that will appear on the account's bank account - statement for payouts. If not set, this will default to your platform's - bank descriptor set on the Dashboard. - title: transfer_statement_descriptor - type: - - string responses: '200': description: Successful response. @@ -7449,10 +7569,10 @@ paths: name: ending_before required: false type: string - - description: For automatic Stripe transfers only, only returns transactions - that were transferred out on the specified transfer ID. + - description: For automatic Stripe payouts only, only returns transactions + that were payed out on the specified payout ID. in: query - name: transfer + name: payout required: false type: string - description: '' @@ -7466,8 +7586,8 @@ paths: required: false type: integer - description: 'Only returns transactions of the given type. One of: `charge`, - `refund`, `adjustment`, `application_fee`, `application_fee_refund`, `payment`, - `transfer`, or `transfer_failure`.' + `refund`, `adjustment`, `application_fee`, `application_fee_refund`, `transfer`, + `payment`, `payout`, or `payout_failure`.' in: query name: type required: false @@ -11309,7 +11429,7 @@ paths: type: - integer currency: - description: Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). title: currency type: @@ -12239,7 +12359,7 @@ paths: type: - string currency: - description: Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). title: currency type: @@ -12571,6 +12691,258 @@ paths: description: Error response. schema: "$ref": "#/definitions/error" + "/v1/payouts": + get: + description: "Returns a list of existing payouts sent to third-party bank + accounts or that Stripe has sent you. The payouts are returned in sorted order, + with the most recently created payouts appearing first.
" + operationId: PayoutAll + parameters: + - description: A limit on the number of objects to be returned. Limit can range + between 1 and 100 items. + in: query + name: limit + required: false + type: integer + - description: 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. + in: query + name: starting_after + required: false + type: string + - description: 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. + in: query + name: ending_before + required: false + type: string + - description: '' + in: query + name: arrival_date + required: false + type: integer + - description: '' + in: query + name: created + required: false + type: integer + - description: The ID of an external account - only return payouts sent to this + external account. + in: query + name: destination + required: false + type: string + - description: 'Only return payouts that have the given status: `pending`, `paid`, + `failed`, `in_transit`, or `canceled`.' + in: query + name: status + required: false + type: string + responses: + '200': + description: Successful response. + schema: + properties: + data: + items: + "$ref": "#/definitions/payout" + type: + - array + has_more: + description: True if this list has another page of items after this + one that can be fetched. + type: + - boolean + object: + description: String representing the object's type. Objects of the + same type share the same value. Always has the value "list". + enum: + - list + type: + - string + total_count: + description: The total number of items available. This value is not + included by default, but you can request it by specifying ?include[]=total_count. + type: + - integer + url: + description: The URL where this list can be accessed. + enum: + - "/v1/payouts" + type: + - string + required: + - data + - has_more + - object + - url + title: PayoutList + type: + - object + default: + description: Error response. + schema: + "$ref": "#/definitions/error" + post: + description:To send funds to your own bank account, you create a new payout + object. Your Stripe balance must be able to cover the + payout amount, or you’ll receive an “Insufficient Funds” error.
If your + API key is in test mode, money won’t actually be sent, though everything else + will occur as if in live mode.
If you are creating a manual payout on + a Stripe account that uses multiple payment source types, you’ll need to specify + the source type balance that the payout should draw from. The balance + object details available and pending amounts by source type.
+ operationId: PayoutCreate + parameters: + - description: Body parameters for the request. + in: body + name: payload + required: true + schema: + properties: + amount: + description: A positive integer in cents representing how much to payout. + title: amount + type: + - integer + currency: + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), + in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). + title: currency + type: + - string + destination: + description: The id of a bank account or a card to send the payout to. + If no destination is supplied, the default external account for the + specified currency will be used. + title: destination + type: + - string + metadata: + description: A set of key/value pairs that you can attach to a payout + object. It can be useful for storing additional information about + the payout in a structured format. + title: metadata + type: + - object + method: + description: The method used to send this payout, which can be `standard` + or `instant`. `instant` is only supported for payouts to debit cards. + (See [Instant payouts for marketplaces for more information](https://stripe.com/blog/instant-payouts-for-marketplaces).) + title: method + type: + - string + source_type: + description: 'The source balance to draw this payout from. Balances + for different payment sources are kept separately. You can find the + amounts with the balances API. Valid options are: `alipay_account`, + `bank_account`, `bitcoin_receiver`, and `card`.' + title: source_type + type: + - string + statement_descriptor: + description: 'A string to be displayed on the recipient''s bank or card + statement. This may be at most 22 characters. Attempting to use a + `statement_descriptor` longer than 22 characters will return an error. + Note: Most banks will truncate this information and/or display it + inconsistently. Some may not display it at all.' + title: statement_descriptor + type: + - string + required: + - amount + - currency + responses: + '200': + description: Successful response. + schema: + "$ref": "#/definitions/payout" + default: + description: Error response. + schema: + "$ref": "#/definitions/error" + "/v1/payouts/{id}": + get: + description: "Retrieves the details of an existing payout. Supply the unique + payout ID from either a payout creation request or the payout list, and Stripe + will return the corresponding payout information.
" + operationId: PayoutRetrieve + parameters: + - description: The identifier of the payout to be retrieved. + in: path + name: id + required: true + type: string + responses: + '200': + description: Successful response. + schema: + "$ref": "#/definitions/payout" + default: + description: Error response. + schema: + "$ref": "#/definitions/error" + post: + description: "Updates the specified payout by setting the values of the parameters + passed. Any parameters not provided will be left unchanged. This request accepts + only the metadata as arguments.
" + operationId: PayoutUpdate + parameters: + - description: The identifier of the payout to be updated. + in: path + name: id + required: true + type: string + - description: Body parameters for the request. + in: body + name: payload + required: false + schema: + properties: + metadata: + description: A set of key/value pairs that you can attach to a payout + object. It can be useful for storing additional information about + the payout in a structured format. + title: metadata + type: + - object + responses: + '200': + description: Successful response. + schema: + "$ref": "#/definitions/payout" + default: + description: Error response. + schema: + "$ref": "#/definitions/error" + "/v1/payouts/{id}/cancel": + post: + description: "A previously created payout can be canceled if it has not yet + been paid out. Funds will be refunded to your available balance, and the fees + you were originally charged on the payout will be refunded. You may not cancel + automatic Stripe payouts.
" + operationId: PayoutCancel + parameters: + - description: The identifier of the payout to be canceled. + in: path + name: id + required: true + type: string + responses: + '200': + description: Successful response. + schema: + "$ref": "#/definitions/payout" + default: + description: Error response. + schema: + "$ref": "#/definitions/error" "/v1/plans": get: description: "Returns a list of your plans.
" @@ -12670,7 +13042,7 @@ paths: type: - integer currency: - description: Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). title: currency type: @@ -14055,7 +14427,7 @@ paths: type: - object currency: - description: Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). title: currency type: @@ -14190,7 +14562,7 @@ paths: type: - object currency: - description: Three-letter [ISO currency code](https://support.stripe.com/questions/which-currencies-does-stripe-support#currencygroup1), + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). title: currency type: @@ -15193,7 +15565,9 @@ paths: "$ref": "#/definitions/error" "/v1/transfers": get: - description: '' + description: "Returns a list of existing transfers sent to connected accounts. + The transfers are returned in sorted order, with the most recently created + transfers appearing first.
" operationId: AllTransfers parameters: - description: A limit on the number of objects to be returned. Limit can range @@ -15220,31 +15594,22 @@ paths: name: ending_before required: false type: string - - description: '' - in: query - name: amount - required: false - type: integer - description: '' in: query name: created required: false type: integer - - description: '' + - description: Only return transfers for the destination specified by this account + ID. in: query name: destination required: false type: string - - description: '' + - description: Only return transfers with the specified transfer group. in: query name: transfer_group required: false type: string - - description: '' - in: query - name: currency - required: false - type: string responses: '200': description: Successful response. @@ -15349,10 +15714,12 @@ paths: "$ref": "#/definitions/error" "/v1/transfers/{id}": get: - description: '' + description: "Retrieves the details of an existing transfer. Supply the unique + transfer ID from either a transfer creation request or the transfer list, + and Stripe will return the corresponding transfer information.
" operationId: RetrieveTransfer parameters: - - description: '' + - description: The identifier of the transfer to be retrieved. in: path name: id required: true