Skip to main content
POST
Enviar PIX
Envia um Pix do saldo da sua conta para a chave Pix de outra pessoa ou empresa.
Requer a permissão WITHDRAW:CREATE.

Entenda o Enviar Pix

Taxa, limites compartilhados com o saque, tipos de chave, Pix Copia e Cola, idempotência pelo externalId e eventos.
Exemplo:
Erros comuns:

Authorizations

Authorization
string
header
required

Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.

Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.

Body

application/json

Dados necessários para enviar um PIX.

amount
number
required

Valor do PIX em centavos. A taxa (platformFee) é descontada desse valor; o destinatário recebe amount menos a taxa.

Required range: x >= 100
Example:

10000

externalId
string
required

Identificador único do PIX em seu sistema.

Example:

"pix-123"

pix
object
required

Dados da chave PIX de destino.

description
string

Descrição opcional do PIX.

Example:

"Pagamento para fornecedor"

Response

PIX enviado com sucesso.

data
object

Dados de uma transação PIX.

error
string | null
Example:

null

success
boolean

Se a requisição obteve sucesso ou não.

Example:

true