Skip to main content
POST
/
v1
/
transfers
/
cashout
/
initiate
Initiate a Pix Transfer
curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/v1/transfers/cashout/initiate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --data '
{
  "type": "KEY",
  "amount": "100.00",
  "key": "john.doe@example.com",
  "description": "Payment for services"
}
'
{
  "initiationId": "019c96a0-0c82-7c3d-8dcc-c180868b45c4",
  "destination": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-Account-Id
string
required

Unique identifier of the Midaz Ledger Account (UUID format).

​
X-Idempotency
string

Optional idempotency key for safe retries. Reuse the same value only when retrying the same operation after an unknown outcome.

See Retries and idempotency for details.

​
X-TTL
integer

Time-to-live in seconds for the idempotency key cache. Defines how long the system remembers a processed request.

See Retries and idempotency for details.

Body

application/json
​
type
enum<string>
required

Initiation type.

Available options:
MANUAL,
KEY,
QR_CODE
Example:

"KEY"

​
amount
string
required

Transfer amount.

Example:

"100.00"

​
key
string

Pix key (required for KEY type).

Example:

"john.doe@example.com"

​
emv
string

QR Code EMV payload (required for QR_CODE type).

​
description
string

Transfer description.

Example:

"Payment for services"

Response

Pix cash-out initiation created successfully.

The response includes the X-Idempotency-Replayed header.

If the value is false, the transaction was just processed. If the value is true, the response is a replay of a previously processed request.

See Retries and idempotency for more details.

​
initiationId
string

Initiation ID to be used in process.

Example:

"019c96a0-0c82-7c3d-8dcc-c180868b45c4"

​
destination
object

Validated destination information.