Payment Preview

Create a Payment Preview

Create a payment preview to get information from a payment.

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

Request body

idstring 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'.

scheduledstring date-time

Intended payment date. Right now, this parameter only has effect on BrcodePreviews. Example: '2020-03-10'

Response

Successful operation

object required

Changes

No recorded changes to this operation across all 1 revision of this API.