> ## Documentation Index
> Fetch the complete documentation index at: https://docs.goatpay.com.br/llms.txt
> Use this file to discover all available pages before exploring further.
# Consultar envio PIX
> Consulta envio PIX (PIX_OUT) pelo ID interno ou `externalReference`.
```bash cURL theme={null}
curl -X GET 'https://api.goatpay.com.br/v1/transfer-pix/get/clx_transacao' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
```
```json Success theme={null}
{
"success": true,
"message": "Transferência PIX encontrada",
"data": {
"id": "clx_transacao",
"accountId": "clx_conta",
"type": "PIX_OUT",
"direction": "OUT",
"status": "COMPLETED",
"amount": 100,
"feeAmount": 12,
"netAmount": 88,
"coverFee": false,
"currency": "BRL",
"description": "Pedido 123",
"externalReference": "pedido-123",
"referenceId": "txid_abc",
"endToEndId": "E12345678202505301234567890123456",
"pixKey": null,
"pixKeyType": null,
"recipient": {
"name": "Maria Recebedora",
"document": "12345678909"
},
"copyPaste": "00020101021226730014br.gov.bcb.pix...",
"qrCodeBase64": "data:image/png;base64,...",
"qrcodeUrl": "https://...",
"completedAt": "2026-05-31T12:00:00.000Z",
"expiresAt": "2026-05-31T18:00:00.000Z",
"createdAt": "2026-05-31T11:00:00.000Z",
"updatedAt": "2026-05-31T12:00:00.000Z"
},
"requestId": "req_abc123"
}
```
### Envelope da resposta
| Campo | Tipo | Descrição |
| --------- | ------- | -------------------------------------------------- |
| success | boolean | `true` em sucesso HTTP 2xx |
| message | string | Mensagem legível (ex.: "Transação PIX encontrada") |
| data | object | Payload do recurso (formato abaixo) |
| requestId | string | ID da requisição para suporte (`req_...`) |
### Status em `data.status` (envio PIX)
| Status | Significado |
| ---------- | ------------------------ |
| PENDING | Em fila / aguardando SPI |
| PROCESSING | Processando |
| COMPLETED | Enviado com sucesso |
| FAILED | Falhou |
| CANCELED | Cancelado |
Campos iguais à consulta de cobrança PIX, com `type`: `PIX_OUT` e `pixKey` / `endToEndId` preenchidos após liquidação. Após liquidar, `recipient` traz `name` e `document` do favorecido (PIX Padrão).
### Parâmetros de rota
ID da transação ou `externalReference`.
## OpenAPI
````yaml GET /transfer-pix/get/{id}
openapi: 3.1.0
info:
title: GoatPay API
description: >
API pública merchant da GoatPay. Autenticação via header `X-API-Key:
gp_live_...`.
Respostas de sucesso usam o envelope `{ success, message, data, requestId
}`.
Campos internos (`accountId`, `metadata`, histórico de entregas de webhook,
etc.) não são expostos.
`providerTransactionId` aparece como `referenceId`; `providerInfractionId`
como `infractionId`.
Rate limit global: 100 requisições por minuto por API key (HTTP 429). Sem
chave, limite por IP.
version: 1.0.0
servers:
- url: https://api.goatpay.com.br/v1
description: Produção
security:
- apiKeyAuth: []
tags:
- name: pix
description: >-
Cobranças PIX (receber), reembolsos de depósito recebido e transferências
PIX (enviar). Alias legado em payouts/* para envios.
- name: transfer-internal
description: Transferências entre contas GoatPay
- name: transfer-scheduled
description: Transferências programadas (agendar, repetir ou por saldo)
- name: crypto
description: Depósitos e transferências em criptomoeda
- name: billings
description: >-
Cobranças avulsas (pagamento único) — boleto, cartão ou PIX na Conta
Padrão (PF ou PJ)
- name: subscriptions
description: >-
Assinaturas recorrentes com ciclo fixo — boleto, cartão ou PIX na Conta
Padrão (PF ou PJ)
- name: account
description: Saldo e extrato
- name: subaccount
description: Subcontas merchant (carteiras lógicas sob a conta principal)
- name: meds
description: Disputas MED
- name: webhooks
description: Endpoints de webhook de saída
- name: payouts
description: Alias de transfer-pix para saques PIX
- name: customers
description: Clientes da loja (CRM)
- name: products
description: Produtos e entregas digitais
- name: coupons
description: Cupons de desconto para links
- name: payment-links
description: Links de pagamento e checkout hospedado
paths:
/transfer-pix/get/{id}:
get:
tags:
- pix
summary: Consultar transferência PIX
operationId: getTransferPix
parameters:
- $ref: '#/components/parameters/ResourceId'
responses:
'200':
$ref: '#/components/responses/PixTransferSuccess'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
components:
parameters:
ResourceId:
name: id
in: path
required: true
schema:
type: string
description: ID do recurso (transação, cobrança, webhook, etc.)
responses:
PixTransferSuccess:
description: Transferência PIX criada ou consultada.
content:
application/json:
schema:
type: object
required:
- success
- message
- data
properties:
success:
type: boolean
message:
type: string
data:
$ref: '#/components/schemas/PublicTransaction'
requestId:
type: string
examples:
created:
summary: Saque criado
value:
success: true
message: Transferência PIX criada com sucesso
data:
id: clx_pix_out
type: PIX_OUT
status: PROCESSING
amount: 50
feeAmount: 2
netAmount: 52
coverFee: true
currency: BRL
countsTowardPixBalance: true
settlementScope: goatpay
description: Saque parceiro
pixKey: '11999999999'
pixKeyType: TELEFONE
referenceId: ref_out_xyz
createdAt: '2026-06-01T14:00:00.000Z'
requestId: req_def456
completed:
summary: Saque liquidado (com favorecido)
value:
success: true
message: Transferência PIX encontrada
data:
id: clx_pix_out
type: PIX_OUT
status: COMPLETED
amount: 50
feeAmount: 2
netAmount: 52
coverFee: true
currency: BRL
countsTowardPixBalance: true
settlementScope: goatpay
description: Saque parceiro
pixKey: '11999999999'
pixKeyType: TELEFONE
referenceId: ref_out_xyz
endToEndId: E12345678202505301234567890123456
recipient:
name: Maria Recebedora
document: '12345678909'
completedAt: '2026-06-01T14:05:00.000Z'
createdAt: '2026-06-01T14:00:00.000Z'
requestId: req_def456
Unauthorized:
description: Chave ausente, inválida ou revogada.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
NotFound:
description: Recurso não encontrado.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
schemas:
PublicTransaction:
type: object
description: >
Transação exposta na API pública após sanitização.
Não inclui `provider`, `accountId`, `metadata`, `pixRail`, `direction`,
`updatedAt` nem `providerStatus`.
properties:
id:
type: string
type:
type: string
description: Ex. PIX_IN, PIX_OUT, INTERNAL_TRANSFER_OUT, CRYPTO_IN.
status:
type: string
enum:
- PENDING
- PROCESSING
- COMPLETED
- FAILED
- CANCELED
- REVERSED
amount:
type: number
feeAmount:
type: number
netAmount:
type: number
coverFee:
type: boolean
emitFiscalInvoice:
type: boolean
description: Indica se a cobrança deve gerar nota fiscal ao ser paga.
currency:
type: string
example: BRL
countsTowardPixBalance:
type: boolean
description: Indica se a transação movimenta o saldo PIX GoatPay.
settlementScope:
type: string
enum:
- goatpay
description: Escopo de liquidação/saldo da transação.
description:
type: string
externalReference:
type: string
referenceId:
type: string
description: Identificador da operação no processador de pagamento.
endToEndId:
type: string
pixKey:
type: string
pixKeyType:
type: string
payer:
type: object
description: >-
Cliente/pagador da transação. Em PIX recebido após confirmação,
`name` e `document` vêm do comprovante PIX Padrão. Em cobranças de
link de pagamento, `email` e `phone` (e nome/documento do checkout
quando ainda não houver pagamento confirmado) vêm do formulário do
comprador. Presente em entradas (PIX, boleto, cartão, etc.) quando
há dados identificáveis; ausente em saídas PIX e quando não há
nenhum dado.
properties:
name:
type: string
nullable: true
description: Nome do pagador (comprovante PIX ou checkout do link).
document:
type: string
nullable: true
description: CPF ou CNPJ do pagador (apenas dígitos).
email:
type: string
nullable: true
description: E-mail informado no checkout do link de pagamento.
phone:
type: string
nullable: true
description: Telefone informado no checkout do link de pagamento.
recipient:
type: object
description: >-
Favorecido (recebedor) da transferência PIX, com nome e documento
confirmados na liquidação PIX (`creditorAccount`). Presente apenas
em `PIX_OUT` após a liquidação; ausente em saídas pendentes, em PIX
recebido e quando o favorecido não é confirmado.
properties:
name:
type: string
nullable: true
description: Nome do favorecido confirmado pelo banco.
document:
type: string
nullable: true
description: CPF ou CNPJ do favorecido (apenas dígitos).
subaccountId:
type: string
completedAt:
type: string
format: date-time
expiresAt:
type: string
format: date-time
createdAt:
type: string
format: date-time
ErrorEnvelope:
type: object
required:
- success
- message
- error
properties:
success:
type: boolean
example: false
message:
type: string
example: Subconta inativa
error:
type: object
properties:
code:
type: string
example: Bad Request
statusCode:
type: integer
example: 400
requestId:
type: string
example: req_abc123
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: X-API-Key
description: Chave `gp_live_...` criada em Integrações → Chaves de API no dashboard.
````