Effect an inbound PIX Automatico settlement debit

curl --request POST \
  --url https://api.example.com/v1/pix-automatico/settlements/inbound/debit \
  --header 'Authorization: Bearer <token>' \
  --header 'Chave-Idempotencia: <chave-idempotencia>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dtContabil": "2024-09-20",
  "dtHrEfetivacao": "2024-09-20T04:00:01.001Z",
  "dtHrLiquidacao": "2024-09-20T04:00:00.023Z",
  "endToEndId": "E11111111202409181500y6j6mt9l1pi",
  "ispb": "04358798"
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"dtContabil\": \"2024-09-20\",\n  \"dtHrEfetivacao\": \"2024-09-20T04:00:01.001Z\",\n  \"dtHrLiquidacao\": \"2024-09-20T04:00:00.023Z\",\n  \"endToEndId\": \"E11111111202409181500y6j6mt9l1pi\",\n  \"ispb\": \"04358798\"\n}")

	req, _ := http.NewRequest("POST", 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: 'POST',
  headers: {
    'Chave-Idempotencia': '<chave-idempotencia>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    dtContabil: '2024-09-20',
    dtHrEfetivacao: '2024-09-20T04:00:01.001Z',
    dtHrLiquidacao: '2024-09-20T04:00:00.023Z',
    endToEndId: 'E11111111202409181500y6j6mt9l1pi',
    ispb: '04358798'
  })
};

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

payload = {
    "dtContabil": "2024-09-20",
    "dtHrEfetivacao": "2024-09-20T04:00:01.001Z",
    "dtHrLiquidacao": "2024-09-20T04:00:00.023Z",
    "endToEndId": "E11111111202409181500y6j6mt9l1pi",
    "ispb": "04358798"
}
headers = {
    "Chave-Idempotencia": "<chave-idempotencia>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "dtHrOperacaoSgct": "2024-09-20T04:00:01.001Z",
  "endToEndId": "E11111111202409181500y6j6mt9l1pi",
  "idOperacaoSgct": "58F752C5-6376-3252-8305-A2DE3A8525D3"
}

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

Effect an inbound PIX Automatico settlement debit

Posts the real double-entry settlement debit on the payer’s local ledger for a scheduled PIX Automatico payment (section 5.4.2, the plugin is the SGCT server). JDPI calls this after it confirms SPI settlement. The amount was established at schedule/block time, so the body carries no value. Returns the SGCT debit-operation id (idOperacaoSgct). A re-delivery resolves to a clean 200 with the prior confirmation, never a double post.

POST

pix-automatico

settlements

inbound

debit

Effect an inbound PIX Automatico settlement debit

curl --request POST \
  --url https://api.example.com/v1/pix-automatico/settlements/inbound/debit \
  --header 'Authorization: Bearer <token>' \
  --header 'Chave-Idempotencia: <chave-idempotencia>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dtContabil": "2024-09-20",
  "dtHrEfetivacao": "2024-09-20T04:00:01.001Z",
  "dtHrLiquidacao": "2024-09-20T04:00:00.023Z",
  "endToEndId": "E11111111202409181500y6j6mt9l1pi",
  "ispb": "04358798"
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"dtContabil\": \"2024-09-20\",\n  \"dtHrEfetivacao\": \"2024-09-20T04:00:01.001Z\",\n  \"dtHrLiquidacao\": \"2024-09-20T04:00:00.023Z\",\n  \"endToEndId\": \"E11111111202409181500y6j6mt9l1pi\",\n  \"ispb\": \"04358798\"\n}")

	req, _ := http.NewRequest("POST", 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: 'POST',
  headers: {
    'Chave-Idempotencia': '<chave-idempotencia>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    dtContabil: '2024-09-20',
    dtHrEfetivacao: '2024-09-20T04:00:01.001Z',
    dtHrLiquidacao: '2024-09-20T04:00:00.023Z',
    endToEndId: 'E11111111202409181500y6j6mt9l1pi',
    ispb: '04358798'
  })
};

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

payload = {
    "dtContabil": "2024-09-20",
    "dtHrEfetivacao": "2024-09-20T04:00:01.001Z",
    "dtHrLiquidacao": "2024-09-20T04:00:00.023Z",
    "endToEndId": "E11111111202409181500y6j6mt9l1pi",
    "ispb": "04358798"
}
headers = {
    "Chave-Idempotencia": "<chave-idempotencia>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "dtHrOperacaoSgct": "2024-09-20T04:00:01.001Z",
  "endToEndId": "E11111111202409181500y6j6mt9l1pi",
  "idOperacaoSgct": "58F752C5-6376-3252-8305-A2DE3A8525D3"
}

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

Cuerpo

application/json

dtContabil

string

requerido

Accounting date (aaaa-mm-dd).

Ejemplo:

"2024-09-20"

dtHrEfetivacao

string

requerido

JDPI effectuation timestamp (UTC).

Ejemplo:

"2024-09-20T04:00:01.001Z"

dtHrLiquidacao

string

requerido

SPI settlement timestamp (UTC).

Ejemplo:

"2024-09-20T04:00:00.023Z"

endToEndId

string

requerido

Unique payment-instruction id (32-char).

Ejemplo:

"E11111111202409181500y6j6mt9l1pi"

ispb

string

requerido

Payer participant ISPB (8 digits, a v5.5.0 string).

Ejemplo:

"04358798"

Respuesta

dtHrOperacaoSgct

string

requerido

SGCT operation timestamp (UTC).

Ejemplo:

"2024-09-20T04:00:01.001Z"

endToEndId

string

requerido

Unique payment-instruction id (32-char).

Ejemplo:

"E11111111202409181500y6j6mt9l1pi"

idOperacaoSgct

string

requerido

SGCT debit-operation id (the Midaz transaction id, a GUID).

Ejemplo:

"58F752C5-6376-3252-8305-A2DE3A8525D3"

APIs del participante directo

APIs de participantes indirectos

Effect an inbound PIX Automatico settlement debit

Autorizaciones

Encabezados

Cuerpo

Respuesta