Create a CobV (due-date) composite PIX Automatico QR code

curl --request POST \
  --url https://api.example.com/v1/pix-automatico/composite/cobv \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountId": "acc-123",
  "daysAfterDue": 365,
  "dueDate": "2021-06-17",
  "finalAmount": 100001,
  "jwkUrl": "example.com/jwks",
  "key": "fulano.tal@provedor.com.br",
  "paymentPayloadUrl": "pix.example.com/cobv/abc",
  "recipientStreet": "Rua Pix, 123",
  "recurrence": {
    "contractNumber": "1234567890ABC",
    "debtor": {
      "cpfCnpj": "04623217035",
      "name": "Ciclano da Silva",
      "personType": 0
    },
    "frequency": 1,
    "recipient": {
      "cnpj": "61695227000193",
      "ispb": "04358798",
      "name": "Enel"
    },
    "recurrenceId": "RR0435879820240605njua7shf40o",
    "retry": 1,
    "startDate": "2024-01-10",
    "amount": 110001,
    "contractDesc": "Conta de energia",
    "endDate": "2026-01-10",
    "maxFloorAmount": 55000
  },
  "recurrencePayloadUrl": "pix.example.com/rec/def",
  "state": "SP",
  "txId": "JDPI2020010300000000000000000000001",
  "zipCode": "01227200",
  "certificateIspb": "04358798",
  "description": [
    {
      "name": "Detalhes do Pagamento",
      "value": "Informacao Adicional"
    }
  ],
  "discount": 4,
  "fine": 20022,
  "interest": 1015,
  "originalAmount": 100116,
  "payer": {
    "document": "04623217035",
    "name": "Ciclano de Tal",
    "request": "Pesquisa de satisfacao"
  },
  "rebate": 111
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/pix-automatico/composite/cobv"

	payload := strings.NewReader("{\n  \"accountId\": \"acc-123\",\n  \"daysAfterDue\": 365,\n  \"dueDate\": \"2021-06-17\",\n  \"finalAmount\": 100001,\n  \"jwkUrl\": \"example.com/jwks\",\n  \"key\": \"fulano.tal@provedor.com.br\",\n  \"paymentPayloadUrl\": \"pix.example.com/cobv/abc\",\n  \"recipientStreet\": \"Rua Pix, 123\",\n  \"recurrence\": {\n    \"contractNumber\": \"1234567890ABC\",\n    \"debtor\": {\n      \"cpfCnpj\": \"04623217035\",\n      \"name\": \"Ciclano da Silva\",\n      \"personType\": 0\n    },\n    \"frequency\": 1,\n    \"recipient\": {\n      \"cnpj\": \"61695227000193\",\n      \"ispb\": \"04358798\",\n      \"name\": \"Enel\"\n    },\n    \"recurrenceId\": \"RR0435879820240605njua7shf40o\",\n    \"retry\": 1,\n    \"startDate\": \"2024-01-10\",\n    \"amount\": 110001,\n    \"contractDesc\": \"Conta de energia\",\n    \"endDate\": \"2026-01-10\",\n    \"maxFloorAmount\": 55000\n  },\n  \"recurrencePayloadUrl\": \"pix.example.com/rec/def\",\n  \"state\": \"SP\",\n  \"txId\": \"JDPI2020010300000000000000000000001\",\n  \"zipCode\": \"01227200\",\n  \"certificateIspb\": \"04358798\",\n  \"description\": [\n    {\n      \"name\": \"Detalhes do Pagamento\",\n      \"value\": \"Informacao Adicional\"\n    }\n  ],\n  \"discount\": 4,\n  \"fine\": 20022,\n  \"interest\": 1015,\n  \"originalAmount\": 100116,\n  \"payer\": {\n    \"document\": \"04623217035\",\n    \"name\": \"Ciclano de Tal\",\n    \"request\": \"Pesquisa de satisfacao\"\n  },\n  \"rebate\": 111\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accountId: 'acc-123',
    daysAfterDue: 365,
    dueDate: '2021-06-17',
    finalAmount: 100001,
    jwkUrl: 'example.com/jwks',
    key: 'fulano.tal@provedor.com.br',
    paymentPayloadUrl: 'pix.example.com/cobv/abc',
    recipientStreet: 'Rua Pix, 123',
    recurrence: {
      contractNumber: '1234567890ABC',
      debtor: {cpfCnpj: '04623217035', name: 'Ciclano da Silva', personType: 0},
      frequency: 1,
      recipient: {cnpj: '61695227000193', ispb: '04358798', name: 'Enel'},
      recurrenceId: 'RR0435879820240605njua7shf40o',
      retry: 1,
      startDate: '2024-01-10',
      amount: 110001,
      contractDesc: 'Conta de energia',
      endDate: '2026-01-10',
      maxFloorAmount: 55000
    },
    recurrencePayloadUrl: 'pix.example.com/rec/def',
    state: 'SP',
    txId: 'JDPI2020010300000000000000000000001',
    zipCode: '01227200',
    certificateIspb: '04358798',
    description: [{name: 'Detalhes do Pagamento', value: 'Informacao Adicional'}],
    discount: 4,
    fine: 20022,
    interest: 1015,
    originalAmount: 100116,
    payer: {
      document: '04623217035',
      name: 'Ciclano de Tal',
      request: 'Pesquisa de satisfacao'
    },
    rebate: 111
  })
};

fetch('https://api.example.com/v1/pix-automatico/composite/cobv', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/pix-automatico/composite/cobv"

payload = {
    "accountId": "acc-123",
    "daysAfterDue": 365,
    "dueDate": "2021-06-17",
    "finalAmount": 100001,
    "jwkUrl": "example.com/jwks",
    "key": "fulano.tal@provedor.com.br",
    "paymentPayloadUrl": "pix.example.com/cobv/abc",
    "recipientStreet": "Rua Pix, 123",
    "recurrence": {
        "contractNumber": "1234567890ABC",
        "debtor": {
            "cpfCnpj": "04623217035",
            "name": "Ciclano da Silva",
            "personType": 0
        },
        "frequency": 1,
        "recipient": {
            "cnpj": "61695227000193",
            "ispb": "04358798",
            "name": "Enel"
        },
        "recurrenceId": "RR0435879820240605njua7shf40o",
        "retry": 1,
        "startDate": "2024-01-10",
        "amount": 110001,
        "contractDesc": "Conta de energia",
        "endDate": "2026-01-10",
        "maxFloorAmount": 55000
    },
    "recurrencePayloadUrl": "pix.example.com/rec/def",
    "state": "SP",
    "txId": "JDPI2020010300000000000000000000001",
    "zipCode": "01227200",
    "certificateIspb": "04358798",
    "description": [
        {
            "name": "Detalhes do Pagamento",
            "value": "Informacao Adicional"
        }
    ],
    "discount": 4,
    "fine": 20022,
    "interest": 1015,
    "originalAmount": 100116,
    "payer": {
        "document": "04623217035",
        "name": "Ciclano de Tal",
        "request": "Pesquisa de satisfacao"
    },
    "rebate": 111
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "qrCode": "00020126...",
  "documentId": "52c43361-caa1-4ddb-9152-708426a25db3",
  "recurrencePayload": "eyJhbGciOiJQUzUxMi..."
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

POST

pix-automatico

composite

cobv

Create a CobV (due-date) composite PIX Automatico QR code

curl --request POST \
  --url https://api.example.com/v1/pix-automatico/composite/cobv \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountId": "acc-123",
  "daysAfterDue": 365,
  "dueDate": "2021-06-17",
  "finalAmount": 100001,
  "jwkUrl": "example.com/jwks",
  "key": "fulano.tal@provedor.com.br",
  "paymentPayloadUrl": "pix.example.com/cobv/abc",
  "recipientStreet": "Rua Pix, 123",
  "recurrence": {
    "contractNumber": "1234567890ABC",
    "debtor": {
      "cpfCnpj": "04623217035",
      "name": "Ciclano da Silva",
      "personType": 0
    },
    "frequency": 1,
    "recipient": {
      "cnpj": "61695227000193",
      "ispb": "04358798",
      "name": "Enel"
    },
    "recurrenceId": "RR0435879820240605njua7shf40o",
    "retry": 1,
    "startDate": "2024-01-10",
    "amount": 110001,
    "contractDesc": "Conta de energia",
    "endDate": "2026-01-10",
    "maxFloorAmount": 55000
  },
  "recurrencePayloadUrl": "pix.example.com/rec/def",
  "state": "SP",
  "txId": "JDPI2020010300000000000000000000001",
  "zipCode": "01227200",
  "certificateIspb": "04358798",
  "description": [
    {
      "name": "Detalhes do Pagamento",
      "value": "Informacao Adicional"
    }
  ],
  "discount": 4,
  "fine": 20022,
  "interest": 1015,
  "originalAmount": 100116,
  "payer": {
    "document": "04623217035",
    "name": "Ciclano de Tal",
    "request": "Pesquisa de satisfacao"
  },
  "rebate": 111
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/pix-automatico/composite/cobv"

	payload := strings.NewReader("{\n  \"accountId\": \"acc-123\",\n  \"daysAfterDue\": 365,\n  \"dueDate\": \"2021-06-17\",\n  \"finalAmount\": 100001,\n  \"jwkUrl\": \"example.com/jwks\",\n  \"key\": \"fulano.tal@provedor.com.br\",\n  \"paymentPayloadUrl\": \"pix.example.com/cobv/abc\",\n  \"recipientStreet\": \"Rua Pix, 123\",\n  \"recurrence\": {\n    \"contractNumber\": \"1234567890ABC\",\n    \"debtor\": {\n      \"cpfCnpj\": \"04623217035\",\n      \"name\": \"Ciclano da Silva\",\n      \"personType\": 0\n    },\n    \"frequency\": 1,\n    \"recipient\": {\n      \"cnpj\": \"61695227000193\",\n      \"ispb\": \"04358798\",\n      \"name\": \"Enel\"\n    },\n    \"recurrenceId\": \"RR0435879820240605njua7shf40o\",\n    \"retry\": 1,\n    \"startDate\": \"2024-01-10\",\n    \"amount\": 110001,\n    \"contractDesc\": \"Conta de energia\",\n    \"endDate\": \"2026-01-10\",\n    \"maxFloorAmount\": 55000\n  },\n  \"recurrencePayloadUrl\": \"pix.example.com/rec/def\",\n  \"state\": \"SP\",\n  \"txId\": \"JDPI2020010300000000000000000000001\",\n  \"zipCode\": \"01227200\",\n  \"certificateIspb\": \"04358798\",\n  \"description\": [\n    {\n      \"name\": \"Detalhes do Pagamento\",\n      \"value\": \"Informacao Adicional\"\n    }\n  ],\n  \"discount\": 4,\n  \"fine\": 20022,\n  \"interest\": 1015,\n  \"originalAmount\": 100116,\n  \"payer\": {\n    \"document\": \"04623217035\",\n    \"name\": \"Ciclano de Tal\",\n    \"request\": \"Pesquisa de satisfacao\"\n  },\n  \"rebate\": 111\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accountId: 'acc-123',
    daysAfterDue: 365,
    dueDate: '2021-06-17',
    finalAmount: 100001,
    jwkUrl: 'example.com/jwks',
    key: 'fulano.tal@provedor.com.br',
    paymentPayloadUrl: 'pix.example.com/cobv/abc',
    recipientStreet: 'Rua Pix, 123',
    recurrence: {
      contractNumber: '1234567890ABC',
      debtor: {cpfCnpj: '04623217035', name: 'Ciclano da Silva', personType: 0},
      frequency: 1,
      recipient: {cnpj: '61695227000193', ispb: '04358798', name: 'Enel'},
      recurrenceId: 'RR0435879820240605njua7shf40o',
      retry: 1,
      startDate: '2024-01-10',
      amount: 110001,
      contractDesc: 'Conta de energia',
      endDate: '2026-01-10',
      maxFloorAmount: 55000
    },
    recurrencePayloadUrl: 'pix.example.com/rec/def',
    state: 'SP',
    txId: 'JDPI2020010300000000000000000000001',
    zipCode: '01227200',
    certificateIspb: '04358798',
    description: [{name: 'Detalhes do Pagamento', value: 'Informacao Adicional'}],
    discount: 4,
    fine: 20022,
    interest: 1015,
    originalAmount: 100116,
    payer: {
      document: '04623217035',
      name: 'Ciclano de Tal',
      request: 'Pesquisa de satisfacao'
    },
    rebate: 111
  })
};

fetch('https://api.example.com/v1/pix-automatico/composite/cobv', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/pix-automatico/composite/cobv"

payload = {
    "accountId": "acc-123",
    "daysAfterDue": 365,
    "dueDate": "2021-06-17",
    "finalAmount": 100001,
    "jwkUrl": "example.com/jwks",
    "key": "fulano.tal@provedor.com.br",
    "paymentPayloadUrl": "pix.example.com/cobv/abc",
    "recipientStreet": "Rua Pix, 123",
    "recurrence": {
        "contractNumber": "1234567890ABC",
        "debtor": {
            "cpfCnpj": "04623217035",
            "name": "Ciclano da Silva",
            "personType": 0
        },
        "frequency": 1,
        "recipient": {
            "cnpj": "61695227000193",
            "ispb": "04358798",
            "name": "Enel"
        },
        "recurrenceId": "RR0435879820240605njua7shf40o",
        "retry": 1,
        "startDate": "2024-01-10",
        "amount": 110001,
        "contractDesc": "Conta de energia",
        "endDate": "2026-01-10",
        "maxFloorAmount": 55000
    },
    "recurrencePayloadUrl": "pix.example.com/rec/def",
    "state": "SP",
    "txId": "JDPI2020010300000000000000000000001",
    "zipCode": "01227200",
    "certificateIspb": "04358798",
    "description": [
        {
            "name": "Detalhes do Pagamento",
            "value": "Informacao Adicional"
        }
    ],
    "discount": 4,
    "fine": 20022,
    "interest": 1015,
    "originalAmount": 100116,
    "payer": {
        "document": "04623217035",
        "name": "Ciclano de Tal",
        "request": "Pesquisa de satisfacao"
    },
    "rebate": 111
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "qrCode": "00020126...",
  "documentId": "52c43361-caa1-4ddb-9152-708426a25db3",
  "recurrencePayload": "eyJhbGciOiJQUzUxMi..."
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Body

application/json

accountId

string

required

The CRM account id of the recipient (sources name + city).

Example:

"acc-123"

daysAfterDue

integer<int64>

required

Days after the due date the charge can still be paid (diasAposVenc).

Example:

365

dueDate

string

required

Due date for payment (dtVenc; aaaa-mm-dd).

Example:

"2021-06-17"

finalAmount

integer<int64>

required

Final charge amount in centavos (valorFinal, after adjustments).

Example:

100001

jwkUrl

string

required

JWK Set URL (urlJwk; no scheme).

Example:

"example.com/jwks"

key

string

required

The recipient PIX key the composite QR pays into.

Example:

"fulano.tal@provedor.com.br"

paymentPayloadUrl

string

required

CobV JWS host URL (urlPayloadJson; no scheme).

Example:

"pix.example.com/cobv/abc"

recipientStreet

string

required

Recipient street (logradouroRecebedor).

Example:

"Rua Pix, 123"

recurrence

object

required

The embedded recurrence configuration (dadosRecorrencia).

Show child attributes

recurrencePayloadUrl

string

required

Recurrence JWS host URL (urlPayloadJsonRec; no scheme).

Example:

"pix.example.com/rec/def"

state

string

required

Recipient state (uf).

Example:

"SP"

txId

string

required

Conciliation id (idConciliacaoRecebedor).

Example:

"JDPI2020010300000000000000000000001"

zipCode

string

required

Recipient postal code (cep).

Example:

"01227200"

certificateIspb

string

Indirect-PSP certificate ISPB (ispbCertificadoJws, string).

Example:

"04358798"

description

object[] | null

Optional additional-data entries (dadosAdicionais).

Show child attributes

discount

integer<int64>

Discount in centavos (desconto; omit/0 to skip).

Example:

4

fine

integer<int64>

Fine in centavos (multa; omit/0 to skip).

Example:

20022

interest

integer<int64>

Interest in centavos (juros; omit/0 to skip).

Example:

1015

originalAmount

integer<int64>

Original charge amount in centavos (valorOriginal, before adjustments).

Example:

100116

payer

object

Optional payer block.

Show child attributes

rebate

integer<int64>

Rebate in centavos (abatimento; omit/0 to skip).

Example:

111

Response

Created

qrCode

string

required

The generated EMV composite-QR payload (base64-decoded, ready to render).

Example:

"00020126..."

documentId

string

The recurrence/charge document id (idDocumento, GUID).

Example:

"52c43361-caa1-4ddb-9152-708426a25db3"

recurrencePayload

string

The signed recurrence JWS (payloadJwsRecorrencia).

Example:

"eyJhbGciOiJQUzUxMi..."

Direct participant APIs

Indirect participant APIs

Create a CobV (due-date) composite PIX Automatico QR code

Authorizations

Body

Response