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

Register an inbound PIX Automatico payment instruction

Registers an inbound scheduled payment instruction delivered by JDPI to the PSP Pagador (section 5.3.3, the plugin is the server). This is inbound genesis: it creates the payer-side schedule row (Requested on an accepted registration, Rejected on a rejected one) and returns the local SGCT id. A re-delivered instruction resolves to a 409 conflict.

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

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Cuerpo

application/json

dtVencimento

string

requerido

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

Ejemplo:

"2024-09-26"

endToEndId

string

requerido

Unique payment-instruction id (32-char).

Ejemplo:

"E00038166202409201500y6j6mt9l0pi"

finalidadeAgendamento

integer<int64>

requerido

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

Ejemplo:

0

idConciliacaoRecebedor

string

requerido

Receiver conciliation id (35-char).

Ejemplo:

"JDPI2024092000000000000000000000001"

idRecorrencia

string

requerido

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

Ejemplo:

"RR0435879820240919njua7shf40o"

pagador

object

requerido

The instruction pagador.

Show child attributes

recebedor

object

requerido

The instruction recebedor.

Show child attributes

stAgendamento

integer<int64>

requerido

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

Ejemplo:

0

codigoErro

string

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

Ejemplo:

""

descCodigoErro

string

JDPI error description (1000-char).

Ejemplo:

""

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).

Ejemplo:

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

infEntreClientes

string

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

Ejemplo:

"Cobranca da Enel"

valor

number<double>

Recurring payment amount in reais (a JSON number).

Ejemplo:

550

Respuesta

dtHrSgct

string

requerido

SGCT registration timestamp (UTC).

Ejemplo:

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

idSgct

string

requerido

Local SGCT schedule id (36-char GUID).

Ejemplo:

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

Asientos

Reclamaciones

Bancos

Indirectos

Transacciones

Límites

Códigos QR

Devoluciones

PIX Automatico

MED Infracciones

MED Devoluciones

MED Marcadores de Fraude

MED Recuperaciones

MED Crédito Entrante

Webhooks

Manejo de errores

Eventos

Register an inbound PIX Automatico payment instruction

Autorizaciones

Cuerpo

Respuesta