Skip to main content
POST
Processar uma Transferência Pix

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"

amount
string
obrigatório

Valor da transferência em BRL (formato 0.00). Para QR codes com valor fixo, deve corresponder ao valor codificado no QR code.

Exemplo:

"100.50"

description
string

Descrição ou mensagem opcional.

Maximum string length: 140
Exemplo:

"Pagamento por serviços"

metadata
object

Atributos personalizados de chave-valor para esta transferência. Máximo de 50 chaves, chave com no máximo 100 caracteres, valor com no máximo 2000 caracteres.

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 em BRL (formato 0.00).

Exemplo:

"100.00"

status
enum<string>

Status da transferência.

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

"COMPLETED"

type
enum<string>

Tipo de transferência.

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

"CASHOUT"

description
string

Descrição ou mensagem opcional.

Maximum string length: 140
Exemplo:

"Pix Cashout Transfer"

source
object

Informações da parte da conta (origem ou destino).

destination
object

Informações da parte da conta (origem ou destino).

paymentType
enum<string>

Tipo de pagamento.

Opções disponíveis:
IMMEDIATE,
SCHEDULED
Exemplo:

"IMMEDIATE"

initiationType
enum<string>

Tipo de iniciação.

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

"KEY"

urgency
enum<string>

Urgência da transferência.

Opções disponíveis:
HIGH,
NORMAL
Exemplo:

"HIGH"

purpose
enum<string>

Tipo de finalidade da transação. O padrão é TRANSFER.

Opções disponíveis:
TRANSFER,
INSTANT_PAYMENT_REFUND
Exemplo:

"TRANSFER"

accountId
string

Identificador da conta (UUID).

Exemplo:

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

aliasId
string

Identificador do alias (UUID).

Exemplo:

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

initiatedAt
string<date-time>

Timestamp de iniciação (ISO 8601 UTC).

Exemplo:

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

createdAt
string<date-time>
Exemplo:

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

updatedAt
string<date-time>
Exemplo:

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

ledger
object

Identificadores de transação e operação do ledger Midaz.

metadata
object

Atributos personalizados de chave-valor associados a esta transferência. Máximo de 50 chaves, chave com no máximo 100 caracteres, valor com no máximo 2000 caracteres.

feeCharge
object

Detalhes do cálculo de tarifas (se aplicável).