Register an inbound PIX Automatico payment instruction

curl --request POST \
  --url https://api.example.com/v1/pix-automatico/schedules/inbound/register \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dtVencimento": "2024-09-26",
  "endToEndId": "E00038166202409201500y6j6mt9l0pi",
  "finalidadeAgendamento": 0,
  "idConciliacaoRecebedor": "JDPI2024092000000000000000000000001",
  "idRecorrencia": "RR0435879820240919njua7shf40o",
  "pagador": {
    "cpfCnpj": "11111111111",
    "ispb": "99999004",
    "tpPessoa": 0
  },
  "recebedor": {
    "cnpj": "61695227000193",
    "ispb": "04358798",
    "nome": "Enel",
    "nrConta": "12345678",
    "tpConta": 0,
    "nrAgencia": "1234"
  },
  "stAgendamento": 0,
  "codigoErro": "",
  "descCodigoErro": "",
  "dtHrRecepcaoPspRecebedor": "2024-09-20T09:25:49.025Z",
  "infEntreClientes": "Cobranca da Enel",
  "valor": 550
}
'

package main

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

func main() {

	url := "https://api.example.com/v1/pix-automatico/schedules/inbound/register"

	payload := strings.NewReader("{\n  \"dtVencimento\": \"2024-09-26\",\n  \"endToEndId\": \"E00038166202409201500y6j6mt9l0pi\",\n  \"finalidadeAgendamento\": 0,\n  \"idConciliacaoRecebedor\": \"JDPI2024092000000000000000000000001\",\n  \"idRecorrencia\": \"RR0435879820240919njua7shf40o\",\n  \"pagador\": {\n    \"cpfCnpj\": \"11111111111\",\n    \"ispb\": \"99999004\",\n    \"tpPessoa\": 0\n  },\n  \"recebedor\": {\n    \"cnpj\": \"61695227000193\",\n    \"ispb\": \"04358798\",\n    \"nome\": \"Enel\",\n    \"nrConta\": \"12345678\",\n    \"tpConta\": 0,\n    \"nrAgencia\": \"1234\"\n  },\n  \"stAgendamento\": 0,\n  \"codigoErro\": \"\",\n  \"descCodigoErro\": \"\",\n  \"dtHrRecepcaoPspRecebedor\": \"2024-09-20T09:25:49.025Z\",\n  \"infEntreClientes\": \"Cobranca da Enel\",\n  \"valor\": 550\n}")

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

	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: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    dtVencimento: '2024-09-26',
    endToEndId: 'E00038166202409201500y6j6mt9l0pi',
    finalidadeAgendamento: 0,
    idConciliacaoRecebedor: 'JDPI2024092000000000000000000000001',
    idRecorrencia: 'RR0435879820240919njua7shf40o',
    pagador: {cpfCnpj: '11111111111', ispb: '99999004', tpPessoa: 0},
    recebedor: {
      cnpj: '61695227000193',
      ispb: '04358798',
      nome: 'Enel',
      nrConta: '12345678',
      tpConta: 0,
      nrAgencia: '1234'
    },
    stAgendamento: 0,
    codigoErro: '',
    descCodigoErro: '',
    dtHrRecepcaoPspRecebedor: '2024-09-20T09:25:49.025Z',
    infEntreClientes: 'Cobranca da Enel',
    valor: 550
  })
};

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

payload = {
    "dtVencimento": "2024-09-26",
    "endToEndId": "E00038166202409201500y6j6mt9l0pi",
    "finalidadeAgendamento": 0,
    "idConciliacaoRecebedor": "JDPI2024092000000000000000000000001",
    "idRecorrencia": "RR0435879820240919njua7shf40o",
    "pagador": {
        "cpfCnpj": "11111111111",
        "ispb": "99999004",
        "tpPessoa": 0
    },
    "recebedor": {
        "cnpj": "61695227000193",
        "ispb": "04358798",
        "nome": "Enel",
        "nrConta": "12345678",
        "tpConta": 0,
        "nrAgencia": "1234"
    },
    "stAgendamento": 0,
    "codigoErro": "",
    "descCodigoErro": "",
    "dtHrRecepcaoPspRecebedor": "2024-09-20T09:25:49.025Z",
    "infEntreClientes": "Cobranca da Enel",
    "valor": 550
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "dtHrSgct": "2024-11-27T22:10:05.025Z",
  "idSgct": "69F963C6-7487-4363-9406-A1DE2A9636D4"
}

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

POST

pix-automatico

schedules

inbound

curl --request POST \
  --url https://api.example.com/v1/pix-automatico/schedules/inbound/register \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dtVencimento": "2024-09-26",
  "endToEndId": "E00038166202409201500y6j6mt9l0pi",
  "finalidadeAgendamento": 0,
  "idConciliacaoRecebedor": "JDPI2024092000000000000000000000001",
  "idRecorrencia": "RR0435879820240919njua7shf40o",
  "pagador": {
    "cpfCnpj": "11111111111",
    "ispb": "99999004",
    "tpPessoa": 0
  },
  "recebedor": {
    "cnpj": "61695227000193",
    "ispb": "04358798",
    "nome": "Enel",
    "nrConta": "12345678",
    "tpConta": 0,
    "nrAgencia": "1234"
  },
  "stAgendamento": 0,
  "codigoErro": "",
  "descCodigoErro": "",
  "dtHrRecepcaoPspRecebedor": "2024-09-20T09:25:49.025Z",
  "infEntreClientes": "Cobranca da Enel",
  "valor": 550
}
'

package main

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

func main() {

	url := "https://api.example.com/v1/pix-automatico/schedules/inbound/register"

	payload := strings.NewReader("{\n  \"dtVencimento\": \"2024-09-26\",\n  \"endToEndId\": \"E00038166202409201500y6j6mt9l0pi\",\n  \"finalidadeAgendamento\": 0,\n  \"idConciliacaoRecebedor\": \"JDPI2024092000000000000000000000001\",\n  \"idRecorrencia\": \"RR0435879820240919njua7shf40o\",\n  \"pagador\": {\n    \"cpfCnpj\": \"11111111111\",\n    \"ispb\": \"99999004\",\n    \"tpPessoa\": 0\n  },\n  \"recebedor\": {\n    \"cnpj\": \"61695227000193\",\n    \"ispb\": \"04358798\",\n    \"nome\": \"Enel\",\n    \"nrConta\": \"12345678\",\n    \"tpConta\": 0,\n    \"nrAgencia\": \"1234\"\n  },\n  \"stAgendamento\": 0,\n  \"codigoErro\": \"\",\n  \"descCodigoErro\": \"\",\n  \"dtHrRecepcaoPspRecebedor\": \"2024-09-20T09:25:49.025Z\",\n  \"infEntreClientes\": \"Cobranca da Enel\",\n  \"valor\": 550\n}")

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

	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: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    dtVencimento: '2024-09-26',
    endToEndId: 'E00038166202409201500y6j6mt9l0pi',
    finalidadeAgendamento: 0,
    idConciliacaoRecebedor: 'JDPI2024092000000000000000000000001',
    idRecorrencia: 'RR0435879820240919njua7shf40o',
    pagador: {cpfCnpj: '11111111111', ispb: '99999004', tpPessoa: 0},
    recebedor: {
      cnpj: '61695227000193',
      ispb: '04358798',
      nome: 'Enel',
      nrConta: '12345678',
      tpConta: 0,
      nrAgencia: '1234'
    },
    stAgendamento: 0,
    codigoErro: '',
    descCodigoErro: '',
    dtHrRecepcaoPspRecebedor: '2024-09-20T09:25:49.025Z',
    infEntreClientes: 'Cobranca da Enel',
    valor: 550
  })
};

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

payload = {
    "dtVencimento": "2024-09-26",
    "endToEndId": "E00038166202409201500y6j6mt9l0pi",
    "finalidadeAgendamento": 0,
    "idConciliacaoRecebedor": "JDPI2024092000000000000000000000001",
    "idRecorrencia": "RR0435879820240919njua7shf40o",
    "pagador": {
        "cpfCnpj": "11111111111",
        "ispb": "99999004",
        "tpPessoa": 0
    },
    "recebedor": {
        "cnpj": "61695227000193",
        "ispb": "04358798",
        "nome": "Enel",
        "nrConta": "12345678",
        "tpConta": 0,
        "nrAgencia": "1234"
    },
    "stAgendamento": 0,
    "codigoErro": "",
    "descCodigoErro": "",
    "dtHrRecepcaoPspRecebedor": "2024-09-20T09:25:49.025Z",
    "infEntreClientes": "Cobranca da Enel",
    "valor": 550
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "dtHrSgct": "2024-11-27T22:10:05.025Z",
  "idSgct": "69F963C6-7487-4363-9406-A1DE2A9636D4"
}

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

Body

application/json

dtVencimento

string

required

Recurring charge due date (aaaa-mm-dd).

Example:

"2024-09-26"

endToEndId

string

required

Unique payment-instruction id (32-char).

Example:

"E00038166202409201500y6j6mt9l0pi"

finalidadeAgendamento

integer<int64>

required

Schedule purpose (0=first, 1=post-due retry, 2=settlement resend).

Example:

0

idConciliacaoRecebedor

string

required

Receiver conciliation id (35-char).

Example:

"JDPI2024092000000000000000000000001"

idRecorrencia

string

required

Unique recurrence id (29-char, RR...).

Example:

"RR0435879820240919njua7shf40o"

pagador

object

required

The instruction pagador.

Show child attributes

recebedor

object

required

The instruction recebedor.

Show child attributes

stAgendamento

integer<int64>

required

Schedule status (0=Aceito, 1=Rejeitado).

Example:

0

codigoErro

string

JDPI error code (100-char; on a rejection).

Example:

""

descCodigoErro

string

JDPI error description (1000-char).

Example:

""

devedor

object

The devedor, sent only when it differs from the payer.

Show child attributes

dtHrRecepcaoPspRecebedor

string

PSP-receiver reception timestamp (UTC; required when finalidadeAgendamento=0).

Example:

"2024-09-20T09:25:49.025Z"

infEntreClientes

string

Free-text receiver-to-payer info (140-char).

Example:

"Cobranca da Enel"

valor

number<double>

Recurring payment amount in reais (a JSON number).

Example:

550

Response

dtHrSgct

string

required

SGCT registration timestamp (UTC).

Example:

"2024-11-27T22:10:05.025Z"

idSgct

string

required

Local SGCT schedule id (36-char GUID).

Example:

"69F963C6-7487-4363-9406-A1DE2A9636D4"

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

Register an inbound PIX Automatico payment instruction

Authorizations

Body

Response