Sign in

v1

latestOpenAPI 3.1.02026-07-248556265.4 KB
Cobranças

Criar cobrança

post/charges

Headers

User-Agentstring
Example:Empresa X (contato@empresax.com)

Todas as requests para a API da Transfeera deve conter o Header "User-Agent". Use este Header para nos dizer qual o nome da sua empresa e um e-mail para contato

Request body

payment_methodsstring[] required
amountinteger required

Valor da cobrança

fine_amountinteger

Valor da multa

fine_percentnumber float

Percentual da multa

fine_type'fixed' | 'percentage'

Tipo da multa

interest_amountinteger

Valor dos juros

interest_percentnumber float

Percentual dos juros

interest_type'fixed_per_day' | 'fixed_per_working_day' | 'percentage_per_month' | 'percentage_per_month_working_days'

Tipo dos juros

discount_amountinteger

Valor do desconto

discount_percentnumber float

Percentual do desconto

discount_type'fixed_until_informed_dates' | 'percentage_until_informed_dates' | 'fixed_per_anticipated_day' | 'fixed_per_anticipated_working_day' | 'percentage_per_anticipated_day' | 'percentage_per_anticipated_working_day'

Tipo do desconto

due_datestring date-time required

Data do vencimento

expiration_datestring date required

Data de expiração da cobrança

descriptionstring

Descrição

external_idstring

ID externo para integração

Response

Created response

idstring uuid

ID da cobrança

payment_methodsstring[]
external_idstring

ID externo para integração

created_atstring date-time

Data de criação da cobrança

updated_atstring date-time

Data de atualização da cobrança