v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Recurring payment

Create recurrent COB QR Code

Create a COB QR Code for a recurring payment as a EMV (Europay Mastercard Visa) string.

COB is short for cobranca, which means charge in Portuguese. A COB QR Code has an expiration date while a COBV QR Code has a due date, fine, interest, and rebates.

For more information, refer to Pix and QR Codes.

Note: This endpoint takes an account token - an access token encoded with a Pismo account ID.

post/v1/pix/qrcode/cob/recurrence

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

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.

allows_value_changeboolean

Can payer change payment values? Default is false.

qrcode_expiration_timeinteger

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

reusableboolean

Can QR Code be reused? Default is false.

recurrence_idstring

Recurrence ID. Either this or the recurrence object is REQUIRED.

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

{
  "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",
    "document_number": "42761202686",
    "type": "NATURAL_PERSON",
    "trade_name": "Acme Widgets"
  },
  "initial_amount": 86753.09,
  "transaction_identification": "trans-id-75789947401234567",
  "payer_solicitation": "For dinner last night",
  "allows_value_change": true,
  "qrcode_expiration_time": 7200,
  "additional_information": [
    {
      "name": "Purity of essence",
      "value": "5.00"
    }
  ],
  "reusable": true,
  "location": {
    "url_payload": "example.com/pix/8b3da2f3-941-40d1-a91a-bd93113bd441",
    "url_payload_rec": "example.com/rec/8b3da2f3-941-40d1-a91a-bd93113bd441"
  },
  "recurrence_id": "RN219952X6X02505XXCONTRACTXXX",
  "recurrence": {
    "frequency_type": "MONTH",
    "first_payment_date": "2025-04-25",
    "last_payment_date": "2026-06-10",
    "amount": 600,
    "min_payment_amount": 10.09,
    "debtor": {
      "document_number": "42761202686",
      "document_type": "NATURAL_PERSON",
      "name": "Eva Destrukion"
    },
    "contract_id": "5509-uroo-78944-9987",
    "description": "Gym membership",
    "allow_attempts_after_expiration": true,
    "taxes": {
      "tax_identifier": "IS0435879820240605bcdb1fhn43a",
      "records": [
        {
          "tax_type": "IBS",
          "amount": 1050.44
        }
      ]
    }
  },
  "access_token": "153ed19a-e738-4417-9e98-a515c276a731"
}

Response

Create Recurrence 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.

qrcode_imageb64string

Base64 encoded QR Code

recurrence_idstring required

Recurrence ID. Either this or the recurrence object is REQUIRED.

jwsstring

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

jws_recstring

Signed JWS payload, referring to the data of the recurrence.

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",
  "qrcode_imageb64": "dfkk7830o*&#)@#9FEE",
  "recurrence_id": "RN219952X6X02505XXCONTRACTXXX",
  "jws": "eYqqqwq.heif.jk2w",
  "jws_rec": "eYqqqwq.heif.jk2w"
}