Request a PIX Automatico schedule send

curl --request POST \
  --url https://api.example.com/v1/pix-automatico/schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dueDate": "2024-09-24",
  "endToEndId": "E00038166202409171500y6j6mt9l0pi",
  "idRecorrencia": "RR0435879820240605njua7shf40o",
  "payer": {
    "cpfCnpj": "04623217035",
    "ispb": "00038166",
    "personType": 0
  },
  "purpose": 0,
  "recipient": {
    "account": "0007654321",
    "accountType": 0,
    "cnpj": "61695227000193",
    "ispb": "04358798",
    "agency": "0001"
  },
  "reconciliationId": "JDPI2024091700000000000000000000001",
  "amount": 55000,
  "infoBetweenClients": "",
  "recipientReceivedAt": "2024-09-17T10:25:49.025Z"
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"dueDate\": \"2024-09-24\",\n  \"endToEndId\": \"E00038166202409171500y6j6mt9l0pi\",\n  \"idRecorrencia\": \"RR0435879820240605njua7shf40o\",\n  \"payer\": {\n    \"cpfCnpj\": \"04623217035\",\n    \"ispb\": \"00038166\",\n    \"personType\": 0\n  },\n  \"purpose\": 0,\n  \"recipient\": {\n    \"account\": \"0007654321\",\n    \"accountType\": 0,\n    \"cnpj\": \"61695227000193\",\n    \"ispb\": \"04358798\",\n    \"agency\": \"0001\"\n  },\n  \"reconciliationId\": \"JDPI2024091700000000000000000000001\",\n  \"amount\": 55000,\n  \"infoBetweenClients\": \"\",\n  \"recipientReceivedAt\": \"2024-09-17T10:25:49.025Z\"\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({
    dueDate: '2024-09-24',
    endToEndId: 'E00038166202409171500y6j6mt9l0pi',
    idRecorrencia: 'RR0435879820240605njua7shf40o',
    payer: {cpfCnpj: '04623217035', ispb: '00038166', personType: 0},
    purpose: 0,
    recipient: {
      account: '0007654321',
      accountType: 0,
      cnpj: '61695227000193',
      ispb: '04358798',
      agency: '0001'
    },
    reconciliationId: 'JDPI2024091700000000000000000000001',
    amount: 55000,
    infoBetweenClients: '',
    recipientReceivedAt: '2024-09-17T10:25:49.025Z'
  })
};

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

payload = {
    "dueDate": "2024-09-24",
    "endToEndId": "E00038166202409171500y6j6mt9l0pi",
    "idRecorrencia": "RR0435879820240605njua7shf40o",
    "payer": {
        "cpfCnpj": "04623217035",
        "ispb": "00038166",
        "personType": 0
    },
    "purpose": 0,
    "recipient": {
        "account": "0007654321",
        "accountType": 0,
        "cnpj": "61695227000193",
        "ispb": "04358798",
        "agency": "0001"
    },
    "reconciliationId": "JDPI2024091700000000000000000000001",
    "amount": 55000,
    "infoBetweenClients": "",
    "recipientReceivedAt": "2024-09-17T10:25:49.025Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "endToEndId": "E00038166202409171500y6j6mt9l0pi",
  "idRecorrencia": "RR0435879820240605njua7shf40o",
  "reconciliationId": "JDPI2024091700000000000000000000001",
  "requestedAt": "2024-09-17T10:10:05Z",
  "status": "Requested"
}

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

Request a PIX Automatico schedule send

curl --request POST \
  --url https://api.example.com/v1/pix-automatico/schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dueDate": "2024-09-24",
  "endToEndId": "E00038166202409171500y6j6mt9l0pi",
  "idRecorrencia": "RR0435879820240605njua7shf40o",
  "payer": {
    "cpfCnpj": "04623217035",
    "ispb": "00038166",
    "personType": 0
  },
  "purpose": 0,
  "recipient": {
    "account": "0007654321",
    "accountType": 0,
    "cnpj": "61695227000193",
    "ispb": "04358798",
    "agency": "0001"
  },
  "reconciliationId": "JDPI2024091700000000000000000000001",
  "amount": 55000,
  "infoBetweenClients": "",
  "recipientReceivedAt": "2024-09-17T10:25:49.025Z"
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"dueDate\": \"2024-09-24\",\n  \"endToEndId\": \"E00038166202409171500y6j6mt9l0pi\",\n  \"idRecorrencia\": \"RR0435879820240605njua7shf40o\",\n  \"payer\": {\n    \"cpfCnpj\": \"04623217035\",\n    \"ispb\": \"00038166\",\n    \"personType\": 0\n  },\n  \"purpose\": 0,\n  \"recipient\": {\n    \"account\": \"0007654321\",\n    \"accountType\": 0,\n    \"cnpj\": \"61695227000193\",\n    \"ispb\": \"04358798\",\n    \"agency\": \"0001\"\n  },\n  \"reconciliationId\": \"JDPI2024091700000000000000000000001\",\n  \"amount\": 55000,\n  \"infoBetweenClients\": \"\",\n  \"recipientReceivedAt\": \"2024-09-17T10:25:49.025Z\"\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({
    dueDate: '2024-09-24',
    endToEndId: 'E00038166202409171500y6j6mt9l0pi',
    idRecorrencia: 'RR0435879820240605njua7shf40o',
    payer: {cpfCnpj: '04623217035', ispb: '00038166', personType: 0},
    purpose: 0,
    recipient: {
      account: '0007654321',
      accountType: 0,
      cnpj: '61695227000193',
      ispb: '04358798',
      agency: '0001'
    },
    reconciliationId: 'JDPI2024091700000000000000000000001',
    amount: 55000,
    infoBetweenClients: '',
    recipientReceivedAt: '2024-09-17T10:25:49.025Z'
  })
};

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

payload = {
    "dueDate": "2024-09-24",
    "endToEndId": "E00038166202409171500y6j6mt9l0pi",
    "idRecorrencia": "RR0435879820240605njua7shf40o",
    "payer": {
        "cpfCnpj": "04623217035",
        "ispb": "00038166",
        "personType": 0
    },
    "purpose": 0,
    "recipient": {
        "account": "0007654321",
        "accountType": 0,
        "cnpj": "61695227000193",
        "ispb": "04358798",
        "agency": "0001"
    },
    "reconciliationId": "JDPI2024091700000000000000000000001",
    "amount": 55000,
    "infoBetweenClients": "",
    "recipientReceivedAt": "2024-09-17T10:25:49.025Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "endToEndId": "E00038166202409171500y6j6mt9l0pi",
  "idRecorrencia": "RR0435879820240605njua7shf40o",
  "reconciliationId": "JDPI2024091700000000000000000000001",
  "requestedAt": "2024-09-17T10:10:05Z",
  "status": "Requested"
}

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

dueDate

string

required

Due date (dtVencimento; aaaa-mm-dd).

Example:

"2024-09-24"

endToEndId

string

required

Unique payment-transaction id (32-char natural key).

Example:

"E00038166202409171500y6j6mt9l0pi"

idRecorrencia

string

required

Recurrence id linking the authorization (29-char, RR...).

Example:

"RR0435879820240605njua7shf40o"

payer

object

required

The scheduled pagador (account being charged).

Show child attributes

purpose

integer<int64>

required

finalidadeAgendamento (0=first, 1=post-due retry, 2=settlement-error resend).

Example:

0

recipient

object

required

The scheduled recebedor (account receiving the charge).

Show child attributes

reconciliationId

string

required

Receiver conciliation id (idConciliacaoRecebedor; 26..35-char).

Example:

"JDPI2024091700000000000000000000001"

amount

integer<int64>

Scheduled amount in centavos (valor).

Example:

55000

debtor

object

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

Show child attributes

infoBetweenClients

string

Free-text receiver-to-payer info (infEntreClientes).

Example:

""

recipientReceivedAt

string

Recipient PSP reception timestamp (dtHrRecepcaoPspRecebedor, UTC; required when purpose=0).

Example:

"2024-09-17T10:25:49.025Z"

Response

Accepted

endToEndId

string

required

The payment-transaction id (echoed).

Example:

"E00038166202409171500y6j6mt9l0pi"

idRecorrencia

string

required

The recurrence id (echoed).

Example:

"RR0435879820240605njua7shf40o"

reconciliationId

string

required

The receiver conciliation id (echoed).

Example:

"JDPI2024091700000000000000000000001"

requestedAt

string

required

JDPI request timestamp (dtHrReqJdPi, UTC).

Example:

"2024-09-17T10:10:05Z"

status

string

required

The resulting local schedule status.

Example:

"Requested"

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

Request a PIX Automatico schedule send

Authorizations

Body

Response