Pular para o conteúdo principal
POST
/
v1
/
transfers
/
cashout
/
process
Processar uma Transferência Pix
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"
}

Autorizações

​
Authorization
string
header
obrigatório

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

Cabeçalhos

​
X-Account-Id
string
obrigatório

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

​
X-Purpose
enum<string>
padrão:TRANSFER

Finalidade da transação para o cash-out. Assume TRANSFER quando omitido.

Opções disponíveis:
TRANSFER,
CHANGE,
WITHDRAWAL,
REFUND_AUTOMATIC_PIX,
INSTANT_PAYMENT_REFUND,
INSTALLMENT_PIX
​
X-Idempotency
string

Chave de idempotência opcional para repetições seguras. Reutilize o mesmo valor apenas ao repetir a mesma operação após um resultado desconhecido.

Consulte Repetições e idempotência para mais detalhes.

​
X-TTL
integer

Tempo de vida (time-to-live), em segundos, para o cache da chave de idempotência. Define por quanto tempo o sistema lembra de uma requisição processada.

Consulte Repetições e idempotência para mais detalhes.

Corpo

application/json
​
initiationId
string
obrigatório

ID de iniciação obtido na etapa de iniciação.

Exemplo:

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

Resposta

Transferência Pix processada com sucesso.

A resposta inclui o cabeçalho X-Idempotency-Replayed.

Se o valor for false, a transação acabou de ser processada. Se o valor for true, a resposta é uma reprodução de uma requisição processada anteriormente.

Consulte Retentativas e idempotência para mais detalhes.

​
id
string

Identificador único da transferência.

Exemplo:

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

​
endToEndId
string

Identificador end-to-end.

Exemplo:

"E123456789BR1234567890123456789"

​
amount
string

Valor da transferência.

Exemplo:

"100.00"

​
status
enum<string>

Status da transferência.

Opções disponíveis:
PENDING,
PROCESSING,
COMPLETED,
FAILED,
CANCELLED
Exemplo:

"COMPLETED"

​
type
enum<string>

Tipo de transferência.

Opções disponíveis:
CASHOUT,
CASHIN
Exemplo:

"CASHOUT"

​
createdAt
string<date-time>
Exemplo:

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

​
updatedAt
string<date-time>
Exemplo:

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