Skip to main content
GET
/
api
/
v1
/
payment
/
list
curl -X GET 'https://api.visionwallet.com.br/api/v1/payment/list?limit=50&offset=0&status=COMPLETED' \
  -H 'X-API-Key: sua_api_key'

{
  "success": true,
  "data": {
    "payments": [
      {
        "id": "payment_abc123",
        "correlationID": "mistic_transaction_id",
        "value": 10000,
        "netValue": 9950,
        "fee": 50,
        "status": "COMPLETED",
        "description": "Pagamento de serviço",
        "createdAt": "2024-01-15T10:30:00Z",
        "updatedAt": "2024-01-15T10:35:00Z"
      }
    ],
    "pagination": {
      "total": 1,
      "limit": 50,
      "offset": 0,
      "hasMore": false
    },
    "statistics": {
      "total": 1,
      "completed": 1,
      "pending": 0,
      "totalValue": 10000,
      "totalNetValue": 9950
    }
  }
}

​
Listar Pagamentos

Liste todas as transações de pagamento do usuário com opções de filtro e paginação. 
curl -X GET 'https://api.visionwallet.com.br/api/v1/payment/list?limit=50&offset=0&status=COMPLETED' \
  -H 'X-API-Key: sua_api_key'

{
  "success": true,
  "data": {
    "payments": [
      {
        "id": "payment_abc123",
        "correlationID": "mistic_transaction_id",
        "value": 10000,
        "netValue": 9950,
        "fee": 50,
        "status": "COMPLETED",
        "description": "Pagamento de serviço",
        "createdAt": "2024-01-15T10:30:00Z",
        "updatedAt": "2024-01-15T10:35:00Z"
      }
    ],
    "pagination": {
      "total": 1,
      "limit": 50,
      "offset": 0,
      "hasMore": false
    },
    "statistics": {
      "total": 1,
      "completed": 1,
      "pending": 0,
      "totalValue": 10000,
      "totalNetValue": 9950
    }
  }
}

​
Parâmetros

​
status
string
Filtrar por status: PENDING, ACTIVE, COMPLETED, FAILED.
​
limit
integer
default:"50"
Número máximo de resultados a retornar (máximo 100).
​
offset
integer
default:"0"
Número de resultados a pular (para paginação).

​
Campos da Resposta

​
payments
array
Lista de transações de pagamento.
​
pagination
object
Informações de paginação incluindo total de registros e se há mais páginas.
​
statistics
object
Estatísticas resumidas dos pagamentos, incluindo totais por status e valores.

​
Permissões Necessárias

Esta rota requer a permissão read:payments.

​
Rate Limiting

  • 10 req/s (600 req/min) por API Key
Esta rota possui cache de 60 segundos para melhorar a performance.

Authorizations

​
X-API-Key
string
header
required

API Key para autenticação. Use o header X-API-Key ou Authorization: Bearer {api_key}

Query Parameters

​
status
enum<string>

Filtrar por status

Available options:
PENDING,
ACTIVE,
COMPLETED,
FAILED
​
limit
integer
default:50

Número máximo de resultados

Required range: x <= 100
​
offset
integer
default:0

Número de resultados a pular

Response

200 - application/json

Lista de pagamentos

​
success
boolean
​
data
object