Consultar contexto da conta
curl --request GET \
--url https://api.alphagateway.com.br/v1/account/context \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.alphagateway.com.br/v1/account/context', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.alphagateway.com.br/v1/account/context"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.alphagateway.com.br/v1/account/context",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"message": "Contexto da conta consultado com sucesso",
"response": {
"organization": {
"id": "01961234-abcd-7000-8000-0000000000b1",
"name": "Loja Exemplo",
"environment": "PRODUCTION",
"transactionsEnabled": true
},
"apiKey": {
"fullAccess": false,
"scopes": [
"PIX_IN",
"CHECKOUT",
"WALLET"
]
},
"paymentMethods": {
"pixIn": true,
"pixOut": true,
"boleto": false
}
}
}{
"response": null,
"errors": [
"O valor da transação deve ser maior ou igual a R$1,00"
]
}{
"response": null,
"errors": [
"API key inválida ou expirada"
]
}{
"response": null,
"errors": [
"Credencial não possui permissão para esta funcionalidade, ajuste o escopo da credencial."
]
}{
"response": null,
"errors": [
"Limite de requisições excedido"
]
}{
"response": null,
"errors": [
"Erro interno"
]
}{
"response": null,
"errors": [
"Este serviço está temporariamente indisponível devido a manutenção"
]
}Conta e saldo
Consultar contexto da conta
Informa a organização dona da API Key, o ambiente (produção movimenta dinheiro de verdade; homologação é só teste), os escopos da chave e os meios de pagamento habilitados. Use antes de criar cobranças ou saques para saber em que ambiente e com que permissões a chave opera.
GET
/
v1
/
account
/
context
Consultar contexto da conta
curl --request GET \
--url https://api.alphagateway.com.br/v1/account/context \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.alphagateway.com.br/v1/account/context', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.alphagateway.com.br/v1/account/context"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.alphagateway.com.br/v1/account/context",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"message": "Contexto da conta consultado com sucesso",
"response": {
"organization": {
"id": "01961234-abcd-7000-8000-0000000000b1",
"name": "Loja Exemplo",
"environment": "PRODUCTION",
"transactionsEnabled": true
},
"apiKey": {
"fullAccess": false,
"scopes": [
"PIX_IN",
"CHECKOUT",
"WALLET"
]
},
"paymentMethods": {
"pixIn": true,
"pixOut": true,
"boleto": false
}
}
}{
"response": null,
"errors": [
"O valor da transação deve ser maior ou igual a R$1,00"
]
}{
"response": null,
"errors": [
"API key inválida ou expirada"
]
}{
"response": null,
"errors": [
"Credencial não possui permissão para esta funcionalidade, ajuste o escopo da credencial."
]
}{
"response": null,
"errors": [
"Limite de requisições excedido"
]
}{
"response": null,
"errors": [
"Erro interno"
]
}{
"response": null,
"errors": [
"Este serviço está temporariamente indisponível devido a manutenção"
]
}Autorizações
API Key da organização