Consultar o lote

GEThttps://{apiUrl}/pixout/transfer/{batch_id}

Atualizado em 21 de janeiro de 2025 · 2 min de leitura

Endpoint: GET https://{apiUrl}/pixout/transfer/{batch_id}

Consulta todas as transferências de um lote Pixout, incluindo status individual de cada uma.

Parâmetros

GEThttps://{apiUrl}/pixout/transfer/{batch_id}

URL base da API

Token de autenticação

Path Params

batch_idstringrequired

Identificador do lote gerado ao solicitar a transferência

curl --request GET \
  --url "https://{apiUrl}/pixout/transfer/{batch_id}"

Response

Choose an example:

application/json

Exemplo de resposta

json

{
  "batch_id": "lote-uuid-aqui",
  "total": 2,
  "created_at": "2024-10-01T15:36:00Z",
  "transfers": [
    {
      "id": "transferencia-1-uuid",
      "status": "done",
      "value": 150.00,
      "key": "joao@exemplo.com",
      "key_type": "EMAIL",
      "name": "João da Silva"
    },
    {
      "id": "transferencia-2-uuid",
      "status": "error",
      "value": 200.00,
      "key": "11111111111",
      "key_type": "CPF",
      "name": "Maria Santos"
    }
  ]
}

Campos da resposta

batch_idstring

UUID do lote consultado

totalinteger

Total de transferências no lote

created_atstring

Data de criação do lote no formato ISO 8601

transfersarray

Lista de transferências do lote

transfers[].idstring

UUID da transferência individual

transfers[].statusstring

Estado: pending, processing, done ou error

transfers[].valuefloat

Valor da transferência em reais

transfers[].keystring

Chave Pix do destinatário

transfers[].key_typestring

Tipo da chave: CPF, CNPJ, EMAIL, PHONE ou EVP

transfers[].namestring

Nome do destinatário

Esta página foi útil?