Wallet REST

Liste as wallets do cliente autenticado e explore as transações de cada uma.

Visão Geral

As APIs de Wallet permitem que uma aplicação leia as wallets do cliente autenticado e o respetivo histórico de transações. Liste todas as wallets com os seus saldos através do endpoint wallets e, em seguida, percorra os movimentos de uma única wallet através do endpoint transactions. Todos os endpoints são chamadas REST padrão e requerem o âmbito OAuth2 payment.

REST API

Estas são APIs REST padrão que utilizam métodos HTTP (GET). Todos os pedidos requerem o cabeçalho Deriv-App-ID: YOUR_APP_ID e um token Authorization: Bearer YOUR_OAUTH_TOKEN com o âmbito payment.

Especificação OpenAPI

Consulte a especificação OpenAPI completa para definições de esquema detalhadas e exemplos:

OpenAPI Spec →

Fluxo de Trabalho Típico

Liste as wallets do cliente com GET /wallet/v1/wallets. Cada entrada apresenta os seus saldos na moeda nativa da wallet; forneça conversion_currency para receber também um total convertido.
Obtenha os movimentos de uma wallet com GET /wallet/v1/transactions/{wallet_type}. Os resultados são paginados por cursor; siga links.next e links.prev para os percorrer.

Endpoints Disponíveis

Lista de WalletsGet

Devolve as wallets pertencentes ao cliente autenticado, com cada saldo apresentado na moeda nativa da wallet. Forneça um conversion_currency para receber também cada saldo convertido nessa moeda e utilize start_date_time e end_date_time para delimitar a janela do saldo./wallet/v1/wallets

Transações de WalletGet

Devolve uma lista paginada por cursor das transações de uma das wallets do cliente autenticado, identificada por wallet_type. Filtre por request_id, transaction_currency e um intervalo de datas. Cada linha apresenta um channel que mostra como o dinheiro se movimentou e uma category calculada em relação a quem faz a chamada./wallet/v1/transactions/{wallet_type}

Autenticação

Todos os endpoints requerem o cabeçalho Deriv-App-ID e um cabeçalho Authorization: Bearer YOUR_OAUTH_TOKEN. O token deve ter o âmbito payment; caso contrário, a API devolve 403 Forbidden.

Âmbitos OAuth2

Endpoint	Permissão
`GET /wallet/v1/wallets`	`payment`
`GET /wallet/v1/transactions/{wallet_type}`	`payment`

1curl -X GET "https://api.derivws.com/wallet/v1/wallets?conversion_currency=USD" \
2  -H "Deriv-App-ID: YOUR_APP_ID" \
3  -H "Authorization: Bearer YOUR_OAUTH_TOKEN"

Códigos de Estado da Resposta

A API usa códigos de estado HTTP padrão para indicar sucesso ou falha:

2xx Sucesso

200 OK — Pedido bem-sucedido

Erros 4xx/5xx

400 Bad Request — Parâmetros inválidos

401 Unauthorized — Autenticação inválida ou em falta

403 Forbidden — O token não possui o âmbito payment

404 Not Found — Wallet não encontrada

500 Internal Server Error — Erro do lado do servidor

503 Service Unavailable — Pedido rejeitado pelo disjuntor do gateway

504 Gateway Timeout — Timeout de serviço upstream

Formato de Resposta de Erro

Todas as respostas de erro seguem um envelope consistente com um array errors. Cada entrada contém um status numérico, um code legível por máquina e uma message legível por humanos:

1{
2  "errors": [
3    {
4      "status": 400,
5      "code": "BadRequest",
6      "message": "conversion_currency must be a 3-letter ISO currency code"
7    }
8  ]
9}

Os códigos de erro incluem: BadRequest, Unauthorized, NotFound, InternalServerError

Estado de Levantamento Lista de Wallets

Alguma outra questão? Entrar em contacto