Consultar um checkout
curl --request GET \
--url https://api.valorapayments.com.br/v1/checkouts/{session_id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.valorapayments.com.br/v1/checkouts/{session_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.valorapayments.com.br/v1/checkouts/{session_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.valorapayments.com.br/v1/checkouts/{session_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": "cs_Xk2v9QeR7tLmN3bA",
"object": "checkout_session",
"status": "open",
"livemode": true,
"checkout_url": "https://pay.valorapayments.com.br/s/cs_Xk2v9QeR7tLmN3bA",
"product_cart": [
{
"product_id": "<string>",
"name": "<string>",
"quantity": 123,
"unit_amount": 123
}
],
"amount": {
"subtotal": 123,
"total": 123,
"currency": "BRL"
},
"allowed_payment_method_types": [
"pix"
],
"customer_id": "<string>",
"payment_id": "<string>",
"method": "pix",
"success_url": "<string>",
"cancel_url": "<string>",
"external_reference": "<string>",
"metadata": {
"order_id": "1001"
},
"expires_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"created_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."
}
}Checkouts
Consultar um checkout
Devolve a compra com o status atual. A confirmação do pagamento continua chegando pelo webhook.
Escopo: checkouts:read.
GET
/
v1
/
checkouts
/
{session_id}
Consultar um checkout
curl --request GET \
--url https://api.valorapayments.com.br/v1/checkouts/{session_id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.valorapayments.com.br/v1/checkouts/{session_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.valorapayments.com.br/v1/checkouts/{session_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.valorapayments.com.br/v1/checkouts/{session_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": "cs_Xk2v9QeR7tLmN3bA",
"object": "checkout_session",
"status": "open",
"livemode": true,
"checkout_url": "https://pay.valorapayments.com.br/s/cs_Xk2v9QeR7tLmN3bA",
"product_cart": [
{
"product_id": "<string>",
"name": "<string>",
"quantity": 123,
"unit_amount": 123
}
],
"amount": {
"subtotal": 123,
"total": 123,
"currency": "BRL"
},
"allowed_payment_method_types": [
"pix"
],
"customer_id": "<string>",
"payment_id": "<string>",
"method": "pix",
"success_url": "<string>",
"cancel_url": "<string>",
"external_reference": "<string>",
"metadata": {
"order_id": "1001"
},
"expires_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"created_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
Resposta
A compra.