Cancel an immediate collection

curl --request DELETE \
  --url https://api.example.com/cob-hub/v1/collections/immediate/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --data '
{
  "reason": "Customer requested cancellation"
}
'

package main

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

func main() {

	url := "https://api.example.com/cob-hub/v1/collections/immediate/{id}"

	payload := strings.NewReader("{\n  \"reason\": \"Customer requested cancellation\"\n}")

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

	req.Header.Add("X-Account-Id", "<x-account-id>")
	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: 'DELETE',
  headers: {
    'X-Account-Id': '<x-account-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({reason: 'Customer requested cancellation'})
};

fetch('https://api.example.com/cob-hub/v1/collections/immediate/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/cob-hub/v1/collections/immediate/{id}"

payload = { "reason": "Customer requested cancellation" }
headers = {
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "accountId": "0196a7b2-3e5f-7061-ac12-34567890abcd",
  "amount": "100.50",
  "createdAt": "2026-05-06T10:30:00Z",
  "currency": "BRL",
  "emvPayload": "00020101021226500014br.gov.bcb.pix2528pix.example.com/qr/v2/abc1235204000053039865802BR5910Loja Teste6007Goiania62070503***63041206",
  "expirationSeconds": 3600,
  "expiresAt": "2026-05-06T11:30:00Z",
  "externalId": "0196a7b2-4f60-7172-bd23-4567890abcde",
  "id": "0196a7b2-1c3d-7e4f-8a90-1234567890ab",
  "keyType": "EVP",
  "keyValue": "123e4567-e12b-12d1-a456-426655440000",
  "locationUrl": "https://pix.example.com/qr/v2/abc123",
  "merchantCity": "Goiania",
  "merchantDocument": "39053344705",
  "merchantName": "Loja Teste",
  "organizationId": "0196a7b2-2d4e-7f50-9b01-234567890abc",
  "status": "ACTIVE",
  "txId": "TX1234567890123456789012345",
  "type": "IMMEDIATE",
  "updatedAt": "2026-05-06T10:30:00Z",
  "additionalInfo": [
    {
      "key": "orderId",
      "value": "12345"
    }
  ],
  "cancelledAt": "2026-05-06T10:40:00Z",
  "cancelledReason": "Customer requested cancellation",
  "debtor": {
    "document": "39053344705",
    "name": "João da Silva"
  },
  "description": "Pagamento do pedido 12345",
  "payment": {
    "amount": "100.50",
    "endToEndId": "E12345678202605061030abcdef12345",
    "paidAt": "2026-05-06T10:35:00Z",
    "payer": {
      "ispb": "12345678",
      "name": "João da Silva",
      "taxId": "39053344705"
    }
  }
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0200",
  "title": "Bad Request",
  "status": 400,
  "detail": "Missing or malformed required fields.",
  "code": "PIX-0200"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0240",
  "title": "Not Found",
  "status": 404,
  "detail": "No collection found for the given identifiers.",
  "code": "PIX-0240"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0226",
  "title": "Conflict",
  "status": 409,
  "detail": "The request conflicts with the provider's current state or with a request still in flight.",
  "code": "PIX-0226"
}

{
  "code": "PIX-0016",
  "title": "Unsupported Media Type",
  "message": "The request body must be sent with Content-Type: application/json."
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0241",
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Collection is in a terminal state (already CANCELLED or COMPLETED) and cannot transition.",
  "code": "PIX-0241"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0000",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "The server encountered an unexpected error. Please try again later.",
  "code": "PIX-0000"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0223",
  "title": "Bad Gateway",
  "status": 502,
  "detail": "Provider adapter is unreachable.",
  "code": "PIX-0223"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0054",
  "title": "Gateway Timeout",
  "status": 504,
  "detail": "The request timed out. Please try again later.",
  "code": "PIX-0054"
}

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

DELETE

collections

immediate

{id}

Cancel an immediate collection

curl --request DELETE \
  --url https://api.example.com/cob-hub/v1/collections/immediate/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --data '
{
  "reason": "Customer requested cancellation"
}
'

package main

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

func main() {

	url := "https://api.example.com/cob-hub/v1/collections/immediate/{id}"

	payload := strings.NewReader("{\n  \"reason\": \"Customer requested cancellation\"\n}")

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

	req.Header.Add("X-Account-Id", "<x-account-id>")
	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: 'DELETE',
  headers: {
    'X-Account-Id': '<x-account-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({reason: 'Customer requested cancellation'})
};

fetch('https://api.example.com/cob-hub/v1/collections/immediate/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/cob-hub/v1/collections/immediate/{id}"

payload = { "reason": "Customer requested cancellation" }
headers = {
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "accountId": "0196a7b2-3e5f-7061-ac12-34567890abcd",
  "amount": "100.50",
  "createdAt": "2026-05-06T10:30:00Z",
  "currency": "BRL",
  "emvPayload": "00020101021226500014br.gov.bcb.pix2528pix.example.com/qr/v2/abc1235204000053039865802BR5910Loja Teste6007Goiania62070503***63041206",
  "expirationSeconds": 3600,
  "expiresAt": "2026-05-06T11:30:00Z",
  "externalId": "0196a7b2-4f60-7172-bd23-4567890abcde",
  "id": "0196a7b2-1c3d-7e4f-8a90-1234567890ab",
  "keyType": "EVP",
  "keyValue": "123e4567-e12b-12d1-a456-426655440000",
  "locationUrl": "https://pix.example.com/qr/v2/abc123",
  "merchantCity": "Goiania",
  "merchantDocument": "39053344705",
  "merchantName": "Loja Teste",
  "organizationId": "0196a7b2-2d4e-7f50-9b01-234567890abc",
  "status": "ACTIVE",
  "txId": "TX1234567890123456789012345",
  "type": "IMMEDIATE",
  "updatedAt": "2026-05-06T10:30:00Z",
  "additionalInfo": [
    {
      "key": "orderId",
      "value": "12345"
    }
  ],
  "cancelledAt": "2026-05-06T10:40:00Z",
  "cancelledReason": "Customer requested cancellation",
  "debtor": {
    "document": "39053344705",
    "name": "João da Silva"
  },
  "description": "Pagamento do pedido 12345",
  "payment": {
    "amount": "100.50",
    "endToEndId": "E12345678202605061030abcdef12345",
    "paidAt": "2026-05-06T10:35:00Z",
    "payer": {
      "ispb": "12345678",
      "name": "João da Silva",
      "taxId": "39053344705"
    }
  }
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0200",
  "title": "Bad Request",
  "status": 400,
  "detail": "Missing or malformed required fields.",
  "code": "PIX-0200"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0240",
  "title": "Not Found",
  "status": 404,
  "detail": "No collection found for the given identifiers.",
  "code": "PIX-0240"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0226",
  "title": "Conflict",
  "status": 409,
  "detail": "The request conflicts with the provider's current state or with a request still in flight.",
  "code": "PIX-0226"
}

{
  "code": "PIX-0016",
  "title": "Unsupported Media Type",
  "message": "The request body must be sent with Content-Type: application/json."
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0241",
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Collection is in a terminal state (already CANCELLED or COMPLETED) and cannot transition.",
  "code": "PIX-0241"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0000",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "The server encountered an unexpected error. Please try again later.",
  "code": "PIX-0000"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0223",
  "title": "Bad Gateway",
  "status": 502,
  "detail": "Provider adapter is unreachable.",
  "code": "PIX-0223"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0054",
  "title": "Gateway Timeout",
  "status": 504,
  "detail": "The request timed out. Please try again later.",
  "code": "PIX-0054"
}

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

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Account-Id

string

requerido

Receiver merchant account UUID

Ejemplo:

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

Parámetros de ruta

string

requerido

Collection UUID

Ejemplo:

"019e22f9-aabe-7ec9-ba6b-41608b9accf9"

Cuerpo

application/json

reason

string

Optional cancellation reason

Ejemplo:

"Customer requested cancellation"

Respuesta

accountId

string

requerido

Ejemplo:

"0196a7b2-3e5f-7061-ac12-34567890abcd"

amount

string

requerido

Ejemplo:

"100.50"

createdAt

string<date-time>

requerido

Ejemplo:

"2026-05-06T10:30:00Z"

currency

enum<string>

requerido

Opciones disponibles:

BRL

Ejemplo:

"BRL"

emvPayload

string

requerido

Ejemplo:

"00020101021226500014br.gov.bcb.pix2528pix.example.com/qr/v2/abc1235204000053039865802BR5910Loja Teste6007Goiania62070503***63041206"

expirationSeconds

integer<int64>

requerido

Ejemplo:

3600

expiresAt

string<date-time>

requerido

Ejemplo:

"2026-05-06T11:30:00Z"

externalId

string

requerido

Ejemplo:

"0196a7b2-4f60-7172-bd23-4567890abcde"

string

requerido

Ejemplo:

"0196a7b2-1c3d-7e4f-8a90-1234567890ab"

keyType

enum<string>

requerido

Opciones disponibles:

CPF,

CNPJ,

PHONE,

EMAIL,

EVP

Ejemplo:

"EVP"

keyValue

string

requerido

Ejemplo:

"123e4567-e12b-12d1-a456-426655440000"

locationUrl

string

requerido

Ejemplo:

"https://pix.example.com/qr/v2/abc123"

merchantCity

string

requerido

Ejemplo:

"Goiania"

merchantDocument

string

requerido

Ejemplo:

"39053344705"

merchantName

string

requerido

Ejemplo:

"Loja Teste"

organizationId

string

requerido

Ejemplo:

"0196a7b2-2d4e-7f50-9b01-234567890abc"

status

enum<string>

requerido

Opciones disponibles:

ACTIVE,

COMPLETED,

CANCELLED

Ejemplo:

"ACTIVE"

txId

string

requerido

Ejemplo:

"TX1234567890123456789012345"

type

enum<string>

requerido

Opciones disponibles:

IMMEDIATE,

DUE_DATE

Ejemplo:

"IMMEDIATE"

updatedAt

string<date-time>

requerido

Ejemplo:

"2026-05-06T10:30:00Z"

additionalInfo

object[] | null

Show child attributes

cancelledAt

string<date-time>

Ejemplo:

"2026-05-06T10:40:00Z"

cancelledReason

string

Ejemplo:

"Customer requested cancellation"

debtor

object

Show child attributes

description

string

Ejemplo:

"Pagamento do pedido 12345"

payment

object

Show child attributes

DICT y claves Pix

Cobros y códigos BR

Pagos y devoluciones

API de Pix Automático

Manejo de errores

Cancel an immediate collection

Autorizaciones

Encabezados

Parámetros de ruta

Cuerpo

Respuesta