Skip to main content
GET/transfer-pix/list

Parâmetros de consulta

pageinteger

Número da página. Padrão 1.

pageSizeinteger

Quantidade de itens. Padrão 50, máximo 100.

Autorização

X-API-Keystringrequired

Chave VibeCash com permissão para esta operação.

Resposta

200 application/json
successbooleanrequired

Indica se a operação foi concluída pela API.

messagestringrequired

Mensagem da operação.

dataobjectrequired

Dados retornados pela operação.

Show child attributes
itemsarray

Itens da consulta.

totalinteger

Quantidade de itens, quando a rota oferece paginação.

pageinteger

Página atual.

pageSizeinteger

Itens por página.

requestIdstring

Identificador da requisição.

netAmount mantém o total debitado da carteira por compatibilidade. Use recipientAmount para o valor recebido pelo destinatário e totalDebit para o custo total.

Erros

As falhas retornam o envelope com success: false. Consulte erros e códigos HTTP para interpretar validação, permissão, conflito e saldo insuficiente.

curl --request GET \
  --url 'https://seu-dominio/v1/transfer-pix/list' \
  --header 'X-API-Key: tp_live_SUA_CHAVE'
{
  "success": true,
  "message": "Operação concluída",
  "data": {
    "items": [
      {
        "id": "out_exemplo",
        "amount": 5,
        "feeAmount": 0.1,
        "netAmount": 5.1,
        "recipientAmount": 5,
        "totalDebit": 5.1,
        "status": "PROCESSING",
        "createdAt": "2026-11-10T15:00:00.000Z"
      }
    ],
    "total": 1,
    "page": 1,
    "pageSize": 50,
    "pages": 1
  },
  "requestId": "req_exemplo"
}

Pesquisar documentação

GET

Listar envios PIX

Liste as transferências PIX da sua carteira.

Authorization
Query