Cancel a Pix key claim

curl --request POST \
  --url https://api.example.com/dict-hub/v1/claims/{claim_id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Idempotency: <x-idempotency>' \
  --header 'X-Reason: <x-reason>'

package main

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

func main() {

	url := "https://api.example.com/dict-hub/v1/claims/{claim_id}/cancel"

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

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	req.Header.Add("X-Reason", "<x-reason>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency': '<x-idempotency>',
    'X-Reason': '<x-reason>',
    Authorization: 'Bearer <token>'
  }
};

fetch('https://api.example.com/dict-hub/v1/claims/{claim_id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/dict-hub/v1/claims/{claim_id}/cancel"

headers = {
    "X-Idempotency": "<x-idempotency>",
    "X-Reason": "<x-reason>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

{
  "accountId": "019606a1-3b4c-7d8e-9f01-234567890abc",
  "bacenId": "claim-bacen-001",
  "claimId": "019606c3-5d6e-7f80-1b23-456789012cde",
  "claimer": {
    "participant": "87654321",
    "account": {
      "branch": "0001",
      "number": "1234567",
      "openingDate": "2024-03-10",
      "type": "CACC"
    },
    "document": "52998224725",
    "name": "Maria da Silva",
    "personType": "NATURAL_PERSON",
    "tradeName": "Silva ME"
  },
  "createdAt": "2026-05-19T14:30:00Z",
  "donorParticipant": "12345678",
  "keyType": "PHONE",
  "keyValue": "+5511987659999",
  "lastModified": "2026-05-19T14:32:11Z",
  "status": "WAITING_RESOLUTION",
  "type": "PORTABILITY",
  "updatedAt": "2026-05-19T14:32:11Z",
  "cancelReason": "<string>",
  "cancelledBy": "<string>",
  "completionPeriodEnd": "2026-06-18T03:00:00Z",
  "confirmReason": "<string>",
  "correlationId": "a9f13566e19f5ca51329479a5bae60c5",
  "requestId": "e7c1a2b3-4d5e-6f70-8a90-1b2c3d4e5f60",
  "resolutionPeriodEnd": "2026-05-25T03:00:00Z"
}

{
  "code": "PIX-0030",
  "title": "Idempotency Key Required",
  "message": "The Idempotency-Key header is required for this operation and must be within the accepted length."
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0145",
  "title": "Not Found",
  "status": 404,
  "detail": "No claim was found for the given identifier and account.",
  "code": "PIX-0145"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0144",
  "title": "Conflict",
  "status": 409,
  "detail": "The X-Request-Id was already seen with a different request body.",
  "code": "PIX-0144"
}

{
  "code": "PIX-0031",
  "title": "Idempotency Key Conflict",
  "message": "The Idempotency-Key was already used with a different request."
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0146",
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "The requested claim type and key type combination is not supported.",
  "code": "PIX-0146"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0148",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The rate limit for this claim operation has been exceeded.",
  "code": "PIX-0148"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0000",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "internal error",
  "code": "PIX-0000"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0140",
  "title": "Bad Gateway",
  "status": 502,
  "detail": "internal error",
  "code": "PIX-0140"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0164",
  "title": "Service Unavailable",
  "status": 503,
  "detail": "internal error",
  "code": "PIX-0164"
}

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

claims

{claim_id}

cancel

Cancel a Pix key claim

curl --request POST \
  --url https://api.example.com/dict-hub/v1/claims/{claim_id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Idempotency: <x-idempotency>' \
  --header 'X-Reason: <x-reason>'

package main

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

func main() {

	url := "https://api.example.com/dict-hub/v1/claims/{claim_id}/cancel"

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

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	req.Header.Add("X-Reason", "<x-reason>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency': '<x-idempotency>',
    'X-Reason': '<x-reason>',
    Authorization: 'Bearer <token>'
  }
};

fetch('https://api.example.com/dict-hub/v1/claims/{claim_id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/dict-hub/v1/claims/{claim_id}/cancel"

headers = {
    "X-Idempotency": "<x-idempotency>",
    "X-Reason": "<x-reason>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

{
  "accountId": "019606a1-3b4c-7d8e-9f01-234567890abc",
  "bacenId": "claim-bacen-001",
  "claimId": "019606c3-5d6e-7f80-1b23-456789012cde",
  "claimer": {
    "participant": "87654321",
    "account": {
      "branch": "0001",
      "number": "1234567",
      "openingDate": "2024-03-10",
      "type": "CACC"
    },
    "document": "52998224725",
    "name": "Maria da Silva",
    "personType": "NATURAL_PERSON",
    "tradeName": "Silva ME"
  },
  "createdAt": "2026-05-19T14:30:00Z",
  "donorParticipant": "12345678",
  "keyType": "PHONE",
  "keyValue": "+5511987659999",
  "lastModified": "2026-05-19T14:32:11Z",
  "status": "WAITING_RESOLUTION",
  "type": "PORTABILITY",
  "updatedAt": "2026-05-19T14:32:11Z",
  "cancelReason": "<string>",
  "cancelledBy": "<string>",
  "completionPeriodEnd": "2026-06-18T03:00:00Z",
  "confirmReason": "<string>",
  "correlationId": "a9f13566e19f5ca51329479a5bae60c5",
  "requestId": "e7c1a2b3-4d5e-6f70-8a90-1b2c3d4e5f60",
  "resolutionPeriodEnd": "2026-05-25T03:00:00Z"
}

{
  "code": "PIX-0030",
  "title": "Idempotency Key Required",
  "message": "The Idempotency-Key header is required for this operation and must be within the accepted length."
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0145",
  "title": "Not Found",
  "status": 404,
  "detail": "No claim was found for the given identifier and account.",
  "code": "PIX-0145"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0144",
  "title": "Conflict",
  "status": 409,
  "detail": "The X-Request-Id was already seen with a different request body.",
  "code": "PIX-0144"
}

{
  "code": "PIX-0031",
  "title": "Idempotency Key Conflict",
  "message": "The Idempotency-Key was already used with a different request."
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0146",
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "The requested claim type and key type combination is not supported.",
  "code": "PIX-0146"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0148",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The rate limit for this claim operation has been exceeded.",
  "code": "PIX-0148"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0000",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "internal error",
  "code": "PIX-0000"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0140",
  "title": "Bad Gateway",
  "status": 502,
  "detail": "internal error",
  "code": "PIX-0140"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0164",
  "title": "Service Unavailable",
  "status": 503,
  "detail": "internal error",
  "code": "PIX-0164"
}

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

Encabezados

X-Idempotency

string

requerido

REQUIRED. Client-supplied replay key, at most 64 bytes. A request without it is refused with PIX-0030 @ 400 before the handler runs. Replaying the same key with a divergent method, URL or body is PIX-0031 @ 412.

Required string length: 1 - 64

X-Account-Id

string

Ejemplo:

"019606a1-3b4c-7d8e-9f01-234567890abc"

X-Reason

enum<string>

requerido

Reason for the cancellation. The enum lists the canonical uppercase spelling; the server also accepts other casing and normalizes it, but clients SHOULD send the canonical form.

Opciones disponibles:

USER_REQUESTED,

ACCOUNT_CLOSURE,

FRAUD,

DEFAULT_OPERATION,

RECONCILIATION,

RFB_VALIDATION,

COURT_ORDER

Maximum string length: 64

Ejemplo:

"USER_REQUESTED"

Parámetros de ruta

claim_id

string

requerido

Ejemplo:

"019606c3-5d6e-7f80-1b23-456789012cde"

Respuesta

accountId

string

requerido

Ejemplo:

"019606a1-3b4c-7d8e-9f01-234567890abc"

bacenId

string

requerido

Ejemplo:

"claim-bacen-001"

claimId

string

requerido

Ejemplo:

"019606c3-5d6e-7f80-1b23-456789012cde"

claimer

object

requerido

Show child attributes

createdAt

string

requerido

Ejemplo:

"2026-05-19T14:30:00Z"

donorParticipant

string

requerido

Ejemplo:

"12345678"

keyType

string

requerido

Ejemplo:

"PHONE"

keyValue

string

requerido

Ejemplo:

"+5511987659999"

lastModified

string

requerido

Ejemplo:

"2026-05-19T14:32:11Z"

status

string

requerido

Ejemplo:

"WAITING_RESOLUTION"

type

string

requerido

Ejemplo:

"PORTABILITY"

updatedAt

string

requerido

Ejemplo:

"2026-05-19T14:32:11Z"

cancelReason

string

cancelledBy

string

completionPeriodEnd

string

Ejemplo:

"2026-06-18T03:00:00Z"

confirmReason

string

correlationId

string

Ejemplo:

"a9f13566e19f5ca51329479a5bae60c5"

requestId

string

Ejemplo:

"e7c1a2b3-4d5e-6f70-8a90-1b2c3d4e5f60"

resolutionPeriodEnd

string

Ejemplo:

"2026-05-25T03:00:00Z"

DICT y claves Pix

Cobros y códigos BR

Pagos y devoluciones

Manejo de errores

Cancel a Pix key claim

Autorizaciones

Encabezados

Parámetros de ruta

Respuesta