v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

QR Code

Update dynamic COBV QR Code

The entire QR Code is updated. If a parameter is not passed, the current value (if any) is emptied.

patch/v1/pix/qrcode/cobv

Headers

Authorizationstring required

Account token - token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a <b>401 Unauthorized</b> message

Request body

idstring required

Pismo QR Code identifier

status'CREATED' | 'PROCESSING' | 'SETTLED' | 'CANCELLED' | 'HOLD' required

CREATED - Payment has been created and is pending processing
PROCESSING - P2P balance was impacted and waiting for provider confirmation. For cashin, the transaction means the money will be credited on the next Working Day
SETTLED - Transaction completed processing and is settled
CANCELLED - Something went wrong and the transaction is cancelled. Refer to reason for more details
HOLD - The payment is on hold, pending further review

initial_amountnumber required

Initial payment amount

transaction_identificationstring required

Client-generated unique transaction ID for client monitoring and tracking.

payer_solicitationstring

Payee text sent to payer.

qrcode_expiration_timeinteger

QR Code's maximum time for presentation (in seconds)

reusableboolean

Can QR Code be reused? Default is false.

allows_value_changeboolean

Can payer change payment values? Default is false.

access_tokenstring

Access token related to the url_payload/url_payload_rec fields, used to register and validate a QR code.

This field must be provided if the PSP requires it. The URL format is described in the Manual of Standards for PIX Initiation.

Example request

{
  "id": "442e992a-2f89-46fb-820a-958693bde84d",
  "status": "PROCESSING",
  "charge": {
    "discount_type": "FIXED_VALUE_UNTIL_THE_DATES_INFORMED",
    "discount_value": 99,
    "discount_fixed_dates": [
      {
        "date": "2024-01-12",
        "value": 86753.09
      }
    ],
    "fine_type": "FIXED_VALUE",
    "fine_value": 45.67,
    "fine_final_amount": 99.87,
    "interest_type": "VALUE_WORKING_DAYS",
    "interest_value": 34.09,
    "interest_final_amount": 67.89,
    "settlement_type": "FIXED_VALUE",
    "settlement_value": 453.98,
    "settlement_final_amount": 876.34,
    "final_amount": 10
  },
  "payee": {
    "address": "10 Downing Street, London  SW1A 2AB, UK",
    "city": "Brasilia",
    "key": "chuck@steaks.com",
    "state": "DF",
    "zip_code": "8675309",
    "category": "5651"
  },
  "payer": {
    "name": "Eva Destrukion",
    "address": "10 Downing Street, London  SW1A 2AB, UK",
    "city": "Brasilia",
    "document_number": "42761202686",
    "state": "DF",
    "trade_name": "Acme Widgets",
    "type": "NATURAL_PERSON",
    "zip_code": "8675309"
  },
  "initial_amount": 86753.09,
  "transaction_identification": "trans-id-75789947401234567",
  "payer_solicitation": "For dinner last night",
  "qrcode_expiration_time": 7200,
  "reusable": true,
  "allows_value_change": true,
  "location": {
    "url_payload": "example.com/pix/8b3da2f3-941-40d1-a91a-bd93113bd441"
  },
  "additional_information": [
    {
      "name": "Purity of essence",
      "value": "5.00"
    }
  ],
  "access_token": "153ed19a-e738-4417-9e98-a515c276a731"
}

Response

Generate COB QR Code response

idstring required

Pismo QR Code identifier

access_tokenstring required

QR Code access token generated and returned at creation.

external_idstring required

Client-generated record identifier for client tracking and monitoring.

emvstring required

Base 64 encoded discount QR Code payload. EMV = Europay, Mastercard and Visa, a global standard for credit and debit payment. The EMV might include details required for secure transactions such as cardholder informatipn, transaction amount, merchant information, and other relevant data.

status'CREATED' | 'PROCESSING' | 'SETTLED' | 'CANCELLED' | 'HOLD' required

CREATED - Payment has been created and is pending processing
PROCESSING - P2P balance was impacted and waiting for provider confirmation. For cashin, the transaction means the money will be credited on the next Working Day
SETTLED - Transaction completed processing and is settled
CANCELLED - Something went wrong and the transaction is cancelled. Refer to reason for more details
HOLD - The payment is on hold, pending further review

qrcode_imageb64string

Base64 encoded QR Code

versioninteger

Current version

jwsstring

JWS (JSON Web Signature) payload. When a JWT (JSON Web Token) is signed, it becomes a JWS.

creation_datestring datetime

QR Code creation date/time. RFC 3339 format.

last_updatestring datetime

When QR Code last updated. RFC 3339 format.

Example response

{
  "id": "442e992a-2f89-46fb-820a-958693bde84d",
  "access_token": "1234567890",
  "external_id": "my-external-id-9999-6474",
  "emv": "00020101021226980014br.gov.bcb.pix2576api-h.developer.btgpactual.com/pc/p/v2/...***63040441",
  "status": "PROCESSING",
  "qrcode_imageb64": "dfkk7830o*&#)@#9FEE",
  "version": 1,
  "jws": "eYqqqwq.heif.jk2w",
  "creation_date": "2023-04-12T23:20:50.52Z",
  "last_update": "2023-04-12T23:20:50.52Z"
}