Skip to main content
POST
Enviar transferência PIX

Authorizations

Authorization
string
header
required

Token JWT no cabeçalho Authorization

Headers

x-idempotency-key
string
required

Chave de idempotência para evitar duplicações

Body

application/json
pixKey
string
required

Chave PIX de destino (CPF, CNPJ, email, telefone ou chave aleatória)

Example:

"fornecedor@exemplo.com"

amount
integer
required

Valor da transferência em centavos

Required range: x >= 1
Example:

10000

currency
string
default:BRL

Moeda da transferência (apenas BRL aceito)

Example:

"BRL"

description
string

Descrição da transferência

Maximum string length: 140
Example:

"Transfer PIX Exemplo"

postbackUrl
string<uri>

URL para receber notificações de status da transferência

Example:

"https://exemplo.com.br/webhook/pix-out"

Response

Transferência iniciada com sucesso

success
boolean

Indica se a operação foi bem-sucedida

Example:

true

message
string

Mensagem de retorno

Example:

"Transferência criada com sucesso"

data
object