Reverse an inbound PIX Automatico settlement debit

curl --request DELETE \
  --url https://api.example.com/v1/pix-automatico/settlements/inbound/debit/{endToEndId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Chave-Idempotencia: <chave-idempotencia>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "codigoErro": "AB03",
  "endToEndId": "E11111111202409181500y6j6mt9l1pi",
  "stJdPiProc": 3,
  "descCodigoErro": "Liquidacao da transacao interrompida devido a timeout no SPI."
}
'

package main

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

func main() {

	url := "https://api.example.com/v1/pix-automatico/settlements/inbound/debit/{endToEndId}"

	payload := strings.NewReader("{\n  \"codigoErro\": \"AB03\",\n  \"endToEndId\": \"E11111111202409181500y6j6mt9l1pi\",\n  \"stJdPiProc\": 3,\n  \"descCodigoErro\": \"Liquidacao da transacao interrompida devido a timeout no SPI.\"\n}")

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

	req.Header.Add("Chave-Idempotencia", "<chave-idempotencia>")
	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: {
    'Chave-Idempotencia': '<chave-idempotencia>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    codigoErro: 'AB03',
    endToEndId: 'E11111111202409181500y6j6mt9l1pi',
    stJdPiProc: 3,
    descCodigoErro: 'Liquidacao da transacao interrompida devido a timeout no SPI.'
  })
};

fetch('https://api.example.com/v1/pix-automatico/settlements/inbound/debit/{endToEndId}', 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/settlements/inbound/debit/{endToEndId}"

payload = {
    "codigoErro": "AB03",
    "endToEndId": "E11111111202409181500y6j6mt9l1pi",
    "stJdPiProc": 3,
    "descCodigoErro": "Liquidacao da transacao interrompida devido a timeout no SPI."
}
headers = {
    "Chave-Idempotencia": "<chave-idempotencia>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "dtHrOperacaoSgct": "2024-09-20T04:02:00.021Z",
  "endToEndId": "E11111111202409181500y6j6mt9l1pi",
  "idOperacaoSgct": "58F752C5-6376-3252-8305-A2DE3A8525D4"
}

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

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

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

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

pix-automatico

settlements

inbound

debit

{endToEndId}

Reverse an inbound PIX Automatico settlement debit

curl --request DELETE \
  --url https://api.example.com/v1/pix-automatico/settlements/inbound/debit/{endToEndId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Chave-Idempotencia: <chave-idempotencia>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "codigoErro": "AB03",
  "endToEndId": "E11111111202409181500y6j6mt9l1pi",
  "stJdPiProc": 3,
  "descCodigoErro": "Liquidacao da transacao interrompida devido a timeout no SPI."
}
'

package main

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

func main() {

	url := "https://api.example.com/v1/pix-automatico/settlements/inbound/debit/{endToEndId}"

	payload := strings.NewReader("{\n  \"codigoErro\": \"AB03\",\n  \"endToEndId\": \"E11111111202409181500y6j6mt9l1pi\",\n  \"stJdPiProc\": 3,\n  \"descCodigoErro\": \"Liquidacao da transacao interrompida devido a timeout no SPI.\"\n}")

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

	req.Header.Add("Chave-Idempotencia", "<chave-idempotencia>")
	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: {
    'Chave-Idempotencia': '<chave-idempotencia>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    codigoErro: 'AB03',
    endToEndId: 'E11111111202409181500y6j6mt9l1pi',
    stJdPiProc: 3,
    descCodigoErro: 'Liquidacao da transacao interrompida devido a timeout no SPI.'
  })
};

fetch('https://api.example.com/v1/pix-automatico/settlements/inbound/debit/{endToEndId}', 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/settlements/inbound/debit/{endToEndId}"

payload = {
    "codigoErro": "AB03",
    "endToEndId": "E11111111202409181500y6j6mt9l1pi",
    "stJdPiProc": 3,
    "descCodigoErro": "Liquidacao da transacao interrompida devido a timeout no SPI."
}
headers = {
    "Chave-Idempotencia": "<chave-idempotencia>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "dtHrOperacaoSgct": "2024-09-20T04:02:00.021Z",
  "endToEndId": "E11111111202409181500y6j6mt9l1pi",
  "idOperacaoSgct": "58F752C5-6376-3252-8305-A2DE3A8525D4"
}

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

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

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

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

Authorization

string

Bearer access token (the financial-ingress gate; the handler fails closed with PIX-0082 when absent).

Ejemplo:

"Bearer eyJ..."

Chave-Idempotencia

string

requerido

Idempotency key (= the endToEndId of the transaction). Mandatory per section 5.4.

Ejemplo:

"E11111111202409181500y6j6mt9l1pi"

Parámetros de ruta

endToEndId

string

requerido

Unique payment-instruction id (32-char), the natural key.

Ejemplo:

"E11111111202409181500y6j6mt9l1pi"

Cuerpo

application/json

codigoErro

string

requerido

Error code (the section 8.7 generic SPI domain; NOT the section 5.3 motivoRejeicao set).

Ejemplo:

"AB03"

endToEndId

string

requerido

Unique payment-instruction id (32-char; matches the path param).

Ejemplo:

"E11111111202409181500y6j6mt9l1pi"

stJdPiProc

integer<int64>

requerido

Negative-return classification (1=processing error, 2=JDPI validation error, 3=SPI-returned error).

Ejemplo:

3

descCodigoErro

string

Error description (1000-char).

Ejemplo:

"Liquidacao da transacao interrompida devido a timeout no SPI."

Respuesta

dtHrOperacaoSgct

string

requerido

SGCT operation timestamp (UTC).

Ejemplo:

"2024-09-20T04:02:00.021Z"

endToEndId

string

requerido

Unique payment-instruction id (32-char).

Ejemplo:

"E11111111202409181500y6j6mt9l1pi"

idOperacaoSgct

string

requerido

SGCT reversal-operation id (a GUID).

Ejemplo:

"58F752C5-6376-3252-8305-A2DE3A8525D4"

APIs del participante directo

APIs de participantes indirectos

Reverse an inbound PIX Automatico settlement debit

Autorizaciones

Encabezados

Parámetros de ruta

Cuerpo

Respuesta