v1

latestOpenAPI 3.1.02026-07-24320172.9 KB

Payment Preview

post/api/v2.0/accounts/{accountId}/paymentpreview

Path parameters

versionstring required

The current version of BaaSiC API

accountIdstring required

Target withdraw account identification

Headers

Authorizationstring

The personal authentication token obtained by each user from the token authentication endpoint

Request body

idstring

The barcode or QR code to which you wish to receive the payment.

Response

200

idstring

typestring

statusstring

namestring

taxIdstring

amountnumber

interestAmountinteger

fineAmountinteger

discountAmountinteger

{"stackTrail":"paths:/api/v2.0/accounts/{accountId}/paymentpreview:post:responses:200:content:application/json:schema:properties:scheduled","oasType":"schema","type":"unknown"}

Example response

{
  "id": "0008563211226890014br.gov.bcb.pix2567brcode-h.sandbox.fakeinfra.com/v2/c3957f884d7542ac8ef5b4a1a2da265d5204000053039865802BR59253Ra Ltd6014Rio de Janeiro62070503***630412F5",
  "type": "brcode-payment",
  "status": "paid",
  "name": "Testes Ltda",
  "amount": 11.01,
  "brCode": {
    "bankCode": "12318183",
    "accountType": "payment",
    "reconciliationId": "i46c9d42b235647a19d64e09a512d0aad",
    "keyId": "b4f231da-59c3-4687-bb3a-29e052913d51",
    "nominalAmount": 11.01
  }
}