Desativar um pagador

Siga nosso passo a passo para desativar um pagador.

Desativar pagador

1 - Para iniciar você já precisa estar logado no Internet Banking

❗️

lembre-se de sempre enviar uid, access-token e client no cabeçalho da requisição

CHAVEVALORDESCRIÇÃO
uid[email protected]identificador unico
access-tokenZ_eOiMQwaRaGN14Iw8r0iQtoken de acesso
client892RXGrwWaEC96QoQp5Dcgtoken do cliente

endpoint: https://base_url/bills/people/:person_id/active

verbo http POST

base_url será substituida pela URL da sua empresa, exemplo: cwdev.ib.hmg.cashway.io/api/v3

:person_id será substituida pelo ID do pagador a ser desativado

Corpo da requisição

{
    "payer": {
        "active": false
    }
}

2 - Se tudo ocorrer bem, você receberá uma resposta com Status 200 OK

Corpo da resposta com sucesso:

{
    "id": 33150,
    "name": "Payer Teste",
    "document": "86438279080",
    "created_at": "15/10/2021",
    "updated_at": "15/10/2021",
    "city": "Florianópolis",
    "state": "SC",
    "street": "Rod. José Carlos Daux",
    "number": 5500,
    "zip_code": "88032005",
    "district": "Saco Grande",
    "email": "[email protected]",
    "phone": "",
    "complement": null,
    "active": false,
    "groups": [],
    "errors": []
}

📘

Execute um teste em nosso sandbox aqui