Sign in

v1

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

Schedule transfer [deprecated]

This endpoint is DEPRECATED. It is recommended you call Schedule Transfer(s) V2 instead.

Schedule a Pix-out transfer for a future date.

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.

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, see the Pix instant payments guide.

post/pix/v1/pix/out/schedule

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.

Request body

account_idinteger required

Account ID

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.

schedule_datetimestring required

Date to schedule the process. RFC 3339 value, i.e., "2023-04-12T23:20:50.52Z".

remittance_informationstring

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

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.

Example request

{
  "account_id": 6912345,
  "amount": 215,
  "bank_account": {
    "account_number": "98765432",
    "account_type": "TRAN",
    "branch": "011"
  },
  "initiation_type": "DICT",
  "ispb": "60701190",
  "payee": {
    "account_number": "98765432",
    "account_type": "TRAN",
    "bank": "237",
    "branch": "011",
    "document_number": "7777888hh",
    "name": "Paul Bearer",
    "key": "45fe6866-21a5-4f6d-84c2-950a2a1df8e7",
    "beneficiary_id": "97c96d96-9b87-404b-88e5-287f2b0e6e0a"
  },
  "schedule_datetime": "2020-08-13T13:49:03.000Z",
  "end_to_end_id": "E3030629420200808195101608910248"
}

Response

Created

amountnumber double required

Fee amount.

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.

schedule_creation_datetimestring required

Scheduled transfer creation datetime. RFC 3339 value, i.e., "2023-04-12T23:20:50.52Z".

schedule_datetimestring required

Date to schedule the process. RFC 3339 value, i.e., "2023-04-12T23:20:50.52Z".

schedule_idstring required

Scheduled PIX transaction ID

status'SCHEDULED' | 'CANCELLED' | 'SETTLED' | 'FAILED' required

Scheduled transfer status.

Example response

{
  "amount": 215,
  "end_to_end_id": "E3030629420200808195101608910248",
  "payee": {
    "document_number": "7777888hh",
    "ispb": "60701190",
    "name": "Paul Bearer"
  },
  "payer": {
    "document_number": "7777888hh",
    "ispb": "60701190",
    "name": "Paul Bearer"
  },
  "schedule_creation_datetime": "2020-08-13T13:49:03.000Z",
  "schedule_datetime": "2020-08-13T13:49:03.000Z",
  "schedule_id": "7b29a055-00e1-41e5-b880-aebe517b3bf6",
  "status": "SCHEDULED"
}