Pular para o conteúdo principal

Atualizar pagamento existente​

Atualiza um pagamento existente com base no ID fornecido. Nota: É necessário fornecer o ID do pagamento que deseja atualizar.

Request Body required

Descreve os dados a serem incluídos no corpo da requisição. Atenção: alguns dados deixam de ser e tornam obrigatórios de acordo com outros dados enviados juntos com a requisição. Leia atentamente a descrição de todos os campos.

    method PaymentMethods required

    Possible values: [credit, billet, pix]

    O método que será usado para este pagamento. Posteriormente, caso necessário, este pagamento pode ser pago com outros métodos.

    value string

    O valor do pagamento em centavos. Por exemplo, para R$50,00, o value deve ser 5000. Obrigatório se os items não forem informados. Se os items forem especificado para o pagamento, a soma do valor dos items será usada, considerando as quantidades, e este campo será ignorado.

    fine number

    A multa do pagamento, em valor percentual. Ex.: para multa de 2% sobre o valor do pagamento vencido, envie 2.

    interest number

    O juros do pagamento, em valor percentual. Ex.: para 2% ao mês, envie 2.

    custom_data object

    Objeto no formato key-value para armazenar juntamente ao pagamento.

    property name* any

    Objeto no formato key-value para armazenar juntamente ao pagamento.

    customer object required

    Os dados do cliente

    name string required

    O nome do cliente. Obrigatório se o id não for informado

    email string required

    O email do cliente. Obrigatório se o id não for informado

    cpf string required

    O cpf do cliente. Obrigatório se o id ou o cnpj não forem informados

    cnpj string required

    O cnpj do cliente. Obrigatório se o id ou o cpf não forem informados

    phone string

    O telefone do cliente

    cep string

    O CEP do cliente

    address string

    O endereço do cliente

    number string

    O endereço do cliente

    district string

    O bairro do cliente

    city string

    A cidade do cliente

    state string

    O estado do cliente

    country string

    O código do país do cliente, no formato Alpha 2 de acordo com a ISO 3166.

    items object[]

    Os items que compõe esse pagamento. Obrigatório se o value não for informado. Se os items forem especificado para o pagamento, a soma do valor dos items será usada, considerando as quantidades, e o value será ignorado mesmo que esteja presente.

  • Array [
    • name string required

    O nome do item adicional

    value integer required

    O valor desse item adicional. Por exemplo, para R$20,00, o value deve ser 2000

    amount integer required

    A quantidade do item adicional

  • ]
    • fraud_prevention object

    Os dados referentes a análise antifraude, se a empresa tiver contratado este serviço.

    session_id string

    O id da sessão gerado pelo script de monitoramento

    ip string

    O IP de onde o usuário fez o pedido

    card_hash string

    O hash encriptado dos dados do cartão. Para entender o fluxo de criptografia consulte a documentação para hash de cartões. Obrigatório se o método é credit e o card não foi informado.

    card object

    Os dados do cartão em formato puro. Atenção, para trafegar dados neste formato a sua infraestrutura deve ser PCI compliance. Obrigatório se o método é credit e o card_hash não foi informado.

    number string

    O número do cartão

    holder string

    O nome do portador conforme escrito no cartão

    expiration string

    A expiração do cartão

    cvv string

    o código de verificação conforme escrito no cartão

    installments integer

    Possible values: >= 1 and <= 12

    Se o método é credit, em quantas parcelas a compra deve ser processada.

    due_date date

    A data de vencimento da cobrança. É utilizada para o vencimento do boleto e do pix. Obrigatório se o método é billet.

Responses

Pagamento atualizado 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...