ABabacatepay

Enviar PIX

Changed on

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

  • Base URL
    https://api.abacatepay.com/v2
  • URL
    https://api.abacatepay.com/v2/pix/send
  • Auth
    HTTP bearer

Request body

amountnumber required

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

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": "tran_abc123xyz",
    "status": "COMPLETE",
    "receiptUrl": "https://app.abacatepay.com/receipt/tran_abc123xyz",
    "amount": 10000,
    "platformFee": 80,
    "externalId": "pix-123",
    "createdAt": "2024-11-04T18:38:28.573Z",
    "updatedAt": "2024-11-04T18:38:28.573Z"
  },
  "success": true
}

Changes

  • 0ac54d6c2796Revision changes
    • warning

      added the new FAILED enum value to the / response property for the response status

    • info

      removed the CANCELLED enum value from the / response property for the response status

    • info

      removed the EXPIRED enum value from the / response property for the response status

    • info

      removed the PENDING enum value from the / response property for the response status

    • info

      removed the REFUNDED enum value from the / response property for the response status

  • ea8a72b04f2aRevision changes
    • breaking

      the request property's min was increased to 100.00