Devolver um pagamento

curl --request POST \
  --url https://api.valorapayments.com.br/v1/payments/{payment_id}/refund \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "20.00",
  "reason": "Item fora de estoque"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({amount: '20.00', reason: 'Item fora de estoque'})
};

fetch('https://api.valorapayments.com.br/v1/payments/{payment_id}/refund', 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}/refund"

payload = {
    "amount": "20.00",
    "reason": "Item fora de estoque"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.valorapayments.com.br/v1/payments/{payment_id}/refund",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => '20.00',
    'reason' => 'Item fora de estoque'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

{
  "id": "ref_Xk2v9QeR7tLmN3bA",
  "object": "refund",
  "payment_id": "<string>",
  "amount": 123,
  "status": "pending",
  "reason": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "payment": {
    "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": "provider_pending",
    "message": "Não foi possível confirmar a devolução agora. O valor está reservado e será conferido automaticamente."
  }
}

{
  "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_refundable",
    "message": "Só pagamentos Pix aprovados podem ser devolvidos."
  }
}

{
  "error": {
    "type": "invalid_amount",
    "message": "Valor acima do que resta para devolver."
  }
}

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

{
  "error": {
    "type": "provider_error",
    "message": "Falha ao devolver."
  }
}

POST

payments

{payment_id}

refund

Devolver um pagamento

curl --request POST \
  --url https://api.valorapayments.com.br/v1/payments/{payment_id}/refund \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "20.00",
  "reason": "Item fora de estoque"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({amount: '20.00', reason: 'Item fora de estoque'})
};

fetch('https://api.valorapayments.com.br/v1/payments/{payment_id}/refund', 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}/refund"

payload = {
    "amount": "20.00",
    "reason": "Item fora de estoque"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.valorapayments.com.br/v1/payments/{payment_id}/refund",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => '20.00',
    'reason' => 'Item fora de estoque'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

{
  "id": "ref_Xk2v9QeR7tLmN3bA",
  "object": "refund",
  "payment_id": "<string>",
  "amount": 123,
  "status": "pending",
  "reason": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "payment": {
    "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": "provider_pending",
    "message": "Não foi possível confirmar a devolução agora. O valor está reservado e será conferido automaticamente."
  }
}

{
  "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_refundable",
    "message": "Só pagamentos Pix aprovados podem ser devolvidos."
  }
}

{
  "error": {
    "type": "invalid_amount",
    "message": "Valor acima do que resta para devolver."
  }
}

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

{
  "error": {
    "type": "provider_error",
    "message": "Falha ao devolver."
  }
}

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}$

Corpo

application/json

amount

Valor a devolver. Omitido = tudo o que resta. Em reais, com até 2 casas e ponto decimal (ex.: "149.90"). Mínimo 0.01.

Pattern: ^\d{1,9}(\.\d{1,2})?$

Exemplo:

"149.90"

reason

string

Motivo (até 200 caracteres).

Maximum string length: 200

Resposta

Devolução criada, com o pagamento atualizado.

string

Id da devolução.

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

Exemplo:

"ref_Xk2v9QeR7tLmN3bA"

object

enum<string>

Sempre refund.

Opções disponíveis:

refund

payment_id

string

Pagamento devolvido.

amount

integer

Valor devolvido, em centavos.

status

enum<string>

Estado.

Opções disponíveis:

pending,

succeeded,

failed

reason

string | null

Motivo informado.

created_at

string<date-time>

Criação.

payment

object

Hide child attributes

payment.id

string

obrigatório

Id do pagamento.

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

Exemplo:

"pay_Xk2v9QeR7tLmN3bA"

payment.object

enum<string>

obrigatório

Sempre payment.

Opções disponíveis:

payment

payment.livemode

boolean

obrigatório

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

payment.method

enum<string>

obrigatório

Forma de pagamento.

Opções disponíveis:

pix,

card,

boleto

payment.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

payment.amount

object

obrigatório

Valor cobrado.

Hide child attributes

payment.amount.value

integer

obrigatório

Valor em centavos.

Exemplo:

14990

payment.amount.currency

enum<string>

obrigatório

Moeda.

Opções disponíveis:

BRL

payment.fee

object

obrigatório

Taxa da Valora neste pagamento.

Hide child attributes

payment.fee.bps

integer

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

payment.fee.fixed

integer

Parte fixa, em centavos.

payment.fee.amount

integer

Taxa total, em centavos.

payment.created_at

string<date-time>

obrigatório

Criação.

payment.customer_id

string | null

Cliente associado.

payment.external_reference

string | null

O seu identificador.

payment.description

string | null

Descrição da cobrança.

payment.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

payment.metadata.{key}

string

Maximum string length: 500

Exemplo:

{ "order_id": "1001" }

payment.refunded_amount

integer

Total já devolvido ao pagador, em centavos.

payment.dispute

object | null

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

Hide child attributes

payment.dispute.status

enum<string>

Estado.

Opções disponíveis:

open,

won,

lost

payment.dispute.opened_at

string<date-time>

Abertura.

payment.dispute.closed_at

string<date-time> | null

Encerramento.

payment.items

object[]

Cópia do produto no momento da compra.

Hide child attributes

payment.items.product_id

string

Produto.

payment.items.name

string

Nome.

payment.items.unit_amount

integer

Preço unitário em centavos.

payment.items.quantity

integer

Quantidade.

payment.splits

object[]

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

Hide child attributes

payment.splits.business_id

string

Negócio.

Parte em pontos-base.

payment.splits.amount

integer

Valor em centavos.

payment.splits.status

enum<string>

Estado.

Opções disponíveis:

pending,

settled

payment.expires_at

string<date-time>

Prazo para pagar.

payment.succeeded_at

string<date-time> | null

Quando o pagamento foi confirmado.

payment.pix

object

Só em pagamentos Pix.

Hide child attributes

payment.pix.txid

string

Id da cobrança Pix.

payment.pix.e2e_id

string | null

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

payment.pix.brcode

string

Código copia e cola.

payment.pix.qr_image

string | null

QR Code em PNG (data URL).

payment.pix.payer

object | null

Quem pagou (documento mascarado).

Hide child attributes

payment.pix.payer.name

string | null

Nome.

payment.pix.payer.document_masked

string | null

Documento mascarado.

payment.card

object

Só em pagamentos com cartão.

Hide child attributes

payment.card.brand

string | null

Bandeira.

payment.card.last4

string | null

Últimos 4 dígitos.

payment.card.installments

integer

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

payment.card.decline_reason

string | null

Motivo da recusa informado pelo emissor.

payment.boleto

object

Só em pagamentos por boleto.

Hide child attributes

payment.boleto.barcode

string | null

Linha digitável.

payment.boleto.link

string | null

Página do boleto.

payment.boleto.pdf

string | null

PDF do boleto.

payment.boleto.due_date

string<date>

Vencimento (AAAA-MM-DD).

payment.boleto.pix

object | null

Pix embutido.

Hide child attributes

payment.boleto.pix.brcode

string

Copia e cola.

payment.boleto.pix.qr_image

string | null

QR Code (data URL).

Visão geral

Pagamentos

Checkouts

Clientes

Produtos

Saldo

Webhooks

Devolver um pagamento

Autorizações

Parâmetros de caminho

Corpo

Resposta