Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Scheduled transfers V2

Schedule transfer(s) V2

Schedule a Pix-out transfer or Pix-out recurring transfers.

This endpoint gives you more scheduling options than the version 1 Schedule transfer endpoint. These include additional options (scheduler_details object) for recurring transfers.

As with the Pix-out transfer endpoint, if you are using a key or QR Code, you need to call <a href="https://developers.pismo.io/pismo-docs/reference/post-v2-pix-keys-validate">Validate DICT key</a> or <a href="https://developers.pismo.io/pismo-docs/reference/post-qr-code">Get and validate QR Code</a> before calling this endpoint. You need to enter the end_to_end_id returned from those calls here. If you are not using a key or QR Code, this endpoint generates and returns an end_to_end_id value you can use in other endpoints.

The end_to_end_id field is a Brazil Central Bank (BCB) requirement to track Pix transactions. Basically, there are two steps to a Pix transaction: 1. Initialize a transaction and 2. Confirm a transaction. The end_to_end_id is sent to the BCB in both steps in order to identify all transaction information.

This endpoint directly generates an Instant pay scheduler status changed event.

To create a recurring payment, set type = RECURRING and pass a value for cycle. This property has 2 attributes and should be set as shown in the sample table below:

cycle.typecycle.countNew transaction created every:
DAILY55 days
WEEKLY22 weeks
MONTHLY11 month
MONTHLY22 months
YEARLY11 year

Notes

  • WEEKLY sets the start_date weekday. For a scheduler with start_date = Thursday, the next transaction is always on a Thursday.

  • MONTHLY / YEARLY sets the start_date day. For a scheduler with start_date = 2024-10-12, the next transaction is always created on day 12 of each cycle count. Now, for days 29, 30 and 31, the scheduler uses the previous month's last day when that day doesn't exist in the current month. For example, considering a scheduler starting at 2024-01-30, the next transaction is created on 2024-02-29.

Events

  • When the transfer takes place, <a href="https://developers.pismo.io/events/docs/pix-pix-out-1">Pix-out notification received</a> and <a href="https://developers.pismo.io/events/docs/pix-financial-reconciliation-1">Pix reconciliation notification received </a> events are generated.

  • Also, when the transfer takes place, a <a href="https://developers.pismo.io/events/docs/pix-pix-in-1">Pix-in notification received</a> event is generated when the funds are deposited in the payee's account, which can be a Pismo account or an external account.

  • For all events, the status or result field indicates operation success or failure.

For more information, refer to the Pix instant payments guide.

Note: This endpoint takes an account token - an access token encoded with a Pismo accound ID.

post/pix/v2/pix/out/scheduler

Headers

Authorizationstring required
Example:Bearer eyJhbGci...IUzUx

Account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a <b>401 Unauthorized</b> message.

Idempotency-Keystring required

A unique ID to ensure the operation remains idempotent, allowing for operation repitition without causing unintended effects or duplication. An idempotent operation is one that can be applied multiple times, yet the outcome remains the same. it ensures that network errors, retries, or failures can occur without introducing inconsistencies.

x-cidstring

The Correlation ID UUID field links related API requests and events. The x-cid can help the Pismo engineering team track everything related to a call. If not passed, this field is automatically generated.

Request body

amountnumber double required

Fee amount.

initiation_type'MANUAL' | 'DICT' | 'STATIC_QRCODE' | 'DYNAMIC_QRCODE' required

Initiation type:

MANUAL - Manually initiated. Key is not used - bank account, bank code, document number, and branch are used for identification.

DICT - Diretorio de Identificadores de Contas de Transação (Transaction accounts ID directory). Pix/DICT key is used for identification.

DYNAMIC_QRCODE - The amount and other details for a dynamic code are included automatically.

ispbstring required

<a href="https://bank.codes/numero-do-banco/bank/banco-central-do-brasil/" target="_blank">ISPB (Identifcador do Sistema de Pagamento Brazil)</a> - the Brazilian Payment System ID, an 8-digit value.

is_device_registeredboolean

Is device registered to do a Pix-out transfer? Default is true.

end_to_end_idstring

This field is a Brazil Central Bank (BCB) requirement to track all steps of Pix transactions. Basically, there are two steps to a Pix transaction: 1. Initialize a transaction 2. Confirm a transaction The end_to_end_id is sent to the BCB in both steps in order to identify all transaction information.

remittance_informationstring

Remittance information. Information from payee when transaction is a static QR Code.

transaction_identificationstring

Transaction ID. REQUIRED if initiation_type = DYNAMIC_QR_CODE. Cannot be passed if MANUAL or DICT. If STATIC_QR_CODE contains transaction_identification, it is REQUIRED to pass it.

Example request

{
  "amount": 215,
  "bank_account": {
    "account_type": "TRAN",
    "branch": "011",
    "account_number": "98765432"
  },
  "initiation_type": "DICT",
  "ispb": "60701190",
  "is_device_registered": true,
  "payee": {
    "account_number": "98765432",
    "account_type": "TRAN",
    "bank": "237",
    "branch": "011",
    "beneficiary_id": "97c96d96-9b87-404b-88e5-287f2b0e6e0a",
    "document_number": "7777888hh",
    "name": "Paul Bearer",
    "key": "email@email.com",
    "type": "NATURAL_PERSON"
  },
  "qr_code_additional_information": [
    {
      "name": "Discount",
      "value": "Paying until the 5th, there will be a 10% discount"
    }
  ],
  "scheduler_details": {
    "type": "RECURRING",
    "description": "Pay at end of month",
    "start_scheduler_date": "2024-06-10",
    "end_scheduler_date": "2024-06-10",
    "cycle": {
      "type": "MONTHLY",
      "count": 1
    }
  },
  "end_to_end_id": "E3030629420200808195101608910248",
  "transaction_identification": "1a84daf6-a61b-4aba-919a-a9943db7102e",
  "flex_controls": {
    "pix_limit_id": "279207b0-d553-424e-a454-8d704cca3702"
  },
  "taxes": {
    "tax_identifier": "IS0435879820240605bcdb1fhn43a",
    "records": [
      {
        "tax_type": "IBS",
        "amount": 1050.44
      }
    ]
  }
}

Response

Created

scheduler_idstring

Scheduled PIX transaction ID

Example response

{
  "scheduler_id": "7b29a055-00e1-41e5-b880-aebe517b3bf6"
}