---
title: "Create a Payment Preview"
method: POST
path: "/v2/payment-preview"
tags: ["Payment Preview"]
---

# Create a Payment Preview

`POST /v2/payment-preview`

## Request

- Base URL: `https://api.starkbank.com`
- URL: `https://api.starkbank.com/v2/payment-preview`
- Auth: API key in header `Digital-Signature`

Create a payment preview to get information from a payment.

## Request body

- object
  - `id` string, required: Main identification of the payment. This should be the BR Code for Pix payments and lines or bar codes for payment slips. Example: '34191.09008 63571.277308 71444.640008 5 81960000000062'.
  - `scheduled` string, date-time: Intended payment date. Right now, this parameter only has effect on BrcodePreviews. Example: '2020-03-10'

## Response `200`

Successful operation

- object

## Other responses

- `400`: Client error
- `500`: Server error

---

[API](https://skmtc.dev/starkbank/apis/stark-bank-api.md) - [All operations](https://skmtc.dev/starkbank/apis/stark-bank-api/llms.txt) - [OpenAPI document](https://skmtc.dev/starkbank/apis/stark-bank-api/revisions/aeff5068a5da?raw)