Cancelar um pagamento

curl --request POST \
  --url https://api.valorapayments.com.br/v1/payments/{payment_id}/cancel \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.valorapayments.com.br/v1/payments/{payment_id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.valorapayments.com.br/v1/payments/{payment_id}/cancel"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.valorapayments.com.br/v1/payments/{payment_id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "pay_Xk2v9QeR7tLmN3bA",
  "object": "payment",
  "livemode": true,
  "method": "pix",
  "status": "requires_payment",
  "amount": {
    "value": 14990,
    "currency": "BRL"
  },
  "fee": {
    "bps": 123,
    "fixed": 123,
    "amount": 123
  },
  "created_at": "2023-11-07T05:31:56Z",
  "customer_id": "<string>",
  "external_reference": "<string>",
  "description": "<string>",
  "metadata": {
    "order_id": "1001"
  },
  "refunded_amount": 123,
  "dispute": {
    "status": "open",
    "opened_at": "2023-11-07T05:31:56Z",
    "closed_at": "2023-11-07T05:31:56Z"
  },
  "items": [
    {
      "product_id": "<string>",
      "name": "<string>",
      "unit_amount": 123,
      "quantity": 123
    }
  ],
  "splits": [
    {
      "business_id": "<string>",
      "share_bps": 123,
      "amount": 123,
      "status": "pending"
    }
  ],
  "expires_at": "2023-11-07T05:31:56Z",
  "succeeded_at": "2023-11-07T05:31:56Z",
  "pix": {
    "txid": "<string>",
    "e2e_id": "<string>",
    "brcode": "<string>",
    "qr_image": "<string>",
    "payer": {
      "name": "<string>",
      "document_masked": "<string>"
    }
  },
  "card": {
    "brand": "<string>",
    "last4": "<string>",
    "installments": 123,
    "decline_reason": "<string>"
  },
  "boleto": {
    "barcode": "<string>",
    "link": "<string>",
    "pdf": "<string>",
    "due_date": "2023-12-25",
    "pix": {
      "brcode": "<string>",
      "qr_image": "<string>"
    }
  }
}

{
  "error": {
    "type": "invalid_api_key",
    "message": "Chave de API inválida ou revogada."
  }
}

{
  "error": {
    "type": "missing_scope",
    "message": "A chave não tem o escopo necessário."
  }
}

{
  "error": {
    "type": "not_found",
    "message": "Não encontrado."
  }
}

{
  "error": {
    "type": "not_cancelable",
    "message": "Só pagamentos aguardando pagamento podem ser cancelados."
  }
}

{
  "error": {
    "type": "rate_limited",
    "message": "Muitas requisições. Tente novamente em instantes."
  }
}

{
  "error": {
    "type": "provider_error",
    "message": "Não foi possível cancelar a cobrança."
  }
}

POST

payments

{payment_id}

cancel

Cancelar um pagamento

curl --request POST \
  --url https://api.valorapayments.com.br/v1/payments/{payment_id}/cancel \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.valorapayments.com.br/v1/payments/{payment_id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.valorapayments.com.br/v1/payments/{payment_id}/cancel"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.valorapayments.com.br/v1/payments/{payment_id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "pay_Xk2v9QeR7tLmN3bA",
  "object": "payment",
  "livemode": true,
  "method": "pix",
  "status": "requires_payment",
  "amount": {
    "value": 14990,
    "currency": "BRL"
  },
  "fee": {
    "bps": 123,
    "fixed": 123,
    "amount": 123
  },
  "created_at": "2023-11-07T05:31:56Z",
  "customer_id": "<string>",
  "external_reference": "<string>",
  "description": "<string>",
  "metadata": {
    "order_id": "1001"
  },
  "refunded_amount": 123,
  "dispute": {
    "status": "open",
    "opened_at": "2023-11-07T05:31:56Z",
    "closed_at": "2023-11-07T05:31:56Z"
  },
  "items": [
    {
      "product_id": "<string>",
      "name": "<string>",
      "unit_amount": 123,
      "quantity": 123
    }
  ],
  "splits": [
    {
      "business_id": "<string>",
      "share_bps": 123,
      "amount": 123,
      "status": "pending"
    }
  ],
  "expires_at": "2023-11-07T05:31:56Z",
  "succeeded_at": "2023-11-07T05:31:56Z",
  "pix": {
    "txid": "<string>",
    "e2e_id": "<string>",
    "brcode": "<string>",
    "qr_image": "<string>",
    "payer": {
      "name": "<string>",
      "document_masked": "<string>"
    }
  },
  "card": {
    "brand": "<string>",
    "last4": "<string>",
    "installments": 123,
    "decline_reason": "<string>"
  },
  "boleto": {
    "barcode": "<string>",
    "link": "<string>",
    "pdf": "<string>",
    "due_date": "2023-12-25",
    "pix": {
      "brcode": "<string>",
      "qr_image": "<string>"
    }
  }
}

{
  "error": {
    "type": "invalid_api_key",
    "message": "Chave de API inválida ou revogada."
  }
}

{
  "error": {
    "type": "missing_scope",
    "message": "A chave não tem o escopo necessário."
  }
}

{
  "error": {
    "type": "not_found",
    "message": "Não encontrado."
  }
}

{
  "error": {
    "type": "not_cancelable",
    "message": "Só pagamentos aguardando pagamento podem ser cancelados."
  }
}

{
  "error": {
    "type": "rate_limited",
    "message": "Muitas requisições. Tente novamente em instantes."
  }
}

{
  "error": {
    "type": "provider_error",
    "message": "Não foi possível cancelar a cobrança."
  }
}

Autorizações

Authorization

string

header

obrigatório

Chave de API sk_vl_... criada no painel em Desenvolvedores → Chaves de API.

Parâmetros de caminho

payment_id

string

obrigatório

Id do pagamento.

Pattern: ^pay_[A-Za-z0-9_-]{16}$

Resposta

Pagamento cancelado.

string

obrigatório

Id do pagamento.

Pattern: ^pay_[A-Za-z0-9_-]{16}$

Exemplo:

"pay_Xk2v9QeR7tLmN3bA"

object

enum<string>

obrigatório

Sempre payment.

Opções disponíveis:

payment

livemode

boolean

obrigatório

true em produção, false no ambiente de teste.

method

enum<string>

obrigatório

Forma de pagamento.

Opções disponíveis:

pix,

card,

boleto

status

enum<string>

obrigatório

Status. requires_payment: aguardando; processing: em análise; succeeded: pago; underpaid/overpaid: pago com valor diferente (em análise); expired; failed; canceled; partially_refunded; refunded; disputed: cartão contestado.

Opções disponíveis:

requires_payment,

processing,

succeeded,

underpaid,

overpaid,

expired,

failed,

canceled,

partially_refunded,

refunded,

disputed

amount

object

obrigatório

Valor cobrado.

Hide child attributes

amount.value

integer

obrigatório

Valor em centavos.

Exemplo:

14990

amount.currency

enum<string>

obrigatório

Moeda.

Opções disponíveis:

BRL

fee

object

obrigatório

Taxa da Valora neste pagamento.

Hide child attributes

fee.bps

integer

Parte percentual em pontos-base (199 = 1,99%).

fee.fixed

integer

Parte fixa, em centavos.

fee.amount

integer

Taxa total, em centavos.

created_at

string<date-time>

obrigatório

Criação.

customer_id

string | null

Cliente associado.

external_reference

string | null

O seu identificador.

description

string | null

Descrição da cobrança.

metadata

object

Até 20 pares chave/valor em texto (chave até 40, valor até 500 caracteres). Volta igual nas respostas e nos webhooks.

Hide child attributes

metadata.{key}

string

Maximum string length: 500

Exemplo:

{ "order_id": "1001" }

refunded_amount

integer

Total já devolvido ao pagador, em centavos.

dispute

object | null

Contestação (chargeback) do cartão.

Hide child attributes

dispute.status

enum<string>

Estado.

Opções disponíveis:

open,

won,

lost

dispute.opened_at

string<date-time>

Abertura.

dispute.closed_at

string<date-time> | null

Encerramento.

items

object[]

Cópia do produto no momento da compra.

Hide child attributes

items.product_id

string

Produto.

items.name

string

Nome.

items.unit_amount

integer

Preço unitário em centavos.

items.quantity

integer

Quantidade.

splits

object[]

Divisão do valor líquido entre negócios do mesmo dono.

Hide child attributes

splits.business_id

string

Negócio.

Parte em pontos-base.

splits.amount

integer

Valor em centavos.

splits.status

enum<string>

Estado.

Opções disponíveis:

pending,

settled

expires_at

string<date-time>

Prazo para pagar.

succeeded_at

string<date-time> | null

Quando o pagamento foi confirmado.

pix

object

Só em pagamentos Pix.

Hide child attributes

pix.txid

string

Id da cobrança Pix.

pix.e2e_id

string | null

Identificador da transação no Banco Central (depois do pagamento).

pix.brcode

string

Código copia e cola.

pix.qr_image

string | null

QR Code em PNG (data URL).

pix.payer

object | null

Quem pagou (documento mascarado).

Hide child attributes

pix.payer.name

string | null

Nome.

pix.payer.document_masked

string | null

Documento mascarado.

card

object

Só em pagamentos com cartão.

Hide child attributes

card.brand

string | null

Bandeira.

card.last4

string | null

Últimos 4 dígitos.

card.installments

integer

Parcelas (1, 2, 3, 6 ou 12).

card.decline_reason

string | null

Motivo da recusa informado pelo emissor.

boleto

object

Só em pagamentos por boleto.

Hide child attributes

boleto.barcode

string | null

Linha digitável.

boleto.link

string | null

Página do boleto.

boleto.pdf

string | null

PDF do boleto.

boleto.due_date

string<date>

Vencimento (AAAA-MM-DD).

boleto.pix

object | null

Pix embutido.

Hide child attributes

boleto.pix.brcode

string

Copia e cola.

boleto.pix.qr_image

string | null

QR Code (data URL).

Visão geral

Pagamentos

Checkouts

Clientes

Produtos

Saldo

Webhooks

Cancelar um pagamento

Autorizações

Parâmetros de caminho

Resposta