My API Documentation Writing Samples ‐ - excell604/api_documentation_writing_sample GitHub Wiki
Technical writing portfolio
Sample Stripe API Documentation
Intro
-> Offers collections of APIs you can use to manage a wide range of payment-related tasks; Use this API for finance management of online stores.....
How to Connect to the Stripe API
... To connect to the Stripe API, you need to use the stripe API base URL. You also need to register for an account on stripe.com, to be able to get full access
How to authenticate to the Stripe API
Stripe API supports the following types of authentication:
- bearer token
Requests and Responses of the Stripe API
what requests can be used..... what can you expect as a response....
Functionality
As a developer using the Stripe API you can:
- Check the balance of the credit card
Balance
You can use the balance request to find out the amount available on a credit card.
GET operation is possible only for this request
{{baseUrl}}/v1/balance
Responses
Responses will return standard codes.
Response Code 200: OK
{
"object": "balance",
"available": [
{
"amount": 0,
"currency": "cad",
"source_types": {
"card": 0
}
}
],
"livemode": false,
"pending": [
{
"amount": 0,
"currency": "cad",
"source_types": {
"card": 0
}
}
]
}