Dar baixa em pagamento

POSThttps://api.sandbox.cefispay.com.br/api/v1/payment/{id}/write-off

Marca um pagamento como pago. Utilize esta opção para registrar na NinePay um pagamento que foi feito fora do sistema, como por exemplo, um pagamento em dinheiro ou transferência bancária. Após ser marcado como pago, o cliente não receberá mais cobranças referentes a este pagamento.

Parâmetros de path

idintegerobrigatório
O id do pagamento a ser cancelado

Parâmetros do body

application/json

Descreve os dados a serem incluídos no corpo da requisição.

valueTypestring
- normal: Mantém o valor do pagamento
- zero: Zera o valor do pagamento (não será somado aos gráficos de faturamento)
Valores permitidos:normalzero

Respostas

200Pagamento baixado com sucesso

Corpo da resposta

application/json

idstring
O ID do pagamento.
uuidstring
O UUID do pagamento.
customer_idstring
O ID do cliente do pagamento.
customerobject
O cliente do pagamento.
subscription_idstring
O ID da assinatura do pagamento.
subscriptionobject
A assinatura do pagamento.
payment_linkobject
O link de pagamento.
itemsarray
Os itens do pagamento.
allowed_methodsarray de strings
Os métodos com que o cliente pode pagar este pagamento.
Valores permitidos:creditbilletpix
methodstring
- credit: Cartão de crédito. - debit: Cartão de débito. - billet: Boleto. - pix: Pix. - payment_initiation: Iniciação de pagamento via Open Finance. - manual: Baixa manual, registrada pelo endpoint de dar baixa em pagamento.
Valores permitidos:creditdebitbilletpixpayment_initiationmanual
card_idstring
O ID do cartão do pagamento.
cardobject
O cartão do pagamento.
digitable_linestring
A linha digitável do boleto. Só é preenchida para o método billet.
pix_payloadstring
O código Pix copia e cola do pagamento. Só é preenchido para o método pix.
custom_dataobject
Os dados personalizados do pagamento.
valuenumber
O valor original do pagamento em centavos, sem multa e juros. Ex.: 5000 para R$50,00.
finenumber
A multa do pagamento, em valor percentual. Ex.: 2 para multa de 2% sobre o valor do pagamento vencido.
interestnumber
O juros do pagamento, em valor percentual ao mês. Ex.: 2 para 2% ao mês.
current_valuenumber
O valor a ser pago hoje, em centavos: value somado a current_fine e current_interest.
current_finenumber
O valor da multa aplicada até hoje, em centavos. É 0 enquanto o pagamento não vence.
current_interestnumber
O valor dos juros acumulados até hoje, em centavos. É 0 enquanto o pagamento não vence.
installmentsnumber
O número de parcelas do pagamento. Só se aplica ao método credit.
statusstring
- unpaid: Em aberto, aguardando pagamento. - paid: Pago. - unauthorized: Recusado. A tentativa de cobrança no cartão não foi autorizada; o pagamento continua em aberto e pode ser pago novamente. - canceled: Cancelado. - reversed: Estornado.
Valores permitidos:unpaidpaidunauthorizedcanceledreversed
retries_numbernumber
O número de tentativas do pagamento.
was_last_retryboolean
Se foi a última tentativa do pagamento.
can_refundboolean
Se o pagamento pode ser reembolsado agora. Só é true quando o status é paid e o método é credit (até 350 dias após o pagamento) ou pix (até 90 dias após o pagamento).
refundsarray de objectsPaymentRefund
Os reembolsos solicitados para o pagamento. Só é retornado no endpoint de obter detalhes do pagamento quando a requisição inclui with[]=refunds.
refunds array de objects
Ver schema PaymentRefund
receiptsarray
Os recibos do pagamento.
receipt_statusinteger
- 0: Emissão de recibo não configurada. - 1: Recibo ainda não emitido. - 2: Recibo emitido. - 3: Erro na emissão do recibo. - 4: Emissão do recibo ignorada.
Valores permitidos:01234
due_datestringdate
A data de vencimento do pagamento.
ref_datestringdate
A data de referência do pagamento.
paid_atstringdate-time
A data e hora em que o pagamento foi pago. É nula enquanto o status não é paid.
companyobject
A empresa do pagamento.
charge_enabledboolean
A habilitação da cobrança do pagamento.
created_atstringdate-time
A data e hora em que o pagamento foi criado.
updated_atstringdate-time
A data e hora em que o pagamento foi atualizado.
urlstring
A URL do pagamento.
receipt_urlstring
A URL do recibo do pagamento.

Exemplo

{
  "id": "string",
  "uuid": "string",
  "customer_id": "string",
  "customer": {},
  "subscription_id": "string",
  "subscription": {},
  "payment_link": {},
  "items": [
    "string"
  ],
  "allowed_methods": [
    "credit"
  ],
  "method": "credit",
  "card_id": "string",
  "card": {},
  "digitable_line": "string",
  "pix_payload": "string",
  "custom_data": {},
  "value": 0,
  "fine": 0,
  "interest": 0,
  "current_value": 0,
  "current_fine": 0,
  "current_interest": 0,
  "installments": 0,
  "status": "unpaid",
  "retries_number": 0,
  "was_last_retry": true,
  "can_refund": true,
  "refunds": [
    {
      "id": 0,
      "method": "string",
      "value": 0,
      "status": "new",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ],
  "receipts": [
    "string"
  ],
  "receipt_status": 0,
  "due_date": "2024-01-01",
  "ref_date": "2024-01-01",
  "paid_at": "2024-01-01T00:00:00Z",
  "company": {},
  "charge_enabled": true,
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "url": "string",
  "receipt_url": "string"
}

401Não autenticado

Corpo da resposta

application/json

codestring
O código do erro. Ex.: VALIDATION_ERROR, FORBIDDEN_ERROR, UNEXPECTED_ERROR.
messagestring
A mensagem do erro.
errorsobject
Os erros de cada campo, quando o code é VALIDATION_ERROR.
timestampstringdate-time
A data e hora do erro, em UTC.
request_idstring
Um identificador único gerado para esta resposta de erro.
documentation_urlstring
O endereço desta documentação.
suggestionstring
Uma sugestão de como resolver o erro.

Exemplo

{
  "code": "AUTHENTICATION_ERROR",
  "message": "Não autenticado.",
  "timestamp": "2026-10-22T12:03:44+00:00",
  "request_id": "f2a7e962-6083-4525-816e-f14d4a602e0a",
  "documentation_url": "https://docs.ninepay.com.br"
}

422Erro na validação dos dados

Corpo da resposta

application/json

codestring
O código do erro. Ex.: VALIDATION_ERROR, FORBIDDEN_ERROR, UNEXPECTED_ERROR.
messagestring
A mensagem do erro.
errorsobject
Os erros de cada campo, quando o code é VALIDATION_ERROR.
timestampstringdate-time
A data e hora do erro, em UTC.
request_idstring
Um identificador único gerado para esta resposta de erro.
documentation_urlstring
O endereço desta documentação.
suggestionstring
Uma sugestão de como resolver o erro.

Exemplo

{
  "code": "VALIDATION_ERROR",
  "message": "Os dados informados são inválidos.",
  "errors": {
    "email": [
      "O campo email é obrigatório."
    ]
  },
  "timestamp": "2026-10-22T12:03:54+00:00",
  "request_id": "64d62d36-e797-45ed-a9d5-c203bde81032",
  "documentation_url": "https://docs.ninepay.com.br",
  "suggestion": "Corrija os campos e tente novamente."
}

500Erro inesperado

Corpo da resposta

application/json

codestring
O código do erro. Ex.: VALIDATION_ERROR, FORBIDDEN_ERROR, UNEXPECTED_ERROR.
messagestring
A mensagem do erro.
errorsobject
Os erros de cada campo, quando o code é VALIDATION_ERROR.
timestampstringdate-time
A data e hora do erro, em UTC.
request_idstring
Um identificador único gerado para esta resposta de erro.
documentation_urlstring
O endereço desta documentação.
suggestionstring
Uma sugestão de como resolver o erro.

Exemplo

{
  "code": "UNEXPECTED_ERROR",
  "message": "Houve um erro inesperado.",
  "timestamp": "2026-10-22T12:04:46+00:00",
  "request_id": "868443d3-38fd-4c92-8ea8-7cccbbce4308",
  "documentation_url": "https://docs.ninepay.com.br",
  "suggestion": "Verifique todos os parâmetros da requisição. Se o erro persistir, entre em contato com nossa equipe em ti@ninepay.com.br."
}

Parâmetros de path

Parâmetros do body

Respostas

Credenciais

Resposta