Process an inbound JDPI cash-in

curl --request POST \
  --url https://api.example.com/v1/webhooks/cash-ins \
  --header 'Authorization: Bearer <token>' \
  --header 'Chave-Idempotencia: <chave-idempotencia>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dtHrOp": "2026-06-20T10:00:00Z",
  "endToEndId": "E2E-1",
  "idReqJdPi": "JDPI-1",
  "pagador": {
    "cpfCnpj": "11144477735",
    "ispb": "12345678",
    "nome": "Jane Doe",
    "nrConta": "1234567",
    "nrAgencia": "0001",
    "tpConta": 0,
    "tpPessoa": 0
  },
  "recebedor": {
    "cpfCnpj": "11144477735",
    "ispb": "12345678",
    "nrConta": "1234567",
    "nrAgencia": "0001",
    "tpConta": 0,
    "tpPessoa": 0
  },
  "tpIniciacao": 0,
  "valor": 100.5,
  "chave": "recipient@bank.com",
  "cnpjIniciadorPagamento": "11144477735",
  "dtContabil": "2026-06-20",
  "dtHrLiquidacao": "2026-06-20T10:00:01Z",
  "finalidade": 0,
  "idConciliacaoRecebedor": "CONC-1",
  "infEntreClientes": "note",
  "ispbPss": "12345678",
  "modalidadeAgente": 0,
  "prioridadePagamento": 0,
  "tpPrioridadePagamento": 0,
  "vlrDetalhe": [
    {
      "tipo": 0,
      "vlrTarifaDinheiroCompra": 0
    }
  ]
}
'

package main

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

func main() {

	url := "https://api.example.com/v1/webhooks/cash-ins"

	payload := strings.NewReader("{\n  \"dtHrOp\": \"2026-06-20T10:00:00Z\",\n  \"endToEndId\": \"E2E-1\",\n  \"idReqJdPi\": \"JDPI-1\",\n  \"pagador\": {\n    \"cpfCnpj\": \"11144477735\",\n    \"ispb\": \"12345678\",\n    \"nome\": \"Jane Doe\",\n    \"nrConta\": \"1234567\",\n    \"nrAgencia\": \"0001\",\n    \"tpConta\": 0,\n    \"tpPessoa\": 0\n  },\n  \"recebedor\": {\n    \"cpfCnpj\": \"11144477735\",\n    \"ispb\": \"12345678\",\n    \"nrConta\": \"1234567\",\n    \"nrAgencia\": \"0001\",\n    \"tpConta\": 0,\n    \"tpPessoa\": 0\n  },\n  \"tpIniciacao\": 0,\n  \"valor\": 100.5,\n  \"chave\": \"recipient@bank.com\",\n  \"cnpjIniciadorPagamento\": \"11144477735\",\n  \"dtContabil\": \"2026-06-20\",\n  \"dtHrLiquidacao\": \"2026-06-20T10:00:01Z\",\n  \"finalidade\": 0,\n  \"idConciliacaoRecebedor\": \"CONC-1\",\n  \"infEntreClientes\": \"note\",\n  \"ispbPss\": \"12345678\",\n  \"modalidadeAgente\": 0,\n  \"prioridadePagamento\": 0,\n  \"tpPrioridadePagamento\": 0,\n  \"vlrDetalhe\": [\n    {\n      \"tipo\": 0,\n      \"vlrTarifaDinheiroCompra\": 0\n    }\n  ]\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({
    dtHrOp: '2026-06-20T10:00:00Z',
    endToEndId: 'E2E-1',
    idReqJdPi: 'JDPI-1',
    pagador: {
      cpfCnpj: '11144477735',
      ispb: '12345678',
      nome: 'Jane Doe',
      nrConta: '1234567',
      nrAgencia: '0001',
      tpConta: 0,
      tpPessoa: 0
    },
    recebedor: {
      cpfCnpj: '11144477735',
      ispb: '12345678',
      nrConta: '1234567',
      nrAgencia: '0001',
      tpConta: 0,
      tpPessoa: 0
    },
    tpIniciacao: 0,
    valor: 100.5,
    chave: 'recipient@bank.com',
    cnpjIniciadorPagamento: '11144477735',
    dtContabil: '2026-06-20',
    dtHrLiquidacao: '2026-06-20T10:00:01Z',
    finalidade: 0,
    idConciliacaoRecebedor: 'CONC-1',
    infEntreClientes: 'note',
    ispbPss: '12345678',
    modalidadeAgente: 0,
    prioridadePagamento: 0,
    tpPrioridadePagamento: 0,
    vlrDetalhe: [{tipo: 0, vlrTarifaDinheiroCompra: 0}]
  })
};

fetch('https://api.example.com/v1/webhooks/cash-ins', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/webhooks/cash-ins"

payload = {
    "dtHrOp": "2026-06-20T10:00:00Z",
    "endToEndId": "E2E-1",
    "idReqJdPi": "JDPI-1",
    "pagador": {
        "cpfCnpj": "11144477735",
        "ispb": "12345678",
        "nome": "Jane Doe",
        "nrConta": "1234567",
        "nrAgencia": "0001",
        "tpConta": 0,
        "tpPessoa": 0
    },
    "recebedor": {
        "cpfCnpj": "11144477735",
        "ispb": "12345678",
        "nrConta": "1234567",
        "nrAgencia": "0001",
        "tpConta": 0,
        "tpPessoa": 0
    },
    "tpIniciacao": 0,
    "valor": 100.5,
    "chave": "recipient@bank.com",
    "cnpjIniciadorPagamento": "11144477735",
    "dtContabil": "2026-06-20",
    "dtHrLiquidacao": "2026-06-20T10:00:01Z",
    "finalidade": 0,
    "idConciliacaoRecebedor": "CONC-1",
    "infEntreClientes": "note",
    "ispbPss": "12345678",
    "modalidadeAgente": 0,
    "prioridadePagamento": 0,
    "tpPrioridadePagamento": 0,
    "vlrDetalhe": [
        {
            "tipo": 0,
            "vlrTarifaDinheiroCompra": 0
        }
    ]
}
headers = {
    "Chave-Idempotencia": "<chave-idempotencia>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "dtHrCreditoSgct": "2026-06-20T10:00:01Z",
  "dtHrReqJdPi": "2026-06-20T10:00:00Z",
  "endToEndIdDevolucao": "E2E-1",
  "endToEndIdOriginal": "E2E-1",
  "idCreditoSgct": "SGCT-1",
  "idReqJdPi": "JDPI-1",
  "idReqSistemaCliente": "JDPI-1"
}

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

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

Process an inbound JDPI cash-in

Registers an inbound PIX credit that JDPI has settled to this participant (JDPI section 9.3.2). JDPI calls it once per received credit, after settlement; it is idempotent on the end-to-end id (the mandatory Chave-Idempotencia header), so a redelivery of a credit already registered answers 409 PIX-0029 rather than posting the credit twice.

On success the credit is posted to the receiving customer’s account and the response carries the three section 9.3.2 members: idReqJdPi, idCreditoSgct (the identifier of the credit entry this participant recorded) and dtHrCreditoSgct (when it was recorded). That response is an assertion that the money was booked; there is no field in it for a refusal.

NOT EVERY CREDIT LANDS ON A CUSTOMER ACCOUNT. This participant may also serve INDIRECT participants — other institutions that reach SPI through this participant’s ISPB and are registered here with POST /v1/indirects. When recebedor.ispb names one of them and its registration is ACTIVE, the credit is posted to THAT institution’s @pi_{ispb} settlement position instead of to a customer account. The destination is read from the registry row, never from the payload, and the recorded credit is stamped with the institution it belongs to. The 200 body is identical in both cases, so the response does not tell you which destination was used; that institution’s own movements are read with GET /v1/indirects//transactions.

An indirect credit also queues a NOTICE to the endpoint that registration carries (delivery.endpointUrl): one HTTPS POST forwarding this webhook’s JD body verbatim, carrying X-Lerian-Signature (‘sha256=’ followed by the hex HMAC-SHA256 of the exact body bytes under the registration’s shared secret) and X-Lerian-Timestamp (the send time in Unix seconds, not covered by the signature). The notice is enqueued in the same database transaction as the credit, but its delivery is AT-LEAST-ONCE and independent of this 200: the same notice can arrive more than once, and it can also fail permanently while the money stays booked. A receiving institution must dedup on endToEndId and must treat the movements feed, not the notice, as the record of truth.

Three ordering rules decide the destination and cannot be inferred from the payload:

A pagador.ispb identifying Bacen (99999) short-circuits FIRST, ahead of any indirect matching, so it never reaches a settlement position either.
A recebedor.ispb equal to this participant’s OWN ISPB is always resolved against this participant’s own customer records, never against the indirect registry.
While this tenant’s indirect-participants feature is switched OFF, recebedor.ispb is not matched against the registry at all and every credit is resolved against this participant’s own customer records — so a credit addressed to a registered institution is answered 404 PIX-0115 rather than posted to its @pi_{ispb}. Register the institution AND enable the feature before pointing credits at it.

A credit that CANNOT be registered is therefore answered with an HTTP error, never with a 200. Each carries a distinct code in the problem body’s code member:

404 PIX-0115 - the receiving account named by the credit was not found here. Check recebedor.nrAgencia/recebedor.nrConta, or recebedor.cpfCnpj when no account coordinates are sent.
404 PIX-0119 - recebedor.ispb is neither this participant’s own ISPB nor an ACTIVE indirect participant registered in this tenant. It covers both a receiver with no registration at all and one whose registration is not ACTIVE (suspended, closed, or a legacy row that never finished being set up); the two are deliberately not distinguished on the wire, because neither is something the sender can act on differently.
409 PIX-0116 - recebedor.cpfCnpj names more than one account here, so the destination is undeterminable. Address the credit to specific account coordinates.
409 PIX-0117 - the account addressed by recebedor.nrAgencia/recebedor.nrConta belongs to a different holder than recebedor.cpfCnpj names.
409 PIX-0118 - the addressed account exists here but is not set up to receive credits.
409 PIX-0029 - this end-to-end id was already registered as a credit here. The redelivery posted nothing; the original credit stands.
500 PIX-0120 - a provisioning fault at this participant, not a problem with the request. The credit is safe to redeliver once it is corrected.

WHICH OF THOSE AN INDIRECT CREDIT CAN ACTUALLY HIT is a shorter list, because its destination comes from the registry rather than from a customer lookup. PIX-0119 is the one: it is what a receiver ISPB with no ACTIVE registration answers. PIX-0115, PIX-0116, PIX-0117, PIX-0118 and PIX-0120 are all decided by the own-customer lookup and are unreachable once recebedor.ispb resolves to an ACTIVE registration — so seeing any of them means the credit was NOT treated as an indirect one. PIX-0029 behaves identically on both paths. A registry read that fails is a 500 like any other dependency failure: nothing is registered, and the credit is safe to redeliver.

One outcome acknowledges 200 WITHOUT posting a credit: a pagador.ispb identifying Bacen (99999), which this participant nulls by design. Its response carries the acknowledgement echo (idReqSistemaCliente, idReqJdPi, endToEndIdOriginal, endToEndIdDevolucao) and no idCreditoSgct.

Malformed payloads are rejected with 400 at the edge, before any resolution runs: 400 PIX-0061 for a body that fails schema validation, and 400 PIX-0061 for a missing endToEndId, a valor that is not a positive finite amount, or a malformed CPF/CNPJ or ISPB on either participant block.

POST

webhooks

cash-ins

Process an inbound JDPI cash-in

curl --request POST \
  --url https://api.example.com/v1/webhooks/cash-ins \
  --header 'Authorization: Bearer <token>' \
  --header 'Chave-Idempotencia: <chave-idempotencia>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dtHrOp": "2026-06-20T10:00:00Z",
  "endToEndId": "E2E-1",
  "idReqJdPi": "JDPI-1",
  "pagador": {
    "cpfCnpj": "11144477735",
    "ispb": "12345678",
    "nome": "Jane Doe",
    "nrConta": "1234567",
    "nrAgencia": "0001",
    "tpConta": 0,
    "tpPessoa": 0
  },
  "recebedor": {
    "cpfCnpj": "11144477735",
    "ispb": "12345678",
    "nrConta": "1234567",
    "nrAgencia": "0001",
    "tpConta": 0,
    "tpPessoa": 0
  },
  "tpIniciacao": 0,
  "valor": 100.5,
  "chave": "recipient@bank.com",
  "cnpjIniciadorPagamento": "11144477735",
  "dtContabil": "2026-06-20",
  "dtHrLiquidacao": "2026-06-20T10:00:01Z",
  "finalidade": 0,
  "idConciliacaoRecebedor": "CONC-1",
  "infEntreClientes": "note",
  "ispbPss": "12345678",
  "modalidadeAgente": 0,
  "prioridadePagamento": 0,
  "tpPrioridadePagamento": 0,
  "vlrDetalhe": [
    {
      "tipo": 0,
      "vlrTarifaDinheiroCompra": 0
    }
  ]
}
'

package main

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

func main() {

	url := "https://api.example.com/v1/webhooks/cash-ins"

	payload := strings.NewReader("{\n  \"dtHrOp\": \"2026-06-20T10:00:00Z\",\n  \"endToEndId\": \"E2E-1\",\n  \"idReqJdPi\": \"JDPI-1\",\n  \"pagador\": {\n    \"cpfCnpj\": \"11144477735\",\n    \"ispb\": \"12345678\",\n    \"nome\": \"Jane Doe\",\n    \"nrConta\": \"1234567\",\n    \"nrAgencia\": \"0001\",\n    \"tpConta\": 0,\n    \"tpPessoa\": 0\n  },\n  \"recebedor\": {\n    \"cpfCnpj\": \"11144477735\",\n    \"ispb\": \"12345678\",\n    \"nrConta\": \"1234567\",\n    \"nrAgencia\": \"0001\",\n    \"tpConta\": 0,\n    \"tpPessoa\": 0\n  },\n  \"tpIniciacao\": 0,\n  \"valor\": 100.5,\n  \"chave\": \"recipient@bank.com\",\n  \"cnpjIniciadorPagamento\": \"11144477735\",\n  \"dtContabil\": \"2026-06-20\",\n  \"dtHrLiquidacao\": \"2026-06-20T10:00:01Z\",\n  \"finalidade\": 0,\n  \"idConciliacaoRecebedor\": \"CONC-1\",\n  \"infEntreClientes\": \"note\",\n  \"ispbPss\": \"12345678\",\n  \"modalidadeAgente\": 0,\n  \"prioridadePagamento\": 0,\n  \"tpPrioridadePagamento\": 0,\n  \"vlrDetalhe\": [\n    {\n      \"tipo\": 0,\n      \"vlrTarifaDinheiroCompra\": 0\n    }\n  ]\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({
    dtHrOp: '2026-06-20T10:00:00Z',
    endToEndId: 'E2E-1',
    idReqJdPi: 'JDPI-1',
    pagador: {
      cpfCnpj: '11144477735',
      ispb: '12345678',
      nome: 'Jane Doe',
      nrConta: '1234567',
      nrAgencia: '0001',
      tpConta: 0,
      tpPessoa: 0
    },
    recebedor: {
      cpfCnpj: '11144477735',
      ispb: '12345678',
      nrConta: '1234567',
      nrAgencia: '0001',
      tpConta: 0,
      tpPessoa: 0
    },
    tpIniciacao: 0,
    valor: 100.5,
    chave: 'recipient@bank.com',
    cnpjIniciadorPagamento: '11144477735',
    dtContabil: '2026-06-20',
    dtHrLiquidacao: '2026-06-20T10:00:01Z',
    finalidade: 0,
    idConciliacaoRecebedor: 'CONC-1',
    infEntreClientes: 'note',
    ispbPss: '12345678',
    modalidadeAgente: 0,
    prioridadePagamento: 0,
    tpPrioridadePagamento: 0,
    vlrDetalhe: [{tipo: 0, vlrTarifaDinheiroCompra: 0}]
  })
};

fetch('https://api.example.com/v1/webhooks/cash-ins', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/webhooks/cash-ins"

payload = {
    "dtHrOp": "2026-06-20T10:00:00Z",
    "endToEndId": "E2E-1",
    "idReqJdPi": "JDPI-1",
    "pagador": {
        "cpfCnpj": "11144477735",
        "ispb": "12345678",
        "nome": "Jane Doe",
        "nrConta": "1234567",
        "nrAgencia": "0001",
        "tpConta": 0,
        "tpPessoa": 0
    },
    "recebedor": {
        "cpfCnpj": "11144477735",
        "ispb": "12345678",
        "nrConta": "1234567",
        "nrAgencia": "0001",
        "tpConta": 0,
        "tpPessoa": 0
    },
    "tpIniciacao": 0,
    "valor": 100.5,
    "chave": "recipient@bank.com",
    "cnpjIniciadorPagamento": "11144477735",
    "dtContabil": "2026-06-20",
    "dtHrLiquidacao": "2026-06-20T10:00:01Z",
    "finalidade": 0,
    "idConciliacaoRecebedor": "CONC-1",
    "infEntreClientes": "note",
    "ispbPss": "12345678",
    "modalidadeAgente": 0,
    "prioridadePagamento": 0,
    "tpPrioridadePagamento": 0,
    "vlrDetalhe": [
        {
            "tipo": 0,
            "vlrTarifaDinheiroCompra": 0
        }
    ]
}
headers = {
    "Chave-Idempotencia": "<chave-idempotencia>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "dtHrCreditoSgct": "2026-06-20T10:00:01Z",
  "dtHrReqJdPi": "2026-06-20T10:00:00Z",
  "endToEndIdDevolucao": "E2E-1",
  "endToEndIdOriginal": "E2E-1",
  "idCreditoSgct": "SGCT-1",
  "idReqJdPi": "JDPI-1",
  "idReqSistemaCliente": "JDPI-1"
}

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

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

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Headers

Chave-Idempotencia

string

required

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

Example:

"E0435879820200123221500000000001"

Body

application/json

dtHrOp

string

required

Operation timestamp (ISO-8601).

Example:

"2026-06-20T10:00:00Z"

endToEndId

string

required

SPI end-to-end id (idempotency + dedup key).

Example:

"E2E-1"

idReqJdPi

string

required

JDPI request id (becomes the local row id when a UUID).

Example:

"JDPI-1"

pagador

object

required

The payer participant block.

Show child attributes

recebedor

object

required

The receiver participant block (the credit account source).

Show child attributes

tpIniciacao

integer<int64>

required

Payment initiation mechanism (section 9.3.2): 0 manual, 1 chave, 2 QR Code estatico, 3 QR Code dinamico, 6 ITP, 8 Pix Automatico, 9/10 Pix por aproximacao. Both QR values (2 and 3) book the credit on the QR route pair; every other value books on the key route pair.

Example:

0

valor

number<double>

required

Amount in reais (a JSON number).

Example:

100.5

chave

string

The PIX key (present for key-initiated cash-ins).

Example:

"recipient@bank.com"

cnpjIniciadorPagamento

string

Payment initiator CNPJ (a v5.5.0 string).

Example:

"11144477735"

dtContabil

string

Accounting date (optional).

Example:

"2026-06-20"

dtHrLiquidacao

string

Settlement timestamp (optional).

Example:

"2026-06-20T10:00:01Z"

finalidade

integer<int64>

Finality (eFinality).

Example:

0

idConciliacaoRecebedor

string

Recipient conciliation id (stamped on the row + the 24h marker).

Example:

"CONC-1"

infEntreClientes

string

Free-text inter-client info.

Example:

"note"

ispbPss

string

Saque/troco PSS participant ISPB (a v5.5.0 string).

Example:

"12345678"

modalidadeAgente

integer<int64>

Agent modality (eModalityAgent).

Example:

0

prioridadePagamento

integer<int64>

Payment priority (ePaymentPriority).

Example:

0

tpPrioridadePagamento

integer<int64>

Payment priority type.

Example:

0

vlrDetalhe

object[] | null

Optional value-detail entries.

Show child attributes

Response

dtHrCreditoSgct

string

SGCT credit timestamp (ISO-8601), on a credited result.

Example:

"2026-06-20T10:00:01Z"

dtHrReqJdPi

string

Request timestamp (ISO-8601).

Example:

"2026-06-20T10:00:00Z"

endToEndIdDevolucao

string

Echoed return end-to-end id.

Example:

"E2E-1"

endToEndIdOriginal

string

Echoed original end-to-end id.

Example:

"E2E-1"

idCreditoSgct

string

SGCT credit lançamento id (GUID), on a credited result.

Example:

"SGCT-1"

idReqJdPi

string

Echoed JDPI request id.

Example:

"JDPI-1"

idReqSistemaCliente

string

Echoed client-system request id.

Example:

"JDPI-1"

Key DICT API

Key Claims API

Banks API

Indirect participants API

Transactions API

Transaction Limits API

QR Codes API

Refunds API

Pix Automático · Authorization requests

Pix Automático · Authorization management

Pix Automático · Composite QR codes

Pix Automático · Authorization events

Pix Automático · Schedule events

Pix Automático · Schedules and payment instructions

Pix Automático · Settlement

MED · Refunds

MED · Fraud markers

MED · Infractions

MED · Value recovery

Webhooks API

Error handling

Events

Process an inbound JDPI cash-in

Authorizations

Headers

Body

Response