Skip to main content
A Loja representa sua conta na AobaPay, contendo todas as informações essenciais sobre seu negócio e saldos disponíveis.

​
Estrutura

Uma loja é representada em nossa API pela seguinte estrutura: 
{
    "error": null,
    "status": 200,
    "data": {
        "accountID": "8918291298891829",
        "taxID": "12345678000199",
        "name": "AOBA PAY LTDA",
        "fee": 78,
        "balance": {
            "total": 127152,
            "available": 0,
            "blocked": 0
        }
    }
}

​
Atributos:

{
  "accountID": "8918291298891829",
}
accountID : string.
Identificador único da sua loja na AobaPay
{
  "fee": "78",
}
fee : string.
Identificador da taxa da conta
{
  "name": "AOBA PAY LTDA",
}
officialName : string.
Nome da sua loja/empresa
{
  "balance": {
      "total": 127152,
      "available": 0,
      "blocked": 0
  }
}
balance : object.
Objeto contendo informações sobre os saldos da sua conta
  • total : number.
    Saldo total
  • available : number.
    Saldo disponível
  • blocked : number.
    Saldo bloqueado em disputas em centavos
Todos os valores de saldo são retornados em centavos. Para converter para reais, divida por 100. Por exemplo: 15000 centavos = R$ 150,00
O saldo bloqueado representa valores que estão em disputa ou sob análise. Estes valores não estão disponíveis para saque até que a situação seja resolvida.