Create a single Pix Request Schedule

​

Creates a new single Pix payment schedule. For recurring schedules use /pix-schedules/recurrences.

Headers
  • Idempotency-Key
    Type: string
    required
Body·
required
application/json

Request payload for creating a single (one-shot) scheduled outgoing Pix payment. Recurrence-related fields live on /pix-schedules/recurrences.

  • amount
    Type: number
    required

    Transaction amount.

  • initiationMethod
    Type: string enum
    required

    Payment initiation method.

    values
    • APDN
    • APES
    • AUTO
    • DICT
    • INIC
    • MANU
    • QRDN
    • QRES
  • receiver
    Type: object ·
    required

    Receiver/beneficiary information for the Pix transaction

  • scheduledDate
    Type: string Format: date
    required

    Date when this schedule will be executed (yyyy-MM-dd).

  • sender
    Type: object ·
    required

    Payer/sender information for the Pix transaction

  • description
    Type: string

    Payment description or message to the receiver.

  • endToEndId
    Type: string

    End-to-end identifier.

  • metadata
    Type: array object[] ·

    Optional list of custom key/value pairs.

    Key/value metadata item

  • priority
    Type: string enum

    Payment priority for the outgoing Pix request (SPI band: HIGH → HIGH, NORM → NORM)

    values
    • HIGH
    • NORM
  • purpose
    Type: string enum

    Purpose of the outgoing Pix payment (SPI purpose codes)

    values
    • GSCB
    • IPAY
    • IPRT
    • OTHR
    • REFU
  • reconciliationId
    Type: string

    Client reconciliation identifier for reporting and matching.

  • source
    Type: string enum

    Origin. Defaults to MANUAL.

    values
    • MANUAL
    • PIX_AUTOMATIC
Responses
  • application/json
Request Example for post/api/v1/pix-schedules
curl http://localhost:8080/api/v1/pix-schedules \
  --request POST \
  --header 'Idempotency-Key: ' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "initiationMethod": "DICT",
  "amount": 123.98,
  "sender": {
    "name": "",
    "document": {
      "type": "CPF",
      "value": ""
    },
    "account": {
      "ispb": "",
      "type": "CACC",
      "branch": "",
      "number": ""
    }
  },
  "receiver": {
    "key": "",
    "name": "",
    "document": {
      "type": "CPF",
      "value": ""
    },
    "account": {
      "ispb": "",
      "type": "CACC",
      "branch": "",
      "number": ""
    }
  },
  "description": "",
  "reconciliationId": "REC-20260408-001",
  "priority": "HIGH",
  "metadata": [
    {
      "key": "",
      "value": ""
    }
  ],
  "purpose": "IPAY",
  "source": "MANUAL",
  "endToEndId": "E1234567820260316143000ABC12345",
  "scheduledDate": "2026-04-30"
}'

{
  "id": "string",
  "status": "ACTIVE",
  "createdAt": "string",
  "updatedAt": "string",
  "initiationMethod": "APDN",
  "priority": "HIGH",
  "priorityType": "PAGAGD",
  "purpose": "GSCB",
  "amount": 1,
  "userDescription": "string",
  "sender": {
    "name": "string",
    "document": {
      "type": "CPF",
      "value": "string"
    },
    "account": {
      "ispb": "string",
      "type": "CACC",
      "branch": "string",
      "number": "string"
    }
  },
  "receiver": {
    "key": "string",
    "name": "string",
    "document": {
      "type": "CPF",
      "value": "string"
    },
    "account": {
      "ispb": "string",
      "type": "CACC",
      "branch": "string",
      "number": "string"
    }
  },
  "source": "MANUAL",
  "scheduledDate": "2026-07-29",
  "endToEndId": "string",
  "msgId": "string",
  "settledAt": "2026-07-29T19:28:46.547Z",
  "recurrenceId": "string",
  "installment": 1,
  "totalInstallments": 1,
  "reconciliationId": "REC-20260408-001",
  "totalAmount": 1
}

Schedule created and accepted