Consultar um produto

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

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

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

{
  "id": "prod_Xk2v9QeR7tLmN3bA",
  "object": "product",
  "name": "<string>",
  "description": "<string>",
  "type": "physical",
  "status": "draft",
  "images": [
    "<string>"
  ],
  "price": {
    "amount": 14990,
    "currency": "BRL"
  },
  "external_reference": "<string>",
  "statement_description": "<string>",
  "metadata": {
    "order_id": "1001"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "archived_at": "2023-11-07T05:31:56Z"
}

{
  "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": "rate_limited",
    "message": "Muitas requisições. Tente novamente em instantes."
  }
}

GET

products

{product_id}

Consultar um produto

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

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

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

{
  "id": "prod_Xk2v9QeR7tLmN3bA",
  "object": "product",
  "name": "<string>",
  "description": "<string>",
  "type": "physical",
  "status": "draft",
  "images": [
    "<string>"
  ],
  "price": {
    "amount": 14990,
    "currency": "BRL"
  },
  "external_reference": "<string>",
  "statement_description": "<string>",
  "metadata": {
    "order_id": "1001"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "archived_at": "2023-11-07T05:31:56Z"
}

{
  "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": "rate_limited",
    "message": "Muitas requisições. Tente novamente em instantes."
  }
}

Autorizações

Authorization

string

header

obrigatório

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

Parâmetros de caminho

product_id

string

obrigatório

Id do produto.

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

Resposta

O produto.

string

Id do produto.

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

Exemplo:

"prod_Xk2v9QeR7tLmN3bA"

object

enum<string>

Sempre product.

Opções disponíveis:

product

name

string

Nome.

description

string | null

Descrição.

type

enum<string>

Tipo.

Opções disponíveis:

physical,

digital,

service

status

enum<string>

Status.

Opções disponíveis:

draft,

active,

archived

images

string<uri>[]

URLs das imagens.

price

object

Hide child attributes

price.amount

integer

Preço em centavos.

Exemplo:

14990

price.currency

enum<string>

Moeda.

Opções disponíveis:

BRL

external_reference

string | null

O seu identificador (SKU).

statement_description

string | null

Texto que o pagador vê no Pix.

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

created_at

string<date-time>

Criação.

updated_at

string<date-time>

Última alteração.

archived_at

string<date-time> | null

Quando foi arquivado.

Visão geral

Pagamentos

Checkouts

Clientes

Produtos

Saldo

Webhooks

Consultar um produto

Autorizações

Parâmetros de caminho

Resposta