Recarga automática

Recarga automática do saldo: quando o saldo fica abaixo de um limite, o valor configurado é debitado do meio de pagamento cadastrado. Disponível em Apenas API v2 — não há uma versão equivalente na v1.

Requer que o recurso esteja ativado no servidor. Quando está desativado, ambos os endpoints retornam Auto top-up is not available.

Ponto final:

Essa solicitação retorna a configuração atual da recarga automática e o resultado do último acionamento.

GEThttps://proxy-seller.com/personal/api/v2/{YourApiKey}/balance/autotopup/get

Parâmetros de caminho

Nome	Valor	Descrição
Autorização	`<Your_API_Key>`	Sua chave de API pessoal (Como chegar)

Exemplo

https://proxy-seller.com/personal/api/v2/fj4948ffhg58gh843gh/balance/autotopup/get

Resposta

{
    "status": "success",
    "data": {
        "configured": true,
        "enabled": true,
        "state": "ACTIVE",
        "threshold": 10,
        "amount": 25,
        "subscriptionId": "sub_01hx9k2m4p",
        "paymentMethod": {
            "id": "sub_01hx9k2m4p",
            "status": "active",
            "paymentMethod": "card",
            "brand": "visa",
            "last4": "1234",
            "exp": "05/2027"
        },
        "dailyCountCap": 5,
        "monthlyAmountCap": 500,
        "failCount": 0,
        "lastAttemptAt": "2026-08-14T09:12:44.000+00:00",
        "lastEvent": {
            "status": "SUCCEEDED",
            "amount": 25,
            "at": "2026-08-14T09:12:46.000+00:00",
            "reason": null
        }
    },
    "errors": []
}

{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "Auto top-up is not available",
            "code": 49,
            "customData": null
        }
    ]
}

{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "Error api key",
            "code": 503,
            "customData": null
        },
        {
            "message": "IP not allowed",
            "code": 503,
            "customData": null
        },
        {
            "message": "Request limit reached",
            "code": 503,
            "customData": null
        }
    ]
}

Alterar configurações

Ponto final:

Esta solicitação atualiza a configuração de recarga automática. Atualização parcial: qualquer campo que você omitir mantém o valor armazenado; portanto, para alterar apenas o limite, basta enviar threshold.

POSThttps://proxy-seller.com/personal/api/v2/{YourApiKey}/balance/autotopup/set

Parâmetros de caminho

Nome	Valor	Descrição
Autorização	`<Your_API_Key>`	Sua chave de API pessoal (Como chegar)

Corpo da solicitação

Nome	Tipo	Descrição
ativado	Booleano	Ativar ou desativar a recarga automática
limiar	Número	Carregue quando o saldo ficar abaixo desse valor. Mínimo `1`
valor	Número	Valor de uma única recarga. Mínimo `5`, e deve ser maior ou igual a `threshold`
subscriptionId	String	Forma de pagamento a ser cobrada, proveniente de `paymentMethod.id`. Opcional, desde que haja apenas um cartão disponível
dailyCountCap	Número	Seu próprio limite mais restritivo de recargas por 24 horas. Mínimo `1`
limite do valor mensal	Número	Seu próprio limite para o valor total a cada 30 dias. Deve ser maior ou igual a `amount`

Exemplo

https://proxy-seller.com/personal/api/v2/fj4948ffhg58gh843gh/balance/autotopup/set

Resposta

{
    "status": "success",
    "data": {
        "configured": true,
        "enabled": true,
        "state": "ACTIVE",
        "threshold": 10,
        "amount": 25,
        "subscriptionId": "sub_01hx9k2m4p",
        "paymentMethod": {
            "id": "sub_01hx9k2m4p",
            "status": "active",
            "paymentMethod": "card",
            "brand": "visa",
            "last4": "4242",
            "exp": "05/2027"
        },
        "dailyCountCap": 5,
        "monthlyAmountCap": 500,
        "failCount": 0,
        "lastAttemptAt": null,
        "lastEvent": {
            "status": "SETTINGS_SAVED",
            "amount": null,
            "at": "2026-08-14T10:03:11.000+00:00",
            "reason": "enabled: false -> true"
        }
    },
    "errors": []
}

{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "Top-up amount must be #min_amount# or more",
            "code": 51,
            "customData": {
                "minAmount": 5
            }
        }
    ]
}

{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "Top-up amount must cover the threshold, otherwise it will trigger again",
            "code": 52,
            "customData": null
        }
    ]
}

{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "Auto top-up requires a saved payment method",
            "code": 53,
            "customData": null
        }
    ]
}

{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "Your saved card has expired — update it to enable auto top-up",
            "code": 56,
            "customData": null
        }
    ]
}

{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "Threshold must be #min_threshold# or more",
            "code": 50,
            "customData": {
                "minThreshold": 1
            }
        }
    ]
}

As execuções de validação são realizadas em relação ao fundido resultado, e não apenas em relação à solicitação. Envio threshold por si só ainda é rejeitado se o valor armazenado amount fica abaixo do novo limite.
A pausa após uma série de tentativas malsucedidas só é cancelada quando enabled: true é enviada explicitamente. A edição de outros campos em uma configuração pausada mantém a pausa ativa.
Os limites efetivos também se aplicam quando o usuário define “nenhum”: 5 recarregamentos a cada 24 horas e 500 a cada 30 dias corridos.

Ponto final:

Parâmetros de caminho

Exemplo

Resposta

Alterar configurações

Ponto final:

Parâmetros de caminho

Corpo da solicitação

Exemplo

Resposta

On this page