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",
  "amount": "100.50"
}
'

import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/transfers/cashout/process"

payload = {
    "initiationId": "019c96a0-0c82-7c3d-8dcc-c180868b45c4",
    "amount": "100.50"
}
headers = {
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Account-Id': '<x-account-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({initiationId: '019c96a0-0c82-7c3d-8dcc-c180868b45c4', amount: '100.50'})
};

fetch('https://plugin-pix-indirect.api.lerian.net/v1/transfers/cashout/process', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://plugin-pix-indirect.api.lerian.net/v1/transfers/cashout/process",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'initiationId' => '019c96a0-0c82-7c3d-8dcc-c180868b45c4',
    'amount' => '100.50'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Account-Id: <x-account-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://plugin-pix-indirect.api.lerian.net/v1/transfers/cashout/process"

	payload := strings.NewReader("{\n  \"initiationId\": \"019c96a0-0c82-7c3d-8dcc-c180868b45c4\",\n  \"amount\": \"100.50\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Account-Id", "<x-account-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://plugin-pix-indirect.api.lerian.net/v1/transfers/cashout/process")
  .header("X-Account-Id", "<x-account-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"initiationId\": \"019c96a0-0c82-7c3d-8dcc-c180868b45c4\",\n  \"amount\": \"100.50\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://plugin-pix-indirect.api.lerian.net/v1/transfers/cashout/process")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Account-Id"] = '<x-account-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"initiationId\": \"019c96a0-0c82-7c3d-8dcc-c180868b45c4\",\n  \"amount\": \"100.50\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "019c96a0-0c21-71f9-a487-66a1258278a1",
  "endToEndId": "E123456789BR1234567890123456789",
  "amount": "100.00",
  "status": "COMPLETED",
  "type": "CASHOUT",
  "description": "Pix Cashout Transfer",
  "source": {
    "key": "john.doe@example.com",
    "account": {
      "branch": "0001",
      "number": "123456789",
      "participant": "12345678",
      "type": "CACC"
    },
    "owner": {
      "document": "12345678901",
      "name": "John Doe",
      "tradeName": "John's Business",
      "type": "NATURAL_PERSON"
    }
  },
  "destination": {
    "key": "john.doe@example.com",
    "account": {
      "branch": "0001",
      "number": "123456789",
      "participant": "12345678",
      "type": "CACC"
    },
    "owner": {
      "document": "12345678901",
      "name": "John Doe",
      "tradeName": "John's Business",
      "type": "NATURAL_PERSON"
    }
  },
  "paymentType": "IMMEDIATE",
  "initiationType": "KEY",
  "urgency": "HIGH",
  "purpose": "TRANSFER",
  "accountId": "01989f9e-6508-79f8-9540-835be49fbd0d",
  "aliasId": "01989f9e-6508-79f8-9540-835be49fbd0e",
  "initiatedAt": "2024-01-15T10:30:00Z",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "ledger": {
    "transactionId": "550e8400-e29b-41d4-a716-446655440011",
    "sourceOperationId": "550e8400-e29b-41d4-a716-446655440012",
    "destinationOperationId": "550e8400-e29b-41d4-a716-446655440013",
    "revert": {
      "transactionId": "550e8400-e29b-41d4-a716-446655440014",
      "sourceOperationId": "550e8400-e29b-41d4-a716-446655440015",
      "destinationOperationId": "550e8400-e29b-41d4-a716-446655440016"
    }
  },
  "metadata": {},
  "feeCharge": {
    "applied": true,
    "calculationType": "segment",
    "totalAmount": "2.50",
    "netAmount": "97.50",
    "fees": [
      {
        "feeLabel": "PIX_FEE",
        "amount": "1.50",
        "creditAccount": "01989f9e-6508-79f8-9540-835be49fbd0d",
        "calculationType": "PERCENTAGE",
        "calculationValue": "1.5"
      }
    ]
  }
}

POST

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",
  "amount": "100.50"
}
'

import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/transfers/cashout/process"

payload = {
    "initiationId": "019c96a0-0c82-7c3d-8dcc-c180868b45c4",
    "amount": "100.50"
}
headers = {
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Account-Id': '<x-account-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({initiationId: '019c96a0-0c82-7c3d-8dcc-c180868b45c4', amount: '100.50'})
};

fetch('https://plugin-pix-indirect.api.lerian.net/v1/transfers/cashout/process', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://plugin-pix-indirect.api.lerian.net/v1/transfers/cashout/process",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'initiationId' => '019c96a0-0c82-7c3d-8dcc-c180868b45c4',
    'amount' => '100.50'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Account-Id: <x-account-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://plugin-pix-indirect.api.lerian.net/v1/transfers/cashout/process"

	payload := strings.NewReader("{\n  \"initiationId\": \"019c96a0-0c82-7c3d-8dcc-c180868b45c4\",\n  \"amount\": \"100.50\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Account-Id", "<x-account-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://plugin-pix-indirect.api.lerian.net/v1/transfers/cashout/process")
  .header("X-Account-Id", "<x-account-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"initiationId\": \"019c96a0-0c82-7c3d-8dcc-c180868b45c4\",\n  \"amount\": \"100.50\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://plugin-pix-indirect.api.lerian.net/v1/transfers/cashout/process")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Account-Id"] = '<x-account-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"initiationId\": \"019c96a0-0c82-7c3d-8dcc-c180868b45c4\",\n  \"amount\": \"100.50\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "019c96a0-0c21-71f9-a487-66a1258278a1",
  "endToEndId": "E123456789BR1234567890123456789",
  "amount": "100.00",
  "status": "COMPLETED",
  "type": "CASHOUT",
  "description": "Pix Cashout Transfer",
  "source": {
    "key": "john.doe@example.com",
    "account": {
      "branch": "0001",
      "number": "123456789",
      "participant": "12345678",
      "type": "CACC"
    },
    "owner": {
      "document": "12345678901",
      "name": "John Doe",
      "tradeName": "John's Business",
      "type": "NATURAL_PERSON"
    }
  },
  "destination": {
    "key": "john.doe@example.com",
    "account": {
      "branch": "0001",
      "number": "123456789",
      "participant": "12345678",
      "type": "CACC"
    },
    "owner": {
      "document": "12345678901",
      "name": "John Doe",
      "tradeName": "John's Business",
      "type": "NATURAL_PERSON"
    }
  },
  "paymentType": "IMMEDIATE",
  "initiationType": "KEY",
  "urgency": "HIGH",
  "purpose": "TRANSFER",
  "accountId": "01989f9e-6508-79f8-9540-835be49fbd0d",
  "aliasId": "01989f9e-6508-79f8-9540-835be49fbd0e",
  "initiatedAt": "2024-01-15T10:30:00Z",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "ledger": {
    "transactionId": "550e8400-e29b-41d4-a716-446655440011",
    "sourceOperationId": "550e8400-e29b-41d4-a716-446655440012",
    "destinationOperationId": "550e8400-e29b-41d4-a716-446655440013",
    "revert": {
      "transactionId": "550e8400-e29b-41d4-a716-446655440014",
      "sourceOperationId": "550e8400-e29b-41d4-a716-446655440015",
      "destinationOperationId": "550e8400-e29b-41d4-a716-446655440016"
    }
  },
  "metadata": {},
  "feeCharge": {
    "applied": true,
    "calculationType": "segment",
    "totalAmount": "2.50",
    "netAmount": "97.50",
    "fees": [
      {
        "feeLabel": "PIX_FEE",
        "amount": "1.50",
        "creditAccount": "01989f9e-6508-79f8-9540-835be49fbd0d",
        "calculationType": "PERCENTAGE",
        "calculationValue": "1.5"
      }
    ]
  }
}

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"

amount

string

required

Transfer amount in BRL (format 0.00). For QR codes with a fixed amount, this must match the amount encoded in the QR code.

Example:

"100.50"

description

string

Optional description or message.

Maximum string length: 140

Example:

"Payment for services"

metadata

object

Custom key-value attributes for this transfer. Maximum 50 keys, key max 100 chars, value max 2000 chars.

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.

string

Transfer unique identifier.

Example:

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

endToEndId

string

End-to-end identifier.

Example:

"E123456789BR1234567890123456789"

amount

string

Transfer amount in BRL (format 0.00).

Example:

"100.00"

status

enum<string>

Transfer status.

Available options:

CREATED,

PENDING,

PROCESSING,

COMPLETED,

FAILED,

REVERSED

Example:

"COMPLETED"

type

enum<string>

Transfer type.

Available options:

CASHOUT,

CASHIN

Example:

"CASHOUT"

description

string

Optional description or message.

Maximum string length: 140

Example:

"Pix Cashout Transfer"

source

object

Account party (source or destination) information.

Show child attributes

destination

object

Account party (source or destination) information.

Show child attributes

paymentType

enum<string>

Payment type.

Available options:

IMMEDIATE,

SCHEDULED

Example:

"IMMEDIATE"

initiationType

enum<string>

Initiation type.

Available options:

MANUAL,

KEY,

QR_CODE

Example:

"KEY"

urgency

enum<string>

Transfer urgency.

Available options:

HIGH,

NORMAL

Example:

"HIGH"

purpose

enum<string>

Transaction purpose type. Defaults to TRANSFER.

Available options:

TRANSFER,

INSTANT_PAYMENT_REFUND

Example:

"TRANSFER"

accountId

string

Account identifier (UUID).

Example:

"01989f9e-6508-79f8-9540-835be49fbd0d"

aliasId

string

Alias identifier (UUID).

Example:

"01989f9e-6508-79f8-9540-835be49fbd0e"

initiatedAt

string<date-time>

Initiation timestamp (ISO 8601 UTC).

Example:

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

createdAt

string<date-time>

Example:

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

updatedAt

string<date-time>

Example:

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

ledger

object

Midaz ledger transaction and operation identifiers.

Show child attributes

metadata

object

Custom key-value attributes associated with this transfer. Maximum 50 keys, key max 100 chars, value max 2000 chars.

feeCharge

object

Fee calculation details (if applicable).

Show child attributes

⌘I

Pix — Lerian SPI (native messaging)

Pix — JD (interface, direct)

Pix — BTG (interface, indirect)

TED — Lerian SPB (native messaging)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (native messaging)

Lerian SLC (native messaging)

Lerian STA (native messaging)

Lerian SISBAJUD (native messaging)

Lerian Consignado (native messaging)

Process a Pix Transfer

Authorizations

Headers

Body

Response