Skip to main content
POST
/
v1
/
transfers
/
cashout
/
process
Process a Pix Transfer
curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/v1/transfers/cashout/process \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --data '
{
  "initiationId": "019c96a0-0c82-7c3d-8dcc-c180868b45c4"
}
'
{
  "id": "019c96a0-0c21-71f9-a487-66a1258278a1",
  "endToEndId": "E123456789BR1234567890123456789",
  "amount": "100.00",
  "status": "COMPLETED",
  "type": "CASHOUT",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

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-Purpose
enum<string>
default:TRANSFER

Transaction purpose for the cash-out. Defaults to TRANSFER when omitted.

Available options:
TRANSFER,
CHANGE,
WITHDRAWAL,
REFUND_AUTOMATIC_PIX,
INSTANT_PAYMENT_REFUND,
INSTALLMENT_PIX
​
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
​
initiationId
string
required

Initiation ID from the initiate step.

Example:

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

Response

Pix transfer processed 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.

​
id
string

Transfer unique identifier.

Example:

"019c96a0-0c21-71f9-a487-66a1258278a1"

​
endToEndId
string

End-to-end identifier.

Example:

"E123456789BR1234567890123456789"

​
amount
string

Transfer amount.

Example:

"100.00"

​
status
enum<string>

Transfer status.

Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED,
CANCELLED
Example:

"COMPLETED"

​
type
enum<string>

Transfer type.

Available options:
CASHOUT,
CASHIN
Example:

"CASHOUT"

​
createdAt
string<date-time>
Example:

"2024-01-15T10:30:00Z"

​
updatedAt
string<date-time>
Example:

"2024-01-15T10:30:00Z"