Enviar PIX

curl --request POST \
  --url https://api.abacatepay.com/v2/pix/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 10000,
  "externalId": "pix-123",
  "description": "Pagamento para fornecedor",
  "pix": {
    "key": "11987654321",
    "type": "PHONE"
  }
}
'

{
  "data": {
    "id": "txn_abc123xyz",
    "status": "PENDING",
    "devMode": false,
    "receiptUrl": "https://app.abacatepay.com/receipt/txn_abc123xyz",
    "amount": 10000,
    "platformFee": 100,
    "createdAt": "2024-11-04T18:38:28.573Z",
    "updatedAt": "2024-11-04T18:38:28.573Z",
    "externalId": "pix-123"
  },
  "error": null,
  "success": true
}

PIX

Enviar PIX

Permite que você envie dinheiro via PIX para qualquer chave PIX que não seja do titular da conta.

Você pode usar esta rota para:

Enviar pagamentos para fornecedores, parceiros ou terceiros
Realizar transferências para contas de outras pessoas ou empresas
Efetuar pagamentos diretamente pela API

Importante: Esta funcionalidade é diferente dos payouts, pois permite enviar dinheiro para chaves PIX que não pertencem ao titular da conta. Use payouts quando quiser enviar para sua própria chave PIX.

POST

pix

send

Enviar PIX

curl --request POST \
  --url https://api.abacatepay.com/v2/pix/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 10000,
  "externalId": "pix-123",
  "description": "Pagamento para fornecedor",
  "pix": {
    "key": "11987654321",
    "type": "PHONE"
  }
}
'

{
  "data": {
    "id": "txn_abc123xyz",
    "status": "PENDING",
    "devMode": false,
    "receiptUrl": "https://app.abacatepay.com/receipt/txn_abc123xyz",
    "amount": 10000,
    "platformFee": 100,
    "createdAt": "2024-11-04T18:38:28.573Z",
    "updatedAt": "2024-11-04T18:38:28.573Z",
    "externalId": "pix-123"
  },
  "error": null,
  "success": true
}

Envia dinheiro para qualquer chave PIX de terceiros — fornecedores, parceiros ou colaboradores.

Requer a permissão WITHDRAW:CREATE.

PIX vs Saques: use PIX para enviar a chaves de terceiros. Para sacar para a sua própria chave use Saques.

Exemplo:

{
  "amount": 10000,
  "description": "Pagamento fornecedor #42",
  "externalId": "pix-123",
  "pixKey": "contato@fornecedor.com",
  "pixKeyType": "EMAIL"
}

Tipos de chave PIX aceitos:

`pixKeyType`	Exemplo
`CPF`	`12345678901`
`CNPJ`	`12345678000190`
`PHONE`	`11987654321`
`EMAIL`	`contato@exemplo.com`
`RANDOM`	UUID aleatório
`BR_CODE`	Código completo do QR

Valor mínimo: R$ 1,00. O processamento é instantâneo e disponível 24/7.

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.

Required range: x >= 1

Example:

10000

externalId

string

required

Identificador único do PIX em seu sistema.

Example:

"pix-123"

pix

object

required

Dados da chave PIX de destino.

Show child attributes

description

string

Descrição opcional do PIX.

Example:

"Pagamento para fornecedor"

Response

PIX enviado com sucesso.

data

object

Dados de uma transação PIX.

Show child attributes

error

string | null

Example:

null

success

boolean

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

Example:

true

Referência Buscar PIX