Consultar envio PIX

curl -X GET 'https://api.goatpay.com.br/v1/transfer-pix/get/clx_transacao' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "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"
}

GET

transfer-pix

get

{id}

curl -X GET 'https://api.goatpay.com.br/v1/transfer-pix/get/clx_transacao' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "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"
}

curl -X GET 'https://api.goatpay.com.br/v1/transfer-pix/get/clx_transacao' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "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

string

required

ID da transação ou externalReference.

Authorizations

X-API-Key

string

header

required

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

Path Parameters

string

required

ID do recurso (transação, cobrança, webhook, etc.)

Response

Transferência PIX criada ou consultada.

success

boolean

required

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.

Show child attributes

requestId

string

Criar transferência Listar transferências

Introdução

Webhooks

PIX

Conta

Loja

Subcontas

Consultar envio PIX

Envelope da resposta

Status em `data.status` (envio PIX)

Parâmetros de rota

Authorizations

Path Parameters

Response

​Envelope da resposta

​Status em data.status (envio PIX)

​Parâmetros de rota

Authorizations

Path Parameters

Response

Envelope da resposta

Status em `data.status` (envio PIX)

Parâmetros de rota