Stripe API Docs Writing Samples Portfolio

Sample Stripe API Documentation

Introduction

Use this API for.... whatever.

How to Connect to the Stripe API

To connect to the Stripe API, you need to use the https://api.stripe.com base URL. You also need to register for an account on stripe.com to be able to get full access... yadda yadda yadda.

How to Authenticate to the Stripe API

go there... do that... obtain the API key Stripe API supports the following types of authentication

• bearer token
• ...
• ... give an example of how it may look:

Requests and Responses of the Stripe API

what are the requests you can use what can you expect as a response

Functionality

what can you do with this Stripe API? as a developer using the Stripe API you can:

• check balance on a credit card
• create events
• etc

Balance

you can use the balance request to find out what is the available amount on a credit card

GET operation is the only possible type for this request Endpoint for this operation: {{baseUrl}}/v1/balance

Responses

Responses will return standard code. Response Code: 200: OK

{ "object": "balance", "available": [ { "amount": 0, "currency": "usd", "source_types": { "card": 0 } } ], "livemode": false, "pending": [ { "amount": 0, "currency": "usd", "source_types": { "card": 0 } } ] }

Parameters:

<parameter 1> - when you should use it, type (optional/mandatory), does it use prefixed values, enter an example