Obter transferência
curl --request GET \
--url https://api.upag.io/v1/transfers/{transferId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.upag.io/v1/transfers/{transferId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://api.upag.io/v1/transfers/{transferId}';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));Transferências Pix
Obter transferência
Consulta uma transferência pelo ID
GET
https://api.upag.io
/
v1
/
transfers
/
{transferId}
Obter transferência
curl --request GET \
--url https://api.upag.io/v1/transfers/{transferId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.upag.io/v1/transfers/{transferId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://api.upag.io/v1/transfers/{transferId}';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));Permissão:
Campos em Referência.
transfer.read. Apenas chave secreta (sk_…).
Os exemplos usam o sandbox (
https://api.upag.dev/v1). Em produção use https://api.upag.io/v1 com sk_live_….Endpoint
curl https://api.upag.dev/v1/transfers/770e8400-e29b-41d4-a716-446655440000 \
-H "Authorization: Bearer sk_test_your_api_key"
import { Upag } from 'upag';
const upag = new Upag('sk_test_your_api_key');
const transfer = await upag.transfers.retrieve('770e8400-e29b-41d4-a716-446655440000');
Parâmetros
string (uuid)
required
ID da transferência.
Resposta
200 OK. Diferente da criação, não traz transaction.
Response
{
"id": "770e8400-e29b-41d4-a716-446655440000",
"status": "completed",
"direction": "out",
"type": "key",
"amount": 10000,
"pixKey": "55ce1aae-0d2b-4d76-bc77-294d6407349e",
"pixKeyType": "random",
"from": {
"name": "Acme LTDA",
"taxNumber": "12345678000199",
"bankName": "Upag"
},
"to": {
"name": "Maria Receiver",
"taxNumber": "111.444.777-35",
"bankName": "FitBank"
},
"endToEndId": "E12345678202603181200000000000000",
"providerTransactionId": "555",
"url": null,
"createdAt": "2026-03-18T12:00:00.000Z",
"updatedAt": "2026-03-18T12:01:00.000Z"
}
Erros
| Status | Mensagem | Causa |
|---|---|---|
404 | Transfer not found | Transferência inexistente ou de outra conta |
422 | VALIDATION_FAILED | transferId não é UUID |