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"
}
'

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))

}

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));

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)

{
  "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"
}
'

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))

}

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));

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)

{
  "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"
      }
    ]
  }
}

Autorizaciones

Authorization

string

header

requerido

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

Encabezados

X-Account-Id

string

requerido

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

X-Purpose

enum<string>

predeterminado:TRANSFER

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

Opciones disponibles:

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.

Cuerpo

application/json

initiationId

string

requerido

Initiation ID from the initiate step.

Ejemplo:

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

amount

string

requerido

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

Ejemplo:

"100.50"

description

string

Optional description or message.

Maximum string length: 140

Ejemplo:

"Payment for services"

metadata

object

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

Respuesta

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.

Ejemplo:

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

endToEndId

string

End-to-end identifier.

Ejemplo:

"E123456789BR1234567890123456789"

amount

string

Transfer amount in BRL (format 0.00).

Ejemplo:

"100.00"

status

enum<string>

Transfer status.

Opciones disponibles:

CREATED,

PENDING,

PROCESSING,

COMPLETED,

FAILED,

REVERSED

Ejemplo:

"COMPLETED"

type

enum<string>

Transfer type.

Opciones disponibles:

CASHOUT,

CASHIN

Ejemplo:

"CASHOUT"

description

string

Optional description or message.

Maximum string length: 140

Ejemplo:

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

Opciones disponibles:

IMMEDIATE,

SCHEDULED

Ejemplo:

"IMMEDIATE"

initiationType

enum<string>

Initiation type.

Opciones disponibles:

MANUAL,

KEY,

QR_CODE

Ejemplo:

"KEY"

urgency

enum<string>

Transfer urgency.

Opciones disponibles:

HIGH,

NORMAL

Ejemplo:

"HIGH"

purpose

enum<string>

Transaction purpose type. Defaults to TRANSFER.

Opciones disponibles:

TRANSFER,

INSTANT_PAYMENT_REFUND

Ejemplo:

"TRANSFER"

accountId

string

Account identifier (UUID).

Ejemplo:

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

aliasId

string

Alias identifier (UUID).

Ejemplo:

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

initiatedAt

string<date-time>

Initiation timestamp (ISO 8601 UTC).

Ejemplo:

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

createdAt

string<date-time>

Ejemplo:

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

updatedAt

string<date-time>

Ejemplo:

"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

API de DICT

API de Reclamaciones

MED · Infracciones

MED · Marcadores de fraude

MED · Solicitudes de devolución

MED · Estadísticas

API de Transacciones

API de Códigos QR

API de Cobros

API de Recuperación de Fondos

API de Conciliación

API de Pix Automático

API de Programaciones

API de Informes de Transacción

API de Webhooks

Manejo de errores

Process a Pix Transfer

Autorizaciones

Encabezados

Cuerpo

Respuesta