Listar pagamentos

curl --request GET \
  --url https://api.valorapayments.com.br/v1/payments \
  --header 'Authorization: Bearer <token>'

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

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.valorapayments.com.br/v1/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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;
}

{
  "object": "list",
  "data": [
    {
      "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>"
        }
      }
    }
  ],
  "has_more": true,
  "next_cursor": "<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": "invalid_request",
    "message": "Corpo inválido.",
    "details": {
      "amount": [
        "Valor inválido."
      ]
    }
  }
}

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

{
  "error": {
    "type": "service_unavailable",
    "message": "Serviço temporariamente indisponível."
  }
}

GET

payments

Listar pagamentos

curl --request GET \
  --url https://api.valorapayments.com.br/v1/payments \
  --header 'Authorization: Bearer <token>'

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

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.valorapayments.com.br/v1/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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;
}

{
  "object": "list",
  "data": [
    {
      "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>"
        }
      }
    }
  ],
  "has_more": true,
  "next_cursor": "<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": "invalid_request",
    "message": "Corpo inválido.",
    "details": {
      "amount": [
        "Valor inválido."
      ]
    }
  }
}

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

{
  "error": {
    "type": "service_unavailable",
    "message": "Serviço temporariamente indisponível."
  }
}

Autorizações

Authorization

string

header

obrigatório

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

Parâmetros de consulta

limit

integer

padrão:20

Itens por página, de 1 a 100.

Intervalo obrigatório: 1 <= x <= 100

starting_after

string

O next_cursor da página anterior.

status

enum<string>

Filtra por status.

Opções disponíveis:

requires_payment,

processing,

succeeded,

underpaid,

overpaid,

expired,

failed,

canceled,

partially_refunded,

refunded,

disputed

method

enum<string>

Filtra por forma de pagamento.

Opções disponíveis:

pix,

card,

boleto

customer_id

string

Filtra por cliente.

external_reference

string

Filtra pelo seu identificador.

Resposta

Página de pagamentos.

object

enum<string>

Sempre list.

Opções disponíveis:

list

data

object[]

Hide child attributes

data.id

string

obrigatório

Id do pagamento.

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

Exemplo:

"pay_Xk2v9QeR7tLmN3bA"

data.object

enum<string>

obrigatório

Sempre payment.

Opções disponíveis:

payment

data.livemode

boolean

obrigatório

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

data.method

enum<string>

obrigatório

Forma de pagamento.

Opções disponíveis:

pix,

card,

boleto

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

data.amount

object

obrigatório

Valor cobrado.

Hide child attributes

data.amount.value

integer

obrigatório

Valor em centavos.

Exemplo:

14990

data.amount.currency

enum<string>

obrigatório

Moeda.

Opções disponíveis:

BRL

data.fee

object

obrigatório

Taxa da Valora neste pagamento.

Hide child attributes

data.fee.bps

integer

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

data.fee.fixed

integer

Parte fixa, em centavos.

data.fee.amount

integer

Taxa total, em centavos.

data.created_at

string<date-time>

obrigatório

Criação.

data.customer_id

string | null

Cliente associado.

data.external_reference

string | null

O seu identificador.

data.description

string | null

Descrição da cobrança.

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

data.metadata.{key}

string

Maximum string length: 500

Exemplo:

{ "order_id": "1001" }

data.refunded_amount

integer

Total já devolvido ao pagador, em centavos.

data.dispute

object | null

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

Hide child attributes

data.dispute.status

enum<string>

Estado.

Opções disponíveis:

open,

won,

lost

data.dispute.opened_at

string<date-time>

Abertura.

data.dispute.closed_at

string<date-time> | null

Encerramento.

data.items

object[]

Cópia do produto no momento da compra.

Hide child attributes

data.items.product_id

string

Produto.

data.items.name

string

Nome.

data.items.unit_amount

integer

Preço unitário em centavos.

data.items.quantity

integer

Quantidade.

data.splits

object[]

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

Hide child attributes

data.splits.business_id

string

Negócio.

Parte em pontos-base.

data.splits.amount

integer

Valor em centavos.

data.splits.status

enum<string>

Estado.

Opções disponíveis:

pending,

settled

data.expires_at

string<date-time>

Prazo para pagar.

data.succeeded_at

string<date-time> | null

Quando o pagamento foi confirmado.

data.pix

object

Só em pagamentos Pix.

Hide child attributes

data.pix.txid

string

Id da cobrança Pix.

data.pix.e2e_id

string | null

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

data.pix.brcode

string

Código copia e cola.

data.pix.qr_image

string | null

QR Code em PNG (data URL).

data.pix.payer

object | null

Quem pagou (documento mascarado).

Hide child attributes

data.pix.payer.name

string | null

Nome.

data.pix.payer.document_masked

string | null

Documento mascarado.

data.card

object

Só em pagamentos com cartão.

Hide child attributes

data.card.brand

string | null

Bandeira.

data.card.last4

string | null

Últimos 4 dígitos.

data.card.installments

integer

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

data.card.decline_reason

string | null

Motivo da recusa informado pelo emissor.

data.boleto

object

Só em pagamentos por boleto.

Hide child attributes

data.boleto.barcode

string | null

Linha digitável.

data.boleto.link

string | null

Página do boleto.

data.boleto.pdf

string | null

PDF do boleto.

data.boleto.due_date

string<date>

Vencimento (AAAA-MM-DD).

data.boleto.pix

object | null

Pix embutido.

Hide child attributes

data.boleto.pix.brcode

string

Copia e cola.

data.boleto.pix.qr_image

string | null

QR Code (data URL).

has_more

boolean

Há mais itens depois desta página.

next_cursor

string | null

Passe em starting_after para a próxima página.

Visão geral

Pagamentos

Checkouts

Clientes

Produtos

Saldo

Webhooks

Listar pagamentos

Autorizações

Parâmetros de consulta

Resposta