Pular para o conteúdo principal
POST
/
v1
/
transfers
/
cashout
/
initiate
Iniciar uma Transferência PIX
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": {}
}

Autorizações

​
Authorization
string
header
obrigatório

Header de autenticação Bearer no formato Bearer <token>, onde <token> é o seu token de acesso JWT.

Cabeçalhos

​
X-Account-Id
string
obrigatório

Identificador único da Conta do Ledger Midaz (formato UUID).

​
X-Idempotency
string

Chave de idempotência opcional para retentativas seguras. Se omitida, o servidor pode gerar uma automaticamente a partir do hash do corpo da requisição.

Consulte Retentativas e idempotência para mais detalhes.

​
X-TTL
integer

Tempo de vida em segundos para o cache da chave de idempotência. Define por quanto tempo o sistema lembra de uma requisição processada.

Consulte Retentativas e idempotência para mais detalhes.

Corpo

application/json
​
type
enum<string>
obrigatório

Tipo de iniciação.

Opções disponíveis:
MANUAL,
KEY,
QR_CODE
Exemplo:

"KEY"

​
amount
string
obrigatório

Valor da transferência.

Exemplo:

"100.00"

​
key
string

Chave PIX (obrigatória para o tipo KEY).

Exemplo:

"john.doe@example.com"

​
emv
string

Payload EMV do QR Code (obrigatório para o tipo QR_CODE).

​
description
string

Descrição da transferência.

Exemplo:

"Payment for services"

Resposta

Iniciação de cash-out PIX criada com sucesso.

A resposta inclui o header X-Idempotency-Replayed.

Se o valor for false, a transação foi recém-processada. Se o valor for true, a resposta é uma repetição de uma requisição processada anteriormente.

Consulte Retentativas e idempotência para mais detalhes.

​
initiationId
string

ID de iniciação a ser usado no processamento.

Exemplo:

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

​
destination
object

Informações validadas do destino.