v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Transfer

Perform cash-out

Perform an external transfer, using a provider to process the outgoing account resources. This endpoint generates the following events:

Transfer-out created - Cash-out event.
Financial transaction status updated - Cash out status change. Status becomes SETTLED after clearing and accounts have been credited and debited.
Integrated payments financial reconciliation- This event is generated after the transaction has been cleared and accounts debited or credited.

post/v1/transfers/cashout

Headers

Authorizationstring required

Account token. Getting an account token requires you call the Server login endpoint with an account ID. Tokens can expire quickly, which can result in an <b>Unauthorized</b> message. Enter this field under AUTHENTICATION.

Idempotency-keystring required

A UUID (without hyphens) to ensure the operation remains idempotent, allowing for operation repetition without causing unintended effects or duplication. Identifies the transaction on future events.

x-skip-reconciliationboolean

If true, the reconciliation process is skipped and the Integrated payments financial reconciliation event is not generated. Default is false.<br> The financial reconciliation process compares the transaction made on Pismo with the same transaction made on the provider side (i.e., BTG or Celcoin).

X-Signaturestring

This header is designed for clients working with a third‑party provider that requires certain transactions to include a certified digital signature for added security. It is optional and should be used only if your provider requires signature validation. When included, our APIs forward the header to the provider, which verifies the signature and approves or rejects the transaction based on its authenticity.

Request body

account_idinteger required

Pismo Platform client ID.

amountnumber required

Dot-separated transfer amount in decimals.

currency_codestring

ISO 4217 currency code. Can be either numeric or alphabetic.

processing_codestring required

Transfer processing code. Used to identify the type of transfer.

Example request

{
  "account_id": 415424,
  "amount": 101.11,
  "currency_code": "BRL",
  "processing_code": "876578435",
  "creditor": {
    "account": {
      "bank": {
        "branch": "0011",
        "code": "30306294",
        "identification": "30306294"
      },
      "identification": "98765432",
      "type": "CC"
    },
    "identification": "12345678900",
    "name": "John Doe",
    "type": "F"
  }
}

Response

Response Body

correlation_idstring

Correlation ID.

external_idstring

External ID of the provider.