Excluir pagador.

DELETE

/customers/{customerId}

Pagadores

Remove um pagador do cadastro da conta.

Se ele estiver vinculado a cobranças que impedem a exclusão, a API recusa a operação.

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 de Caminho

Parâmetros Header

🟢200

application/json

Excluído

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

🟠409

🟠422

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE '/customers/' \
--header 'x-account-id;'

Response Example

200 - Exemplo 1

{
    "success": true
}