Update an immediate dynamic composite PIX Automatico QR code

curl --request PUT \
  --url https://api.example.com/v1/pix-automatico/composite/dynamic/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "city": "Sao Paulo",
  "jwkUrl": "example.com/jwks",
  "key": "fulano.tal@provedor.com.br",
  "originalAmount": 100001,
  "paymentPayloadUrl": "pix.example.com/abc",
  "recipientName": "Fulano de Tal",
  "recurrenceStatus": 0,
  "status": 0,
  "txId": "JDPI2020010300000000000000000000001",
  "certificateIspb": "04358798",
  "debtorName": "Fulano dos Santos",
  "description": [
    {
      "name": "Detalhes do Pagamento",
      "value": "Informacao Adicional"
    }
  ],
  "expirationTime": 86400,
  "payer": {
    "document": "04623217035",
    "name": "Ciclano de Tal",
    "request": "Pesquisa de satisfacao"
  },
  "recurrencePayloadUrl": "pix.example.com/rec/def",
  "startDate": "2025-02-10",
  "zipCode": "01227200"
}
'

package main

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

func main() {

	url := "https://api.example.com/v1/pix-automatico/composite/dynamic/{id}"

	payload := strings.NewReader("{\n  \"city\": \"Sao Paulo\",\n  \"jwkUrl\": \"example.com/jwks\",\n  \"key\": \"fulano.tal@provedor.com.br\",\n  \"originalAmount\": 100001,\n  \"paymentPayloadUrl\": \"pix.example.com/abc\",\n  \"recipientName\": \"Fulano de Tal\",\n  \"recurrenceStatus\": 0,\n  \"status\": 0,\n  \"txId\": \"JDPI2020010300000000000000000000001\",\n  \"certificateIspb\": \"04358798\",\n  \"debtorName\": \"Fulano dos Santos\",\n  \"description\": [\n    {\n      \"name\": \"Detalhes do Pagamento\",\n      \"value\": \"Informacao Adicional\"\n    }\n  ],\n  \"expirationTime\": 86400,\n  \"payer\": {\n    \"document\": \"04623217035\",\n    \"name\": \"Ciclano de Tal\",\n    \"request\": \"Pesquisa de satisfacao\"\n  },\n  \"recurrencePayloadUrl\": \"pix.example.com/rec/def\",\n  \"startDate\": \"2025-02-10\",\n  \"zipCode\": \"01227200\"\n}")

	req, _ := http.NewRequest("PUT", 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: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    city: 'Sao Paulo',
    jwkUrl: 'example.com/jwks',
    key: 'fulano.tal@provedor.com.br',
    originalAmount: 100001,
    paymentPayloadUrl: 'pix.example.com/abc',
    recipientName: 'Fulano de Tal',
    recurrenceStatus: 0,
    status: 0,
    txId: 'JDPI2020010300000000000000000000001',
    certificateIspb: '04358798',
    debtorName: 'Fulano dos Santos',
    description: [{name: 'Detalhes do Pagamento', value: 'Informacao Adicional'}],
    expirationTime: 86400,
    payer: {
      document: '04623217035',
      name: 'Ciclano de Tal',
      request: 'Pesquisa de satisfacao'
    },
    recurrencePayloadUrl: 'pix.example.com/rec/def',
    startDate: '2025-02-10',
    zipCode: '01227200'
  })
};

fetch('https://api.example.com/v1/pix-automatico/composite/dynamic/{id}', 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/dynamic/{id}"

payload = {
    "city": "Sao Paulo",
    "jwkUrl": "example.com/jwks",
    "key": "fulano.tal@provedor.com.br",
    "originalAmount": 100001,
    "paymentPayloadUrl": "pix.example.com/abc",
    "recipientName": "Fulano de Tal",
    "recurrenceStatus": 0,
    "status": 0,
    "txId": "JDPI2020010300000000000000000000001",
    "certificateIspb": "04358798",
    "debtorName": "Fulano dos Santos",
    "description": [
        {
            "name": "Detalhes do Pagamento",
            "value": "Informacao Adicional"
        }
    ],
    "expirationTime": 86400,
    "payer": {
        "document": "04623217035",
        "name": "Ciclano de Tal",
        "request": "Pesquisa de satisfacao"
    },
    "recurrencePayloadUrl": "pix.example.com/rec/def",
    "startDate": "2025-02-10",
    "zipCode": "01227200"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

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

{
  "code": "ERR-0001",
  "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": "ERR-0001",
  "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": "ERR-0001",
  "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"
  }
}

PUT

pix-automatico

composite

dynamic

{id}

Update an immediate dynamic composite PIX Automatico QR code

curl --request PUT \
  --url https://api.example.com/v1/pix-automatico/composite/dynamic/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "city": "Sao Paulo",
  "jwkUrl": "example.com/jwks",
  "key": "fulano.tal@provedor.com.br",
  "originalAmount": 100001,
  "paymentPayloadUrl": "pix.example.com/abc",
  "recipientName": "Fulano de Tal",
  "recurrenceStatus": 0,
  "status": 0,
  "txId": "JDPI2020010300000000000000000000001",
  "certificateIspb": "04358798",
  "debtorName": "Fulano dos Santos",
  "description": [
    {
      "name": "Detalhes do Pagamento",
      "value": "Informacao Adicional"
    }
  ],
  "expirationTime": 86400,
  "payer": {
    "document": "04623217035",
    "name": "Ciclano de Tal",
    "request": "Pesquisa de satisfacao"
  },
  "recurrencePayloadUrl": "pix.example.com/rec/def",
  "startDate": "2025-02-10",
  "zipCode": "01227200"
}
'

package main

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

func main() {

	url := "https://api.example.com/v1/pix-automatico/composite/dynamic/{id}"

	payload := strings.NewReader("{\n  \"city\": \"Sao Paulo\",\n  \"jwkUrl\": \"example.com/jwks\",\n  \"key\": \"fulano.tal@provedor.com.br\",\n  \"originalAmount\": 100001,\n  \"paymentPayloadUrl\": \"pix.example.com/abc\",\n  \"recipientName\": \"Fulano de Tal\",\n  \"recurrenceStatus\": 0,\n  \"status\": 0,\n  \"txId\": \"JDPI2020010300000000000000000000001\",\n  \"certificateIspb\": \"04358798\",\n  \"debtorName\": \"Fulano dos Santos\",\n  \"description\": [\n    {\n      \"name\": \"Detalhes do Pagamento\",\n      \"value\": \"Informacao Adicional\"\n    }\n  ],\n  \"expirationTime\": 86400,\n  \"payer\": {\n    \"document\": \"04623217035\",\n    \"name\": \"Ciclano de Tal\",\n    \"request\": \"Pesquisa de satisfacao\"\n  },\n  \"recurrencePayloadUrl\": \"pix.example.com/rec/def\",\n  \"startDate\": \"2025-02-10\",\n  \"zipCode\": \"01227200\"\n}")

	req, _ := http.NewRequest("PUT", 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: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    city: 'Sao Paulo',
    jwkUrl: 'example.com/jwks',
    key: 'fulano.tal@provedor.com.br',
    originalAmount: 100001,
    paymentPayloadUrl: 'pix.example.com/abc',
    recipientName: 'Fulano de Tal',
    recurrenceStatus: 0,
    status: 0,
    txId: 'JDPI2020010300000000000000000000001',
    certificateIspb: '04358798',
    debtorName: 'Fulano dos Santos',
    description: [{name: 'Detalhes do Pagamento', value: 'Informacao Adicional'}],
    expirationTime: 86400,
    payer: {
      document: '04623217035',
      name: 'Ciclano de Tal',
      request: 'Pesquisa de satisfacao'
    },
    recurrencePayloadUrl: 'pix.example.com/rec/def',
    startDate: '2025-02-10',
    zipCode: '01227200'
  })
};

fetch('https://api.example.com/v1/pix-automatico/composite/dynamic/{id}', 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/dynamic/{id}"

payload = {
    "city": "Sao Paulo",
    "jwkUrl": "example.com/jwks",
    "key": "fulano.tal@provedor.com.br",
    "originalAmount": 100001,
    "paymentPayloadUrl": "pix.example.com/abc",
    "recipientName": "Fulano de Tal",
    "recurrenceStatus": 0,
    "status": 0,
    "txId": "JDPI2020010300000000000000000000001",
    "certificateIspb": "04358798",
    "debtorName": "Fulano dos Santos",
    "description": [
        {
            "name": "Detalhes do Pagamento",
            "value": "Informacao Adicional"
        }
    ],
    "expirationTime": 86400,
    "payer": {
        "document": "04623217035",
        "name": "Ciclano de Tal",
        "request": "Pesquisa de satisfacao"
    },
    "recurrencePayloadUrl": "pix.example.com/rec/def",
    "startDate": "2025-02-10",
    "zipCode": "01227200"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

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

{
  "code": "ERR-0001",
  "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": "ERR-0001",
  "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": "ERR-0001",
  "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"
  }
}

Autorizações

Authorization

string

header

obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

string

obrigatório

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

Exemplo:

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

Corpo

application/json

city

string

obrigatório

Merchant city (cidade).

Exemplo:

"Sao Paulo"

jwkUrl

string

obrigatório

JWK Set URL (urlJwk; no scheme).

Exemplo:

"example.com/jwks"

key

string

obrigatório

The recipient PIX key the composite QR pays into.

Exemplo:

"fulano.tal@provedor.com.br"

originalAmount

integer<int64>

obrigatório

Original charge amount in centavos (valorOriginal).

Exemplo:

100001

paymentPayloadUrl

string

obrigatório

Payment JWS host URL (urlPayloadJson; no scheme).

Exemplo:

"pix.example.com/abc"

recipientName

string

obrigatório

Recipient/beneficiary name (nomeRecebedor).

Exemplo:

"Fulano de Tal"

recurrenceStatus

integer<int64>

obrigatório

Recurrence stRecorrencia transition (0..4).

Exemplo:

0

status

integer<int64>

obrigatório

Charge situation (0=Active,1=Completed,2=Removed by recipient,3=Removed by PSP).

Exemplo:

0

txId

string

obrigatório

Conciliation id (idConciliacaoRecebedor).

Exemplo:

"JDPI2020010300000000000000000000001"

certificateIspb

string

Indirect-PSP certificate ISPB (ispbCertificadoJws, string).

Exemplo:

"04358798"

debtorName

string

Updated debtor name (dadosRecorrencia.devedor.nome).

Exemplo:

"Fulano dos Santos"

description

object[] | null

Optional additional-data entries (dadosAdicionais).

Show child attributes

expirationTime

integer<int64>

QR expiration in seconds (0 = JDPI default).

Exemplo:

86400

payer

object

Optional payer block.

Show child attributes

recurrencePayloadUrl

string

Recurrence JWS host URL (urlPayloadJsonRec; no scheme).

Exemplo:

"pix.example.com/rec/def"

startDate

string

Updated recurrence first payment date (dtInicialRecorrencia).

Exemplo:

"2025-02-10"

zipCode

string

Recipient postal code (cep).

Exemplo:

"01227200"

Resposta

qrCode

string

obrigatório

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

Exemplo:

"00020126..."

documentId

string

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

Exemplo:

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

payloadJws

string

The signed payment JWS (payloadJws; dynamic + cobv).

Exemplo:

"eyJhbGciOiJQUzUxMi..."

recurrencePayload

string

The signed recurrence JWS (payloadJwsRecorrencia).

Exemplo:

"eyJhbGciOiJQUzUxMi..."

revision

integer<int64>

The JDPI-computed charge revision (revisao; dynamic + cobv updates only).

Exemplo:

2

Lançamentos

Reivindicações

Bancos

Indiretos

Transações

Limites

QR Codes

Devoluções

PIX Automatico

MED Infrações

MED Devoluções

MED Marcadores de Fraude

MED Recuperações

MED Crédito Recebido

Webhooks

Tratamento de erros

Eventos

Update an immediate dynamic composite PIX Automatico QR code

Autorizações

Parâmetros de caminho

Corpo

Resposta