Criar pagador.

POST

/customers

Pagadores

Cadastra um pagador (customer) para usar nas cobranças da conta.

Informe os dados pessoais ou empresariais do pagador. O id retornado entra no body da invoice.

Requisição

Authorization

OAuth 2.0

Client Credentials

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Token URL: /oauth/token

Scopes:

invoices.write-Permite criar, alterar ou cancelar cobranças/faturas

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201

application/json

Criado

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

🟠409

🟠422

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location '/customers' \
--header 'x-account-id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "email": "user@example.com",
    "phone": "string",
    "document": "stringstrin",
    "address": {
        "address": "string",
        "number": "string",
        "complement": "string",
        "district": "string",
        "city": "string",
        "zipCode": "stringst",
        "uf": "st"
    }
}'

Response Example

201 - Exemplo 1

{
    "id": 0,
    "accountId": 0,
    "name": "string",
    "email": "string",
    "phone": "string",
    "document": "string",
    "address": {
        "address": "string",
        "number": "string",
        "complement": "string",
        "district": "string",
        "city": "string",
        "zipCode": "stringst",
        "uf": "st"
    },
    "addresses": [
        {
            "address": "string",
            "number": "string",
            "complement": "string",
            "district": "string",
            "city": "string",
            "zipCode": "stringst",
            "uf": "st"
        }
    ]
}

Página anterior

Consultar TED por chave de idempotência.

Próxima página

Listar pagadores.