Criar Pagamento de Tributo

post

https://{apiHost}/v2/payment/taxes

Pré-requisitos

Para emitir um pagamento é necessário ter uma Conta Financeira, informada em financial_account_uid. A conta de pagamento que registra a operação é definida em payment_account_uid; se omitida, usa-se a mais antiga vinculada à conta financeira; se informada, deve pertencer à financial_account_uid.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Novo Pagamento de Tributo.

amount

float

required

Quantia

scheduled_to

date | null

Data de Agendamento

financial_account_uid

uuid

required

UID da Conta Financeira de Origem

payment_account_uid

uuid | null

Conta de pagamento de origem (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à financial_account_uid.

external_id

string | null

ID no seu sistema. Opcional para controle interno.

custom_data

object | null

Hash com chave e valor no formato JSON.

tags

kind

string

enum

required

Tipo do Tributo

format

string

enum

Defaults to code

Formato do tributo.

code: Informar código de barras/linha digitável (padrão).
data: Informar campos estruturados (disponível para kinds: darf, gru, gps, fgts).

Allowed:

code

string | null

Código de Barras ou Linha Digitável do Tributo. Obrigatório quando format=code.

data

Campos estruturados do tributo. Obrigatório quando format=data.

Headers

User-Agent

string

Informar um e-mail válido para contatos.

Responses

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Pagamento criado com format=data (DARF)

401Falha de autenticação. Token inválido

422Parâmetros inválidos