v2

latestOpenAPI 3.1.02026-07-314524165.2 KB

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

Request body

amountnumber required

Valor do PIX em centavos.

externalIdstring required

Identificador único do PIX em seu sistema.

descriptionstring

Descrição opcional do PIX.

Example request

{
  "amount": 10000,
  "externalId": "pix-123",
  "description": "Pagamento para fornecedor",
  "pix": {
    "key": "11987654321",
    "type": "PHONE"
  }
}

Response

PIX enviado com sucesso.

errorstring nullable
successboolean

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

Example response

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