Register an inbound PIX Automatico cancellation

curl --request POST \
  --url https://api.example.com/v1/pix-automatico/authorizations/inbound/cancellation/register \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cpfCnpjSolCancelamento": "77379362038",
  "dtInicialRecorrencia": "2024-01-10",
  "idCancelamento": "IC0435879820240605bcdb1fhn43a",
  "idRecorrencia": "RR0435879820240920njua7shf40o",
  "motivoCancelamento": 6,
  "nrContrato": "1234567890ABC",
  "pagador": {
    "cpfCnpj": "11111111111",
    "ispb": "99999004",
    "nrConta": "12345678",
    "tpPessoa": 0,
    "codMunIbge": 3550308,
    "nrAgencia": "1234"
  },
  "recebedor": {
    "cnpj": "61695227000193",
    "ispb": "04358798",
    "nome": "Enel"
  },
  "stCancelamento": 0,
  "tpFrequencia": 4,
  "tpPessoaSol": 0,
  "codigoErro": "",
  "descCodigoErro": "",
  "descContrato": "Conta de energia",
  "dtFinalRecorrencia": "2026-01-10",
  "dtHrCancelamento": "2024-09-23T10:10:06.101Z",
  "dtHrCriacaoRecorrencia": "2024-09-20T09:25:49.025Z",
  "valor": 550
}
'

package main

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

func main() {

	url := "https://api.example.com/v1/pix-automatico/authorizations/inbound/cancellation/register"

	payload := strings.NewReader("{\n  \"cpfCnpjSolCancelamento\": \"77379362038\",\n  \"dtInicialRecorrencia\": \"2024-01-10\",\n  \"idCancelamento\": \"IC0435879820240605bcdb1fhn43a\",\n  \"idRecorrencia\": \"RR0435879820240920njua7shf40o\",\n  \"motivoCancelamento\": 6,\n  \"nrContrato\": \"1234567890ABC\",\n  \"pagador\": {\n    \"cpfCnpj\": \"11111111111\",\n    \"ispb\": \"99999004\",\n    \"nrConta\": \"12345678\",\n    \"tpPessoa\": 0,\n    \"codMunIbge\": 3550308,\n    \"nrAgencia\": \"1234\"\n  },\n  \"recebedor\": {\n    \"cnpj\": \"61695227000193\",\n    \"ispb\": \"04358798\",\n    \"nome\": \"Enel\"\n  },\n  \"stCancelamento\": 0,\n  \"tpFrequencia\": 4,\n  \"tpPessoaSol\": 0,\n  \"codigoErro\": \"\",\n  \"descCodigoErro\": \"\",\n  \"descContrato\": \"Conta de energia\",\n  \"dtFinalRecorrencia\": \"2026-01-10\",\n  \"dtHrCancelamento\": \"2024-09-23T10:10:06.101Z\",\n  \"dtHrCriacaoRecorrencia\": \"2024-09-20T09:25:49.025Z\",\n  \"valor\": 550\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({
    cpfCnpjSolCancelamento: '77379362038',
    dtInicialRecorrencia: '2024-01-10',
    idCancelamento: 'IC0435879820240605bcdb1fhn43a',
    idRecorrencia: 'RR0435879820240920njua7shf40o',
    motivoCancelamento: 6,
    nrContrato: '1234567890ABC',
    pagador: {
      cpfCnpj: '11111111111',
      ispb: '99999004',
      nrConta: '12345678',
      tpPessoa: 0,
      codMunIbge: 3550308,
      nrAgencia: '1234'
    },
    recebedor: {cnpj: '61695227000193', ispb: '04358798', nome: 'Enel'},
    stCancelamento: 0,
    tpFrequencia: 4,
    tpPessoaSol: 0,
    codigoErro: '',
    descCodigoErro: '',
    descContrato: 'Conta de energia',
    dtFinalRecorrencia: '2026-01-10',
    dtHrCancelamento: '2024-09-23T10:10:06.101Z',
    dtHrCriacaoRecorrencia: '2024-09-20T09:25:49.025Z',
    valor: 550
  })
};

fetch('https://api.example.com/v1/pix-automatico/authorizations/inbound/cancellation/register', 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/authorizations/inbound/cancellation/register"

payload = {
    "cpfCnpjSolCancelamento": "77379362038",
    "dtInicialRecorrencia": "2024-01-10",
    "idCancelamento": "IC0435879820240605bcdb1fhn43a",
    "idRecorrencia": "RR0435879820240920njua7shf40o",
    "motivoCancelamento": 6,
    "nrContrato": "1234567890ABC",
    "pagador": {
        "cpfCnpj": "11111111111",
        "ispb": "99999004",
        "nrConta": "12345678",
        "tpPessoa": 0,
        "codMunIbge": 3550308,
        "nrAgencia": "1234"
    },
    "recebedor": {
        "cnpj": "61695227000193",
        "ispb": "04358798",
        "nome": "Enel"
    },
    "stCancelamento": 0,
    "tpFrequencia": 4,
    "tpPessoaSol": 0,
    "codigoErro": "",
    "descCodigoErro": "",
    "descContrato": "Conta de energia",
    "dtFinalRecorrencia": "2026-01-10",
    "dtHrCancelamento": "2024-09-23T10:10:06.101Z",
    "dtHrCriacaoRecorrencia": "2024-09-20T09:25:49.025Z",
    "valor": 550
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "dtHrSgct": "2024-11-27T22:10:05.025Z",
  "idSgct": "69F963C6-7487-4363-9406-A1DE2A9636D4"
}

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

POST

pix-automatico

authorizations

inbound

cancellation

curl --request POST \
  --url https://api.example.com/v1/pix-automatico/authorizations/inbound/cancellation/register \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cpfCnpjSolCancelamento": "77379362038",
  "dtInicialRecorrencia": "2024-01-10",
  "idCancelamento": "IC0435879820240605bcdb1fhn43a",
  "idRecorrencia": "RR0435879820240920njua7shf40o",
  "motivoCancelamento": 6,
  "nrContrato": "1234567890ABC",
  "pagador": {
    "cpfCnpj": "11111111111",
    "ispb": "99999004",
    "nrConta": "12345678",
    "tpPessoa": 0,
    "codMunIbge": 3550308,
    "nrAgencia": "1234"
  },
  "recebedor": {
    "cnpj": "61695227000193",
    "ispb": "04358798",
    "nome": "Enel"
  },
  "stCancelamento": 0,
  "tpFrequencia": 4,
  "tpPessoaSol": 0,
  "codigoErro": "",
  "descCodigoErro": "",
  "descContrato": "Conta de energia",
  "dtFinalRecorrencia": "2026-01-10",
  "dtHrCancelamento": "2024-09-23T10:10:06.101Z",
  "dtHrCriacaoRecorrencia": "2024-09-20T09:25:49.025Z",
  "valor": 550
}
'

package main

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

func main() {

	url := "https://api.example.com/v1/pix-automatico/authorizations/inbound/cancellation/register"

	payload := strings.NewReader("{\n  \"cpfCnpjSolCancelamento\": \"77379362038\",\n  \"dtInicialRecorrencia\": \"2024-01-10\",\n  \"idCancelamento\": \"IC0435879820240605bcdb1fhn43a\",\n  \"idRecorrencia\": \"RR0435879820240920njua7shf40o\",\n  \"motivoCancelamento\": 6,\n  \"nrContrato\": \"1234567890ABC\",\n  \"pagador\": {\n    \"cpfCnpj\": \"11111111111\",\n    \"ispb\": \"99999004\",\n    \"nrConta\": \"12345678\",\n    \"tpPessoa\": 0,\n    \"codMunIbge\": 3550308,\n    \"nrAgencia\": \"1234\"\n  },\n  \"recebedor\": {\n    \"cnpj\": \"61695227000193\",\n    \"ispb\": \"04358798\",\n    \"nome\": \"Enel\"\n  },\n  \"stCancelamento\": 0,\n  \"tpFrequencia\": 4,\n  \"tpPessoaSol\": 0,\n  \"codigoErro\": \"\",\n  \"descCodigoErro\": \"\",\n  \"descContrato\": \"Conta de energia\",\n  \"dtFinalRecorrencia\": \"2026-01-10\",\n  \"dtHrCancelamento\": \"2024-09-23T10:10:06.101Z\",\n  \"dtHrCriacaoRecorrencia\": \"2024-09-20T09:25:49.025Z\",\n  \"valor\": 550\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({
    cpfCnpjSolCancelamento: '77379362038',
    dtInicialRecorrencia: '2024-01-10',
    idCancelamento: 'IC0435879820240605bcdb1fhn43a',
    idRecorrencia: 'RR0435879820240920njua7shf40o',
    motivoCancelamento: 6,
    nrContrato: '1234567890ABC',
    pagador: {
      cpfCnpj: '11111111111',
      ispb: '99999004',
      nrConta: '12345678',
      tpPessoa: 0,
      codMunIbge: 3550308,
      nrAgencia: '1234'
    },
    recebedor: {cnpj: '61695227000193', ispb: '04358798', nome: 'Enel'},
    stCancelamento: 0,
    tpFrequencia: 4,
    tpPessoaSol: 0,
    codigoErro: '',
    descCodigoErro: '',
    descContrato: 'Conta de energia',
    dtFinalRecorrencia: '2026-01-10',
    dtHrCancelamento: '2024-09-23T10:10:06.101Z',
    dtHrCriacaoRecorrencia: '2024-09-20T09:25:49.025Z',
    valor: 550
  })
};

fetch('https://api.example.com/v1/pix-automatico/authorizations/inbound/cancellation/register', 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/authorizations/inbound/cancellation/register"

payload = {
    "cpfCnpjSolCancelamento": "77379362038",
    "dtInicialRecorrencia": "2024-01-10",
    "idCancelamento": "IC0435879820240605bcdb1fhn43a",
    "idRecorrencia": "RR0435879820240920njua7shf40o",
    "motivoCancelamento": 6,
    "nrContrato": "1234567890ABC",
    "pagador": {
        "cpfCnpj": "11111111111",
        "ispb": "99999004",
        "nrConta": "12345678",
        "tpPessoa": 0,
        "codMunIbge": 3550308,
        "nrAgencia": "1234"
    },
    "recebedor": {
        "cnpj": "61695227000193",
        "ispb": "04358798",
        "nome": "Enel"
    },
    "stCancelamento": 0,
    "tpFrequencia": 4,
    "tpPessoaSol": 0,
    "codigoErro": "",
    "descCodigoErro": "",
    "descContrato": "Conta de energia",
    "dtFinalRecorrencia": "2026-01-10",
    "dtHrCancelamento": "2024-09-23T10:10:06.101Z",
    "dtHrCriacaoRecorrencia": "2024-09-20T09:25:49.025Z",
    "valor": 550
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "dtHrSgct": "2024-11-27T22:10:05.025Z",
  "idSgct": "69F963C6-7487-4363-9406-A1DE2A9636D4"
}

{
  "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.

Cuerpo

application/json

cpfCnpjSolCancelamento

string

requerido

Requester CPF/CNPJ (a v5.5.0 string).

Ejemplo:

"77379362038"

dtInicialRecorrencia

string

requerido

First payment date (aaaa-mm-dd).

Ejemplo:

"2024-01-10"

idCancelamento

string

requerido

Unique cancellation id (29-char, IC...).

Ejemplo:

"IC0435879820240605bcdb1fhn43a"

idRecorrencia

string

requerido

Unique recurrence id (29-char, RR...).

Ejemplo:

"RR0435879820240920njua7shf40o"

motivoCancelamento

integer<int64>

requerido

Cancellation reason (0..10).

Ejemplo:

6

nrContrato

string

requerido

Contract/order identifier (35-char).

Ejemplo:

"1234567890ABC"

pagador

object

requerido

The recurrence pagador.

Show child attributes

recebedor

object

requerido

The recurrence recebedor.

Show child attributes

stCancelamento

integer<int64>

requerido

Cancellation status (0=Aceito, 1=Rejeitado).

Ejemplo:

0

tpFrequencia

integer<int64>

requerido

Recurrence periodicity (0..4).

Ejemplo:

4

tpPessoaSol

integer<int64>

requerido

Requester person type (0=PF, 1=PJ).

Ejemplo:

0

codigoErro

string

JDPI error code (100-char; on a rejected cancellation).

Ejemplo:

""

descCodigoErro

string

JDPI error description (1000-char).

Ejemplo:

""

descContrato

string

Free-text contract description (35-char).

Ejemplo:

"Conta de energia"

devedor

object

The devedor, sent only when it differs from the payer.

Show child attributes

dtFinalRecorrencia

string

Last payment date (aaaa-mm-dd).

Ejemplo:

"2026-01-10"

dtHrCancelamento

string

Cancellation timestamp (UTC).

Ejemplo:

"2024-09-23T10:10:06.101Z"

dtHrCriacaoRecorrencia

string

Recurrence creation timestamp (UTC).

Ejemplo:

"2024-09-20T09:25:49.025Z"

valor

number<double>

Fixed payment amount in reais (a JSON number).

Ejemplo:

550

Respuesta

dtHrSgct

string

requerido

SGCT registration timestamp (UTC).

Ejemplo:

"2024-11-27T22:10:05.025Z"

idSgct

string

requerido

Local SGCT cancellation id (36-char GUID).

Ejemplo:

"69F963C6-7487-4363-9406-A1DE2A9636D4"

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

Register an inbound PIX Automatico cancellation

Autorizaciones

Cuerpo

Respuesta