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"
  }
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

string

requerido

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

Ejemplo:

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

Cuerpo

application/json

city

string

requerido

Merchant city (cidade).

Ejemplo:

"Sao Paulo"

jwkUrl

string

requerido

JWK Set URL (urlJwk; no scheme).

Ejemplo:

"example.com/jwks"

key

string

requerido

The recipient PIX key the composite QR pays into.

Ejemplo:

"fulano.tal@provedor.com.br"

originalAmount

integer<int64>

requerido

Original charge amount in centavos (valorOriginal).

Ejemplo:

100001

paymentPayloadUrl

string

requerido

Payment JWS host URL (urlPayloadJson; no scheme).

Ejemplo:

"pix.example.com/abc"

recipientName

string

requerido

Recipient/beneficiary name (nomeRecebedor).

Ejemplo:

"Fulano de Tal"

recurrenceStatus

integer<int64>

requerido

Recurrence stRecorrencia transition (0..4).

Ejemplo:

0

status

integer<int64>

requerido

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

Ejemplo:

0

txId

string

requerido

Conciliation id (idConciliacaoRecebedor).

Ejemplo:

"JDPI2020010300000000000000000000001"

certificateIspb

string

Indirect-PSP certificate ISPB (ispbCertificadoJws, string).

Ejemplo:

"04358798"

debtorName

string

Updated debtor name (dadosRecorrencia.devedor.nome).

Ejemplo:

"Fulano dos Santos"

description

object[] | null

Optional additional-data entries (dadosAdicionais).

Show child attributes

expirationTime

integer<int64>

QR expiration in seconds (0 = JDPI default).

Ejemplo:

86400

payer

object

Optional payer block.

Show child attributes

recurrencePayloadUrl

string

Recurrence JWS host URL (urlPayloadJsonRec; no scheme).

Ejemplo:

"pix.example.com/rec/def"

startDate

string

Updated recurrence first payment date (dtInicialRecorrencia).

Ejemplo:

"2025-02-10"

zipCode

string

Recipient postal code (cep).

Ejemplo:

"01227200"

Respuesta

qrCode

string

requerido

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

Ejemplo:

"00020126..."

documentId

string

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

Ejemplo:

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

payloadJws

string

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

Ejemplo:

"eyJhbGciOiJQUzUxMi..."

recurrencePayload

string

The signed recurrence JWS (payloadJwsRecorrencia).

Ejemplo:

"eyJhbGciOiJQUzUxMi..."

revision

integer<int64>

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

Ejemplo:

2

Asientos

Reclamaciones

Bancos

Indirectos

Transacciones

Límites

Códigos QR

Devoluciones

PIX Automatico

MED Infracciones

MED Devoluciones

MED Marcadores de Fraude

MED Recuperaciones

MED Crédito Entrante

Webhooks

Manejo de errores

Eventos

Update an immediate dynamic composite PIX Automatico QR code

Autorizaciones

Parámetros de ruta

Cuerpo

Respuesta