Pular para o conteúdo principal

Baixar pagamento​

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.

Path Parameters
    id integer required

    O id do pagamento a ser cancelado

Request Body

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

    valueType string

    Possible values: [normal, zero]

    • normal: Mantém o valor do pagamento
    • zero: Zera o valor do pagamento (não será somado aos gráficos de faturamento)
Responses

Pagamento baixado com sucesso

Schema
    id string

    O ID do pagamento.

    uuid string

    O UUID do pagamento.

    customer_id string

    O ID do cliente do pagamento.

    customer object

    O cliente do pagamento.

    subscription_id string

    O ID da assinatura do pagamento.

    subscription object

    A assinatura do pagamento.

    payment_link object

    O link de pagamento.

    items array

    Os itens do pagamento.

    allowed_methods array

    Os métodos permitidos para o pagamento.

    method string

    O método do pagamento.

    card_id string

    O ID do cartão do pagamento.

    card object

    O cartão do pagamento.

    digitable_line string

    A linha digitável do pagamento.

    pix_payload string

    O payload do Pix do pagamento.

    custom_data object

    Os dados personalizados do pagamento.

    value number

    O valor do pagamento.

    fine number

    A multa do pagamento.

    interest number

    O juros do pagamento.

    current_value number

    O valor atual do pagamento.

    current_fine number

    A multa atual do pagamento.

    current_interest number

    O juros atual do pagamento.

    installments number

    As parcelas do pagamento.

    status string

    O status do pagamento.

    retries_number number

    O número de tentativas do pagamento.

    was_last_retry boolean

    Se foi a última tentativa do pagamento.

    can_refund boolean

    Se pode reembolsar o pagamento.

    refunds array

    Os reembolsos do pagamento.

    receipts array

    Os recibos do pagamento.

    receipt_status string

    O status do recibo do pagamento.

    due_date date

    A data de vencimento do pagamento.

    ref_date date

    A data de referência do pagamento.

    paid_at date-time

    A data e hora em que o pagamento foi pago.

    company object

    A empresa do pagamento.

    charge_enabled boolean

    A habilitação da cobrança do pagamento.

    created_at date-time

    A data e hora em que o pagamento foi criado.

    updated_at date-time

    A data e hora em que o pagamento foi atualizado.

    url string

    A URL do pagamento.

    receipt_url string

    A URL do recibo do pagamento.

Loading...