Como acessar saldo e detalhes de uma Subconta via API?
info
Para a utilização desta funcionalidade é necessário possuir a funcionalidade Subconta
Para acessar o saldo e detalhes de uma subconta, você utiliza o endpoint /api/v1/subaccount/{ID}
da API.
Você pode acessar aqui a documentação referente a esse endpoint.
A chave pix registrada na subconta deve ser passada na url da requisição como parâmetro.
Após efetuar a requisição, se tudo ocorreu bem, o status code da requisição será 2xx
e no body
da resposta, uma objeto contendo os campos de balance, name, pixKey da subconta requisitada.
Exemplos em código
- Shell + cURL
- JavaScript + Fetch
curl 'https://api.openpix.com.br/api/v1/subaccount/chave-pix-subconta -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "user-agent: node-fetch" \
-H "Authorization": "app_id"
fetch('https://api.openpix.com.br/api/v1/subaccount/chave-pix-subconta', {
method: 'GET',
headers: {
Authorization: 'AUTHORIZATION',
'Content-Type': 'application/json',
},
}).then((res) => res.json());
Exemplos de resposta
{
"SubAccount": {
"name": "test-sub-account",
"pixKey": "c4249323-b4ca-43f2-8139-8232aab09b93",
"balance": 100
}
}