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 Validate DICT key or Get and validate QR Code 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, Pix out notification received and Pix reconciliation notification received events are generated.

Also, when the transfer takes place, a Pix-in notification received 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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request Body

integer
required

Pismo account ID.

number
required

Amount to be transferred.

bank_account
object
required
string
enum
required
length ≤ 20

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.

Allowed:
string
required
length ≤ 8

ISPB (Identifcador do Sistema de Pagamento Brazil) - the Brazilian Payment System ID, an 8-digit value.

payee
object
required
string
required

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

string
length ≤ 140

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

string

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.

Headers
string
required

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

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

Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json