Listar entregas

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

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

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

import requests

url = "https://api.valorapayments.com.br/v1/webhooks/{endpoint_id}/deliveries"

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/webhooks/{endpoint_id}/deliveries",
  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": "whd_Xk2v9QeR7tLmN3bA",
      "object": "webhook_delivery",
      "endpoint_id": "<string>",
      "event_id": "<string>",
      "status": "pending",
      "attempts": 123,
      "last_status_code": 123,
      "last_error": "<string>",
      "next_attempt_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "delivered_at": "2023-11-07T05:31:56Z"
    }
  ],
  "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": "not_found",
    "message": "Não encontrado."
  }
}

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

GET

webhooks

{endpoint_id}

deliveries

Listar entregas

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

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

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

import requests

url = "https://api.valorapayments.com.br/v1/webhooks/{endpoint_id}/deliveries"

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/webhooks/{endpoint_id}/deliveries",
  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": "whd_Xk2v9QeR7tLmN3bA",
      "object": "webhook_delivery",
      "endpoint_id": "<string>",
      "event_id": "<string>",
      "status": "pending",
      "attempts": 123,
      "last_status_code": 123,
      "last_error": "<string>",
      "next_attempt_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "delivered_at": "2023-11-07T05:31:56Z"
    }
  ],
  "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": "not_found",
    "message": "Não encontrado."
  }
}

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

Autorizações

Authorization

string

header

obrigatório

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

Parâmetros de caminho

endpoint_id

string

obrigatório

Id do endpoint.

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

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

Opções disponíveis:

pending,

processing,

delivered,

failed

Resposta

Página de entregas.

object

enum<string>

Sempre list.

Opções disponíveis:

list

data

object[]

Hide child attributes

data.id

string

Id da entrega.

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

Exemplo:

"whd_Xk2v9QeR7tLmN3bA"

data.object

enum<string>

Sempre webhook_delivery.

Opções disponíveis:

webhook_delivery

data.endpoint_id

string

Endpoint.

data.event_id

string

Evento entregue.

data.status

enum<string>

Estado.

Opções disponíveis:

pending,

processing,

delivered,

failed

data.attempts

integer

Tentativas feitas.

data.last_status_code

integer | null

Último status HTTP que o seu servidor respondeu.

data.last_error

string | null

Último erro.

data.next_attempt_at

string<date-time> | null

Próxima tentativa (só em pending).

data.created_at

string<date-time>

Criação.

data.delivered_at

string<date-time> | null

Quando foi entregue.

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 entregas

Autorizações

Parâmetros de caminho

Parâmetros de consulta

Resposta