Skip to main content
GET
/
transfer-pix
/
list
curl -X GET 'https://api.goatpay.com.br/v1/transfer-pix/list?page=1&pageSize=50' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Transferências PIX listadas",
  "data": {
    "items": [
      {
        "id": "clx_pix_out",
        "type": "PIX_OUT",
        "status": "COMPLETED",
        "amount": 50,
        "feeAmount": 2,
        "netAmount": 52,
        "coverFee": true,
        "currency": "BRL",
        "pixKey": "12345678909",
        "pixKeyType": "CPF",
        "description": "Saque PIX",
        "referenceId": "ref_out_xyz",
        "endToEndId": "E12345678202505301234567890123456",
        "completedAt": "2026-06-01T13:05:00.000Z",
        "createdAt": "2026-06-01T13:00:00.000Z"
      }
    ],
    "page": 1,
    "pageSize": 50,
    "total": 0,
    "pages": 1
  },
  "requestId": "req_abc"
}

curl -X GET 'https://api.goatpay.com.br/v1/transfer-pix/list?page=1&pageSize=50' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Transferências PIX listadas",
  "data": {
    "items": [
      {
        "id": "clx_pix_out",
        "type": "PIX_OUT",
        "status": "COMPLETED",
        "amount": 50,
        "feeAmount": 2,
        "netAmount": 52,
        "coverFee": true,
        "currency": "BRL",
        "pixKey": "12345678909",
        "pixKeyType": "CPF",
        "description": "Saque PIX",
        "referenceId": "ref_out_xyz",
        "endToEndId": "E12345678202505301234567890123456",
        "completedAt": "2026-06-01T13:05:00.000Z",
        "createdAt": "2026-06-01T13:00:00.000Z"
      }
    ],
    "page": 1,
    "pageSize": 50,
    "total": 0,
    "pages": 1
  },
  "requestId": "req_abc"
}

​
Parâmetros de query

​
page
number
Número da página (padrão 1).
​
pageSize
number
Itens por página (padrão 50, máximo 100).
​
dateFrom
string
ISO 8601 — início do período (createdAt).
​
dateTo
string
ISO 8601 — fim do período (createdAt).
​
status
string
PENDING, PROCESSING, COMPLETED, FAILED, CANCELED ou REVERSED.
​
externalReference
string
Filtro exato pela referência externa.
​
search
string
Busca parcial em id, description, externalReference, endToEndId, referenceId e pixKey.

Authorizations

​
X-API-Key
string
header
required

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

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
pageSize
integer
default:50
Required range: 1 <= x <= 100
​
dateFrom
string<date-time>
​
dateTo
string<date-time>
​
status
enum<string>
Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED,
CANCELED,
REVERSED
​
externalReference
string
​
search
string

Busca parcial em id, description, externalReference, endToEndId, referenceId e pixKey.

Response

Lista paginada de transações.

​
success
boolean
required
​
message
string
required
​
data
object
required
​
requestId
string