# Stark Bank Payment Preview API

**Canonical:** https://apis.io/apis/stark-bank/stark-bank-payment-preview-api/  
**Provider:** Stark Bank — https://apis.io/providers/stark-bank/  
**Base URL:** https://api.starkbank.com  
**Documentation:** https://docs.starkbank.com/api

Stark Bank Payment Preview API is one of 31 APIs that [Stark Bank](https://apis.io/providers/stark-bank/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Payment Preview. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

A Payment Preview is used to get information from multiple types of payment to confirm any information before actually paying. If the 'scheduled' parameter is not informed, today will be assumed as the intended payment date. Right now, the 'scheduled' parameter only has effect on BrcodePreviews. This resource is able to preview the following types of payment: "brcode-payment", "boleto-payment", "utility-payment" and "tax-payment"

## Operations (1)

| Method | Path | Summary |
|---|---|---|
| POST | `/v2/payment-preview` | Create a Payment Preview |

## Machine-readable artifacts (6)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/stark-bank/refs/heads/main/openapi/stark-bank-payment-preview-api-openapi.yml
- **Postman** — https://raw.githubusercontent.com/api-evangelist/stark-bank/refs/heads/main/postman/stark-bank-postman.json
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/stark-bank/refs/heads/main/authentication/stark-bank-authentication.yml
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/stark-bank/refs/heads/main/asyncapi/stark-bank-events-webhooks.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/stark-bank/refs/heads/main/errors/stark-bank-problem-types.yml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/stark-bank/refs/heads/main/data-model/stark-bank-data-model.yml

## Other Stark Bank APIs (12)

- [Stark Bank Balance API](https://apis.io/apis/stark-bank/stark-bank-balance-api/)
- [Stark Bank Boleto API](https://apis.io/apis/stark-bank/stark-bank-boleto-api/)
- [Stark Bank Boleto Holmes API](https://apis.io/apis/stark-bank/stark-bank-boleto-holmes-api/)
- [Stark Bank Boleto Payment API](https://apis.io/apis/stark-bank/stark-bank-boleto-payment-api/)
- [Stark Bank Brcode Payment API](https://apis.io/apis/stark-bank/stark-bank-brcode-payment-api/)
- [Stark Bank Darf Payment API](https://apis.io/apis/stark-bank/stark-bank-darf-payment-api/)
- [Stark Bank Deposit API](https://apis.io/apis/stark-bank/stark-bank-deposit-api/)
- [Stark Bank Dynamic Brcode API](https://apis.io/apis/stark-bank/stark-bank-dynamic-brcode-api/)
- [Stark Bank Event API](https://apis.io/apis/stark-bank/stark-bank-event-api/)
- [Stark Bank Event Attempt API](https://apis.io/apis/stark-bank/stark-bank-event-attempt-api/)
- [Stark Bank Institutions API](https://apis.io/apis/stark-bank/stark-bank-institutions-api/)
- [Stark Bank Invoice API](https://apis.io/apis/stark-bank/stark-bank-invoice-api/)

## Tags

Payment Preview

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/stark-bank/stark-bank-payment-preview-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/stark-bank/.