Criar um pagador

Criar 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

CHAVE	VALOR	DESCRIÇÃO
uid	[email protected]	identificador unico
access-token	Z_eOiMQwaRaGN14Iw8r0iQ	token de acesso
client	892RXGrwWaEC96QoQp5Dcg	token do cliente

endpoint: https://base_url/bills/people

verbo http POST

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

Corpo da requisição

{
    "payer": {
        "name": "Payer Teste",             // Número de documento do pagador
        "kind": "1",                       // Tipo do documento (0 - Física/ 1 - Jurídica)
        "document": "99999999999",         // Documento do pagador
        "city": "Florianópolis",           // Cidade do pagador
        "state": "SC",                     // UF do pagador
        "zip_code": "88888888",            // CEP
        "district": "Saco Grande",         // Bairro/Setor
        "number": "5500",                  // Número do endereço
        "street": "Rod. José Carlos Daux", // Logradouro do pagador
        "email": "[email protected]",        // Não obrigatório
        "phone": "",                       // Telefone de contato. Não obrigatório
        "groups": [1]
    }
}

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

Corpo da resposta com sucesso:

{
    "id": 31710,
    "name": "Payer Teste",
    "document": "99999999999999",
    "created_at": "19/08/2021",
    "updated_at": "19/08/2021",
    "city": "Florianópolis",
    "state": "SC",
    "street": "Rod. José Carlos Daux",
    "number": 5500,
    "zip_code": "88888888",
    "district": "Saco Grande",
    "email": "[email protected]",
    "phone": "",
    "complement": null,
    "active": true,
    "groups": [
        {
            "id": 1,
            "name": "Global SA"
        }
    ],
    "errors": []
}

📘
Execute um teste em nosso sandbox aqui