Skip to main content
POST
/
payment-pix
/
create
curl -X POST 'https://api.goatpay.com.br/v1/payment-pix/create' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{ "amount": 100, "description": "Pedido 123", "coverFee": false }'

{
  "success": true,
  "message": "Pagamento PIX criado com sucesso",
  "data": {
    "id": "clx_transacao",
    "type": "PIX_IN",
    "status": "PENDING",
    "amount": 100,
    "feeAmount": 8.5,
    "netAmount": 91.5,
    "coverFee": false,
    "currency": "BRL",
    "description": "Pedido 123",
    "externalReference": "pedido-123",
    "referenceId": "txid_abc",
    "copyPaste": "000201010212...",
    "qrCodeBase64": "data:image/png;base64,...",
    "qrcodeUrl": "https://pay.goatpay.com.br/p/clx_transacao",
    "expiresAt": "2026-06-02T12:00:00.000Z",
    "createdAt": "2026-06-01T12:00:00.000Z"
  },
  "requestId": "req_abc123"
}

curl -X POST 'https://api.goatpay.com.br/v1/payment-pix/create' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{ "amount": 100, "description": "Pedido 123", "coverFee": false }'

{
  "success": true,
  "message": "Pagamento PIX criado com sucesso",
  "data": {
    "id": "clx_transacao",
    "type": "PIX_IN",
    "status": "PENDING",
    "amount": 100,
    "feeAmount": 8.5,
    "netAmount": 91.5,
    "coverFee": false,
    "currency": "BRL",
    "description": "Pedido 123",
    "externalReference": "pedido-123",
    "referenceId": "txid_abc",
    "copyPaste": "000201010212...",
    "qrCodeBase64": "data:image/png;base64,...",
    "qrcodeUrl": "https://pay.goatpay.com.br/p/clx_transacao",
    "expiresAt": "2026-06-02T12:00:00.000Z",
    "createdAt": "2026-06-01T12:00:00.000Z"
  },
  "requestId": "req_abc123"
}

​
Corpo da requisição

​
amount
number
required
Valor em reais. Mínimo R1,00notrilhoPADRAOeR 1,00 no trilho PADRAO e R 3,00 no trilho LIVRE.
​
description
string
required
Descrição da cobrança (3 a 180 caracteres).
​
coverFee
boolean
Se true, amount é o líquido desejado. Padrão false (valor bruto do QR).
​
payerName
string
Nome do pagador.
​
payerDocument
string
CPF ou CNPJ do pagador.
​
externalReference
string
Referência externa do seu sistema.
​
subaccountId
string
Credita o líquido na subconta merchant. Veja subcontas.
​
splitUser
string
E-mail GoatPay do parceiro no split interno.
​
splitTax
number
Percentual do líquido repassado ao splitUser (0,01 a 100).
Confirme pagamento com webhooks payment.paid ou GET /payment-pix/get/:id.

Authorizations

​
X-API-Key
string
header
required

Chave gp_live_... criada em Integrações → Chaves de API no dashboard.

Body

application/json
​
amount
number
required

Valor em reais.

Required range: 3 <= x <= 1000000
​
description
string
required
Required string length: 3 - 180
​
payerName
string
Maximum string length: 120
​
payerDocument
string
Maximum string length: 14
​
externalReference
string
Maximum string length: 120
​
coverFee
boolean
default:false
​
splitUser
string<email>

E-mail GoatPay do parceiro no split interno.

​
splitTax
number
Required range: 0.01 <= x <= 100
​
subaccountId
string

ID da subconta merchant. Líquido credita na subconta (requer merchantSubaccountsPixEnabled).

Response

Cobrança PIX criada ou consultada.

​
success
boolean
required
Example:

true

​
message
string
required
​
data
object
required

Transação exposta na API pública após sanitização. Não inclui provider, accountId, metadata, pixRail, direction, updatedAt nem providerStatus.

​
requestId
string