GET

Consultar Pagamento PIX-Out (A55)

Consulta o status de um pagamento PIX-Out realizado via A55. O endpoint aceita três tipos de consulta:

withdrawId (preferência máxima) — busca o saque no banco interno e utiliza os dados vinculados (endToEndId ou tid) para consultar a A55
endToEndId — consulta direta na A55 usando o identificador E2E
tid — consulta direta na A55 usando o TID

Importante: Apenas um parâmetro deve ser enviado por vez.

Esse endpoint retorna exatamente o payload bruto da A55, sem filtros ou transformação — útil para conferência, reconciliação e auditoria.

Endpoint

GET https://api.splitgames.com.br/api/A55/pix-out/consult?withdrawId=97

GET https://api.splitgames.com.br/api/A55/pix-out/consult?endToEndId=E123...

GET https://api.splitgames.com.br/api/A55/pix-out/consult?tid=wld-00000011

Headers

Header	Obrigatório	Descrição
X-Client-Id	Sim	Client ID do aplicativo
X-API-Key	Sim	Secret Key da empresa
Accept	Sim	application/json

🔐 Não é necessário enviar Idempotency-Key, CompanyId, UserId ou UserRole.

Query Parameters

Campo	Tipo	Obrigatório	Descrição
withdrawId	integer	Condicional	ID interno do saque. O sistema busca o saque no banco e utiliza o endToEndId ou tid vinculado para consultar a A55. Retorna dados contextuais adicionais.
endToEndId	string	Condicional	Identificador único do pagamento (E2E). Consulta direta na A55 usando este identificador.
tid	string	Condicional	Transaction ID da A55. Consulta direta na A55 usando este identificador.

⚠️ Apenas UM dos três parâmetros deve ser enviado por vez: withdrawId, endToEndId ou tid.

Exemplo de Requisição (cURL) — usando withdrawId

bash

curl -X GET 'https://api.splitgames.com.br/api/A55/pix-out/consult?withdrawId=97' \
  -H 'Accept: application/json' \
  -H 'X-Client-Id: e1c98954cc404cbcb2868af9b40c7a33' \
  -H 'X-API-Key: 95B0Al6yhKkhswGgigmkfiPem0dhImgR0wIJOfLitgOPOaRmRgbu9Odybo_t_s-3vr7JMgysbyg-nhpWHZJh0g'

Exemplo de Requisição (cURL) — usando endToEndId

bash

curl -X GET 'https://api.splitgames.com.br/api/A55/pix-out/consult?endToEndId=E4875612120251111224078gb6XcMZ0e' \
  -H 'Accept: application/json' \
  -H 'X-Client-Id: e1c98954cc404cbcb2868af9b40c7a33' \
  -H 'X-API-Key: 95B0Al6yhKkhswGgigmkfiPem0dhImgR0wIJOfLitgOPOaRmRgbu9Odybo_t_s-3vr7JMgysbyg-nhpWHZJh0g'

Exemplo de Requisição (cURL) — usando tid

bash

curl -X GET 'https://api.splitgames.com.br/api/A55/pix-out/consult?tid=wld-00000011' \
  -H 'Accept: application/json' \
  -H 'X-Client-Id: e1c98954cc404cbcb2868af9b40c7a33' \
  -H 'X-API-Key: 95B0Al6yhKkhswGgigmkfiPem0dhImgR0wIJOfLitgOPOaRmRgbu9Odybo_t_s-3vr7JMgysbyg-nhpWHZJh0g'

Resposta de Sucesso (200 OK) — usando withdrawId

Quando withdrawId é usado, a resposta inclui dados contextuais além do payload da A55:

json

{
  "provider": "a55",
  "queriedBy": "endToEndId",
  "withdrawId": 97,
  "endToEndId": "E4875612120251111224078gb6XcMZ0e",
  "response": [
    {
      "status": 2,
      "endToEndId": "E4875612120251111224078gb6XcMZ0e",
      "tid": "wld-00000011",
      "pagamentoIndiretoId": "710c3364-5be5-459e-8ca4-6b559e3bc2b3",
      "chavePix": "50651470862",
      "valor": 57.00,
      "correntista": {
        "nome": "XIS AG SOLUCOES E PAGAMENTOS E TECH LTDA",
        "documento": "48969523000177",
        "conta": {
          "ispb": "48756121",
          "agencia": "1",
          "numero": "000091168",
          "tipo": 0
        }
      },
      "contraparte": {
        "nome": "ANGELO ALVES DE MARCHI",
        "documento": "50651470862",
        "conta": {
          "ispb": "22896431",
          "agencia": "1",
          "numero": "885875818",
          "tipo": 3
        }
      },
      "confirmadoEmUtc": "2025-11-11T22:40:32.889501+00:00",
      "efetivacaoRealizadaEmUtc": "2025-11-11T22:40:36.165682+00:00",
      "debitoProtocolo": "E4875612120251111224078gb6XcMZ0e",
      "id": "c1c432c6-37ca-4ae9-a4de-dcb400972902"
    }
  ]
}

Resposta de Sucesso (200 OK) — usando endToEndId ou tid

Quando endToEndId ou tid são usados diretamente, retorna apenas o payload bruto da A55:

json

{
  "provider": "a55",
  "body": [
    {
      "status": 2,
      "endToEndId": "E4875612120251111224078gb6XcMZ0e",
      "tid": "wld-00000011",
      "pagamentoIndiretoId": "710c3364-5be5-459e-8ca4-6b559e3bc2b3",
      "chavePix": "50651470862",
      "valor": 57.00,
      "correntista": {
        "nome": "XIS AG SOLUCOES E PAGAMENTOS E TECH LTDA",
        "documento": "48969523000177",
        "conta": {
          "ispb": "48756121",
          "agencia": "1",
          "numero": "000091168",
          "tipo": 0
        }
      },
      "contraparte": {
        "nome": "ANGELO ALVES DE MARCHI",
        "documento": "50651470862",
        "conta": {
          "ispb": "22896431",
          "agencia": "1",
          "numero": "885875818",
          "tipo": 3
        }
      },
      "confirmadoEmUtc": "2025-11-11T22:40:32.889501+00:00",
      "efetivacaoRealizadaEmUtc": "2025-11-11T22:40:36.165682+00:00",
      "debitoProtocolo": "E4875612120251111224078gb6XcMZ0e",
      "id": "c1c432c6-37ca-4ae9-a4de-dcb400972902"
    }
  ]
}

Exemplo de Erro (withdrawId sem E2E ou TID)

json

{
  "message": "Saque localizado, mas não possui endToEndId ou TID vinculado para consulta na A55."
}

Exemplo de Erro (Pagamento não encontrado)

json

{
  "message": "Pagamento não encontrado na A55."
}

Possíveis Erros

Status	Motivo
400	Nenhum parâmetro enviado ou múltiplos parâmetros enviados simultaneamente
401	ClientId ou API Key inválidos
404	Pagamento ou saque não localizado
422	Saque encontrado mas sem endToEndId ou TID vinculado
500	Erro interno ao consultar a A55

Notas importantes

withdrawId = consulta usando dados internos do banco. Se o saque existir e possuir endToEndId ou TID, a consulta é feita automaticamente na A55.
endToEndId ou tid = consulta direta na A55 sem buscar dados internos.
A resposta SEMPRE contém o payload bruto da A55 sem filtros ou transformações (campo response ou body).
A consulta sempre retorna um array, pois a A55 envia lista mesmo quando há apenas 1 resultado.
O campo status segue o padrão A55:
- 1 = Criado
- 2 = Confirmado / Efetivado
- 3 = Estornado
Não é necessário enviar idempotency key para consultas.