Skip to main content
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
}

Requer a permissão WITHDRAW:CREATE.

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.

​
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