How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Stripe Transfers API

A Transfer object is created when you move funds between Stripe accounts as part of Connect.

Stripe Transfers API is one of 159 APIs that Stripe publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Transfers. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 8 operations across 4 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 2023-10-16.

Requests are made against a single base URL, https://api.stripe.com/.

8 operations 4 paths 13 schemas 4 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2023-10-16
Server
https://api.stripe.com/
Authentication
HTTP Basic, HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 2

Stripe Transfers API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (auth-scheme) (bearerAuth). By default, every request must be authenticated.

  • basicAuth — Basic HTTP authentication. Allowed headers-- Authorization: Basic | Authorization: Basic
  • bearerAuth — Bearer HTTP authentication. Allowed headers-- Authorization: Bearer

Paths & Operations 8

Across 4 paths, the API surfaces 8 operations — 4 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Transfers 8
GET
/v1/transfers
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.
GetTransfers 7 params body → 200default
POST
/v1/transfers
To send funds from your Stripe account to a connected account, you create a new transfer object. Your Stripe balance must be able to cover the transfer amount, or you’ll receive an “Insufficient Fund…
PostTransfers body → 200default
GET
/v1/transfers/{id}/reversals
You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, yo…
GetTransfersIdReversals 5 params body → 200default
POST
/v1/transfers/{id}/reversals
When you create a new reversal, you must specify a transfer to create it on. When reversing transfers, you can optionally reverse part of the transfer. You can do so as many times as you wish until t…
PostTransfersIdReversals 1 param body → 200default
GET
/v1/transfers/{transfer}
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 informatio…
GetTransfersTransfer 2 params body → 200default
POST
/v1/transfers/{transfer}
Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only metadata as an argument.
PostTransfersTransfer 1 param body → 200default
GET
/v1/transfers/{transfer}/reversals/{id}
By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.
GetTransfersTransferReversalsId 3 params body → 200default
POST
/v1/transfers/{transfer}/reversals/{id}
Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request only accepts metadata and description as arguments.
PostTransfersTransferReversalsId 2 params body → 200default

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are transfer (17 properties), transfer_reversal (10 properties), PostTransfersRequest (9 properties), PostTransfersIdReversalsRequest (5 properties). Each schema is shown below with its type and property counts.

GetTransfersIdReversalsRequest
object
PostTransfersTransferReversalsIdRequest
object
2 properties
PostTransfersTransferRequest
object
3 properties
PostTransfersRequest
object
9 properties 2 required
error
object
An error response from the Stripe API
1 property 1 required
GetTransfersTransferReversalsIdRequest
object
transfer
object
A Transfer object is created when you move funds between Stripe accounts as part of Connect. Before April 6, 2017, transfers also represented movement of funds…
17 properties 10 required
PostTransfersIdReversalsRequest
object
5 properties
transfer_reversal
object
[Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a connected account, either entirely or partially, and can also speci…
10 properties 6 required
TransferList
object
4 properties 4 required
GetTransfersTransferRequest
object
TransferReversalList
object
4 properties 4 required
GetTransfersRequest
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

stripe-transfers-api-openapi.yml Raw ↑

Other APIs Stripe publishes across the network.

Stripe Accounts API
Stripe Balance API
Stripe Billing API
Stripe Charges API
Stripe Checkout API
Stripe Climate API
Stripe Country API
Stripe Coupons API
Stripe Credit Notes API
Stripe Customers API
Stripe Disputes API
Stripe Ephemeral Keys API
Where this information came from

This is an independent, third-party profile of Stripe Transfers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.