Referência da API

Todos os endpoints com as suas permissões, parâmetros e respostas. Esta página é gerada a partir da própria descrição openapi, por isso o que está aqui também está no código.

47 endpoints, versão 2026-09-20.

Descarregar openapi.json Voltar ao portal

Endereço base

https://passavo.eu/api/v1

Importar no Postman ou no Insomnia

No Postman, escolha "Import" e cole a ligação acima, ou arraste o ficheiro descarregado; o Insomnia faz o mesmo em "Import from URL". Obtém de imediato cada endpoint como um pedido que pode executar — depois, acrescente a sua própria chave como bearer token.

https://passavo.eu/api/v1/openapi.json

Conta

Quem sou e o que posso fazer.

GET /api/v1/me #

A organização, o plano e as permissões desta chave.

Permissão necessária: read

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.

Exemplo de pedido

curl

curl "https://passavo.eu/api/v1/me" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->get('https://passavo.eu/api/v1/me');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/me', {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.get("https://passavo.eu/api/v1/me", headers=headers)
data = response.json()["data"]

Respostas

200 — A organização, o plano e as permissões desta chave.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": {
        "organisation": {},
        "plan": {},
        "api_key": {
            "name": "string",
            "prefix": "string",
            "mode": "live",
            "scopes": [
                "read"
            ],
            "expires_at": "2026-09-21T14:00:00+02:00",
            "last_used_at": "2026-09-21T14:00:00+02:00"
        },
        "locale": "string",
        "version": "string"
    }
}

Catálogo

Locais, produtos e preços.

GET /api/v1/events #

Os eventos e séries, por data.

Permissão necessária: read

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
page[size] integer · no URL · opcional

Número por página, no máximo 100.
page[cursor] string · no URL · opcional

O next_cursor da página anterior.
sort string · no URL · opcional

Ordenar; um hífen antes inverte a ordem.

Valores: event_date, -event_date, created_at, -created_at, sort_order, -sort_order, id, -id
filter[status] string · no URL · opcional

Filtrar por status.
filter[type] string · no URL · opcional

Filtrar por type.
filter[from] string · no URL · opcional

Filtrar por from.
filter[to] string · no URL · opcional

Filtrar por to.
include string · no URL · opcional

Incluir estas relações: venue.

Valores: venue

Exemplo de pedido

curl

curl "https://passavo.eu/api/v1/events" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->get('https://passavo.eu/api/v1/events');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/events', {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.get("https://passavo.eu/api/v1/events", headers=headers)
data = response.json()["data"]

Respostas

200 — Os eventos e séries, por data.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": [
        {
            "id": 1,
            "type": "string",
            "name": "string",
            "description": "string",
            "translations": {},
            "sku": "string",
            "venue_id": 1,
            "vat_rate_bp": 1,
            "capacity_rules": {},
            "event_date": "2026-09-21",
            "requires_slot": true,
            "supports_slot": true,
            "is_active": true,
            "sort_order": 1,
            "prices": [
                {
                    "id": 1,
                    "channel": "string",
                    "label": "string",
                    "amount": {
                        "amount_cent": 1,
                        "currency": "EUR"
                    },
                    "valid_from": "2026-09-21",
                    "valid_until": "2026-09-21"
                }
            ],
            "venue": {
                "id": 1,
                "name": "string",
                "slug": "string",
                "address": {},
                "latitude": 1,
                "longitude": 1,
                "timezone": "string",
                "opening_hours": {},
                "is_active": true,
                "created_at": "2026-09-21T14:00:00+02:00",
                "updated_at": "2026-09-21T14:00:00+02:00"
            },
            "created_at": "2026-09-21T14:00:00+02:00",
            "updated_at": "2026-09-21T14:00:00+02:00"
        }
    ],
    "meta": {
        "next_cursor": "string"
    }
}

GET /api/v1/products #

Os produtos com os seus preços.

Permissão necessária: read

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
page[size] integer · no URL · opcional

Número por página, no máximo 100.
page[cursor] string · no URL · opcional

O next_cursor da página anterior.
sort string · no URL · opcional

Ordenar; um hífen antes inverte a ordem.

Valores: created_at, -created_at, sort_order, -sort_order, event_date, -event_date, id, -id
filter[status] string · no URL · opcional

Filtrar por status.
filter[type] string · no URL · opcional

Filtrar por type.
filter[venue_id] string · no URL · opcional

Filtrar por venue_id.
include string · no URL · opcional

Incluir estas relações: venue.

Valores: venue

Exemplo de pedido

curl

curl "https://passavo.eu/api/v1/products" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->get('https://passavo.eu/api/v1/products');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/products', {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.get("https://passavo.eu/api/v1/products", headers=headers)
data = response.json()["data"]

Respostas

200 — Os produtos com os seus preços.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": [
        {
            "id": 1,
            "type": "string",
            "name": "string",
            "description": "string",
            "translations": {},
            "sku": "string",
            "venue_id": 1,
            "vat_rate_bp": 1,
            "capacity_rules": {},
            "event_date": "2026-09-21",
            "requires_slot": true,
            "supports_slot": true,
            "is_active": true,
            "sort_order": 1,
            "prices": [
                {
                    "id": 1,
                    "channel": "string",
                    "label": "string",
                    "amount": {
                        "amount_cent": 1,
                        "currency": "EUR"
                    },
                    "valid_from": "2026-09-21",
                    "valid_until": "2026-09-21"
                }
            ],
            "venue": {
                "id": 1,
                "name": "string",
                "slug": "string",
                "address": {},
                "latitude": 1,
                "longitude": 1,
                "timezone": "string",
                "opening_hours": {},
                "is_active": true,
                "created_at": "2026-09-21T14:00:00+02:00",
                "updated_at": "2026-09-21T14:00:00+02:00"
            },
            "created_at": "2026-09-21T14:00:00+02:00",
            "updated_at": "2026-09-21T14:00:00+02:00"
        }
    ],
    "meta": {
        "next_cursor": "string"
    }
}

GET /api/v1/products/{id} #

Um produto.

Permissão necessária: read

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
id integer · no caminho · obrigatório

O id do produto.
include string · no URL · opcional

Incluir estas relações: venue.

Valores: venue

Exemplo de pedido

curl

curl "https://passavo.eu/api/v1/products/12" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->get('https://passavo.eu/api/v1/products/12');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/products/12', {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.get("https://passavo.eu/api/v1/products/12", headers=headers)
data = response.json()["data"]

Respostas

200 — Um produto.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": {
        "id": 1,
        "type": "string",
        "name": "string",
        "description": "string",
        "translations": {},
        "sku": "string",
        "venue_id": 1,
        "vat_rate_bp": 1,
        "capacity_rules": {},
        "event_date": "2026-09-21",
        "requires_slot": true,
        "supports_slot": true,
        "is_active": true,
        "sort_order": 1,
        "prices": [
            {
                "id": 1,
                "channel": "string",
                "label": "string",
                "amount": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "valid_from": "2026-09-21",
                "valid_until": "2026-09-21"
            }
        ],
        "venue": {
            "id": 1,
            "name": "string",
            "slug": "string",
            "address": {},
            "latitude": 1,
            "longitude": 1,
            "timezone": "string",
            "opening_hours": {},
            "is_active": true,
            "created_at": "2026-09-21T14:00:00+02:00",
            "updated_at": "2026-09-21T14:00:00+02:00"
        },
        "created_at": "2026-09-21T14:00:00+02:00",
        "updated_at": "2026-09-21T14:00:00+02:00"
    }
}

GET /api/v1/venues #

Os locais da organização.

Permissão necessária: read

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
page[size] integer · no URL · opcional

Número por página, no máximo 100.
page[cursor] string · no URL · opcional

O next_cursor da página anterior.
sort string · no URL · opcional

Ordenar; um hífen antes inverte a ordem.

Valores: created_at, -created_at, name, -name, id, -id
filter[status] string · no URL · opcional

Filtrar por status.
include string · no URL · opcional

Incluir estas relações: products.

Valores: products

Exemplo de pedido

curl

curl "https://passavo.eu/api/v1/venues" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->get('https://passavo.eu/api/v1/venues');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/venues', {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.get("https://passavo.eu/api/v1/venues", headers=headers)
data = response.json()["data"]

Respostas

200 — Os locais da organização.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": [
        {
            "id": 1,
            "name": "string",
            "slug": "string",
            "address": {},
            "latitude": 1,
            "longitude": 1,
            "timezone": "string",
            "opening_hours": {},
            "is_active": true,
            "created_at": "2026-09-21T14:00:00+02:00",
            "updated_at": "2026-09-21T14:00:00+02:00"
        }
    ],
    "meta": {
        "next_cursor": "string"
    }
}

GET /api/v1/venues/{id} #

Um local.

Permissão necessária: read

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
id integer · no caminho · obrigatório

O id do local.

Exemplo de pedido

curl

curl "https://passavo.eu/api/v1/venues/12" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->get('https://passavo.eu/api/v1/venues/12');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/venues/12', {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.get("https://passavo.eu/api/v1/venues/12", headers=headers)
data = response.json()["data"]

Respostas

200 — Um local.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": {
        "id": 1,
        "name": "string",
        "slug": "string",
        "address": {},
        "latitude": 1,
        "longitude": 1,
        "timezone": "string",
        "opening_hours": {},
        "is_active": true,
        "created_at": "2026-09-21T14:00:00+02:00",
        "updated_at": "2026-09-21T14:00:00+02:00"
    }
}

Disponibilidade

Horários e lugares livres.

GET /api/v1/products/{id}/slots #

Os horários de um produto, com os lugares livres.

Permissão necessária: read

Parâmetros

id integer · no caminho · obrigatório

O id do produto.
from string · no URL · opcional

Início do intervalo; por omissão, hoje.
to string · no URL · opcional

Fim do intervalo; por omissão, 31 dias depois.
Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
page[size] integer · no URL · opcional

Número por página, no máximo 100.
page[cursor] string · no URL · opcional

O next_cursor da página anterior.
sort string · no URL · opcional

Ordenar; um hífen antes inverte a ordem.

Valores: starts_at, -starts_at, created_at, -created_at, id, -id
filter[status] string · no URL · opcional

Filtrar por status.

Exemplo de pedido

curl

curl "https://passavo.eu/api/v1/products/12/slots" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->get('https://passavo.eu/api/v1/products/12/slots');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/products/12/slots', {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.get("https://passavo.eu/api/v1/products/12/slots", headers=headers)
data = response.json()["data"]

Respostas

200 — Os horários de um produto, com os lugares livres.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": [
        {
            "id": 1,
            "product_id": 1,
            "venue_id": 1,
            "starts_at": "2026-09-21T14:00:00+02:00",
            "ends_at": "2026-09-21T14:00:00+02:00",
            "status": "string",
            "availability": {
                "capacity": 1,
                "sold": 1,
                "free": 1,
                "bookable_online": true,
                "started": true
            },
            "note": "string"
        }
    ],
    "meta": {
        "next_cursor": "string"
    }
}

Vendas

Descontos, vales-oferta e passes anuais.

GET /api/v1/discounts #

Os códigos de desconto.

Permissão necessária: read

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
page[size] integer · no URL · opcional

Número por página, no máximo 100.
page[cursor] string · no URL · opcional

O next_cursor da página anterior.
sort string · no URL · opcional

Ordenar; um hífen antes inverte a ordem.

Valores: created_at, -created_at, code, -code, valid_until, -valid_until, id, -id
filter[status] string · no URL · opcional

Filtrar por status.
filter[type] string · no URL · opcional

Filtrar por type.
filter[code] string · no URL · opcional

Filtrar por code.

Exemplo de pedido

curl

curl "https://passavo.eu/api/v1/discounts" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->get('https://passavo.eu/api/v1/discounts');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/discounts', {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.get("https://passavo.eu/api/v1/discounts", headers=headers)
data = response.json()["data"]

Respostas

200 — Os códigos de desconto.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": [
        {
            "id": 1,
            "code": "string",
            "type": "percent",
            "value": 1,
            "amount": {},
            "percentage_bp": 1,
            "valid_from": "2026-09-21T14:00:00+02:00",
            "valid_until": "2026-09-21T14:00:00+02:00",
            "max_redemptions": 1,
            "max_redemptions_per_customer": 1,
            "redeemed_count": 1,
            "minimum_order": {},
            "product_ids": [
                1
            ],
            "is_active": true,
            "is_redeemable": true,
            "created_at": "2026-09-21T14:00:00+02:00",
            "updated_at": "2026-09-21T14:00:00+02:00"
        }
    ],
    "meta": {
        "next_cursor": "string"
    }
}

GET /api/v1/passes #

Os passes anuais.

Permissão necessária: read

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
page[size] integer · no URL · opcional

Número por página, no máximo 100.
page[cursor] string · no URL · opcional

O next_cursor da página anterior.
sort string · no URL · opcional

Ordenar; um hífen antes inverte a ordem.

Valores: created_at, -created_at, valid_until, -valid_until, valid_from, -valid_from, id, -id
filter[status] string · no URL · opcional

Filtrar por status.
filter[product_id] string · no URL · opcional

Filtrar por product_id.
include string · no URL · opcional

Incluir estas relações: product.

Valores: product

Exemplo de pedido

curl

curl "https://passavo.eu/api/v1/passes" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->get('https://passavo.eu/api/v1/passes');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/passes', {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.get("https://passavo.eu/api/v1/passes", headers=headers)
data = response.json()["data"]

Respostas

200 — Os passes anuais.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": [
        {
            "id": "9f1c0b4a-6b2f-4a1b-9c7e-1f2d3e4a5b6c",
            "product_id": 1,
            "holder_name": "string",
            "holder_email": "string",
            "valid_from": "2026-09-21",
            "valid_until": "2026-09-21",
            "status": "string",
            "is_usable": true,
            "visit_count": 1,
            "last_visit_at": "2026-09-21T14:00:00+02:00",
            "cancelled_at": "2026-09-21T14:00:00+02:00",
            "product": {
                "id": 1,
                "type": "string",
                "name": "string",
                "description": "string",
                "translations": {},
                "sku": "string",
                "venue_id": 1,
                "vat_rate_bp": 1,
                "capacity_rules": {},
                "event_date": "2026-09-21",
                "requires_slot": true,
                "supports_slot": true,
                "is_active": true,
                "sort_order": 1,
                "prices": [
                    {
                        "id": 1,
                        "channel": "string",
                        "label": "string",
                        "amount": {
                            "amount_cent": null,
                            "currency": null
                        },
                        "valid_from": "2026-09-21",
                        "valid_until": "2026-09-21"
                    }
                ],
                "venue": {
                    "id": 1,
                    "name": "string",
                    "slug": "string",
                    "address": {},
                    "latitude": 1,
                    "longitude": 1,
                    "timezone": "string",
                    "opening_hours": {},
                    "is_active": true,
                    "created_at": "2026-09-21T14:00:00+02:00",
                    "updated_at": "2026-09-21T14:00:00+02:00"
                },
                "created_at": "2026-09-21T14:00:00+02:00",
                "updated_at": "2026-09-21T14:00:00+02:00"
            },
            "created_at": "2026-09-21T14:00:00+02:00",
            "updated_at": "2026-09-21T14:00:00+02:00"
        }
    ],
    "meta": {
        "next_cursor": "string"
    }
}

POST /api/v1/passes #

Emitir um passe anual nominativo.

Permissão necessária: write

Este pedido envia um body.

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
Idempotency-Key string · como cabeçalho · opcional

Repita um pedido em segurança: a mesma chave com o mesmo conteúdo dá a mesma resposta.

Exemplo de pedido

curl

curl -X POST "https://passavo.eu/api/v1/passes" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

PHP

use Illuminate\Support\Facades\Http;
use Illuminate\Support\Str;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->withHeader('Idempotency-Key', (string) Str::uuid())
    ->post('https://passavo.eu/api/v1/passes', []);

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/passes', {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({}),
});

const { data } = await response.json();

Python

import uuid

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY", "Idempotency-Key": str(uuid.uuid4())}
response = requests.post("https://passavo.eu/api/v1/passes", headers=headers, json={})
data = response.json()["data"]

Respostas

201 — Emitir um passe anual nominativo.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
409 — A encomenda não está num estado em que isto seja possível.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": {
        "id": "9f1c0b4a-6b2f-4a1b-9c7e-1f2d3e4a5b6c",
        "product_id": 1,
        "holder_name": "string",
        "holder_email": "string",
        "valid_from": "2026-09-21",
        "valid_until": "2026-09-21",
        "status": "string",
        "is_usable": true,
        "visit_count": 1,
        "last_visit_at": "2026-09-21T14:00:00+02:00",
        "cancelled_at": "2026-09-21T14:00:00+02:00",
        "product": {
            "id": 1,
            "type": "string",
            "name": "string",
            "description": "string",
            "translations": {},
            "sku": "string",
            "venue_id": 1,
            "vat_rate_bp": 1,
            "capacity_rules": {},
            "event_date": "2026-09-21",
            "requires_slot": true,
            "supports_slot": true,
            "is_active": true,
            "sort_order": 1,
            "prices": [
                {
                    "id": 1,
                    "channel": "string",
                    "label": "string",
                    "amount": {
                        "amount_cent": 1,
                        "currency": "EUR"
                    },
                    "valid_from": "2026-09-21",
                    "valid_until": "2026-09-21"
                }
            ],
            "venue": {
                "id": 1,
                "name": "string",
                "slug": "string",
                "address": {},
                "latitude": 1,
                "longitude": 1,
                "timezone": "string",
                "opening_hours": {},
                "is_active": true,
                "created_at": "2026-09-21T14:00:00+02:00",
                "updated_at": "2026-09-21T14:00:00+02:00"
            },
            "created_at": "2026-09-21T14:00:00+02:00",
            "updated_at": "2026-09-21T14:00:00+02:00"
        },
        "created_at": "2026-09-21T14:00:00+02:00",
        "updated_at": "2026-09-21T14:00:00+02:00"
    }
}

POST /api/v1/passes/{id}/renew #

Renovar um passe anual; isto cria um novo passe.

Permissão necessária: write

Este pedido envia um body.

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
Idempotency-Key string · como cabeçalho · opcional

Repita um pedido em segurança: a mesma chave com o mesmo conteúdo dá a mesma resposta.
id string · no caminho · obrigatório

O uuid do passe anual.

Exemplo de pedido

curl

curl -X POST "https://passavo.eu/api/v1/passes/12/renew" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

PHP

use Illuminate\Support\Facades\Http;
use Illuminate\Support\Str;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->withHeader('Idempotency-Key', (string) Str::uuid())
    ->post('https://passavo.eu/api/v1/passes/12/renew', []);

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/passes/12/renew', {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({}),
});

const { data } = await response.json();

Python

import uuid

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY", "Idempotency-Key": str(uuid.uuid4())}
response = requests.post("https://passavo.eu/api/v1/passes/12/renew", headers=headers, json={})
data = response.json()["data"]

Respostas

201 — Renovar um passe anual; isto cria um novo passe.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
409 — A encomenda não está num estado em que isto seja possível.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": {
        "id": "9f1c0b4a-6b2f-4a1b-9c7e-1f2d3e4a5b6c",
        "product_id": 1,
        "holder_name": "string",
        "holder_email": "string",
        "valid_from": "2026-09-21",
        "valid_until": "2026-09-21",
        "status": "string",
        "is_usable": true,
        "visit_count": 1,
        "last_visit_at": "2026-09-21T14:00:00+02:00",
        "cancelled_at": "2026-09-21T14:00:00+02:00",
        "product": {
            "id": 1,
            "type": "string",
            "name": "string",
            "description": "string",
            "translations": {},
            "sku": "string",
            "venue_id": 1,
            "vat_rate_bp": 1,
            "capacity_rules": {},
            "event_date": "2026-09-21",
            "requires_slot": true,
            "supports_slot": true,
            "is_active": true,
            "sort_order": 1,
            "prices": [
                {
                    "id": 1,
                    "channel": "string",
                    "label": "string",
                    "amount": {
                        "amount_cent": 1,
                        "currency": "EUR"
                    },
                    "valid_from": "2026-09-21",
                    "valid_until": "2026-09-21"
                }
            ],
            "venue": {
                "id": 1,
                "name": "string",
                "slug": "string",
                "address": {},
                "latitude": 1,
                "longitude": 1,
                "timezone": "string",
                "opening_hours": {},
                "is_active": true,
                "created_at": "2026-09-21T14:00:00+02:00",
                "updated_at": "2026-09-21T14:00:00+02:00"
            },
            "created_at": "2026-09-21T14:00:00+02:00",
            "updated_at": "2026-09-21T14:00:00+02:00"
        },
        "created_at": "2026-09-21T14:00:00+02:00",
        "updated_at": "2026-09-21T14:00:00+02:00"
    }
}

POST /api/v1/vouchers #

Emitir um vale-oferta.

Permissão necessária: write

Este pedido envia um body.

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
Idempotency-Key string · como cabeçalho · opcional

Repita um pedido em segurança: a mesma chave com o mesmo conteúdo dá a mesma resposta.

Exemplo de pedido

curl

curl -X POST "https://passavo.eu/api/v1/vouchers" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

PHP

use Illuminate\Support\Facades\Http;
use Illuminate\Support\Str;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->withHeader('Idempotency-Key', (string) Str::uuid())
    ->post('https://passavo.eu/api/v1/vouchers', []);

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/vouchers', {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({}),
});

const { data } = await response.json();

Python

import uuid

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY", "Idempotency-Key": str(uuid.uuid4())}
response = requests.post("https://passavo.eu/api/v1/vouchers", headers=headers, json={})
data = response.json()["data"]

Respostas

201 — Emitir um vale-oferta.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
409 — A encomenda não está num estado em que isto seja possível.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": {
        "code": "string",
        "balance": {
            "amount_cent": 1,
            "currency": "EUR"
        },
        "initial_balance": {
            "amount_cent": 1,
            "currency": "EUR"
        },
        "currency": "string",
        "status": "string",
        "is_redeemable": true,
        "expires_at": "2026-09-21",
        "recipient_name": "string",
        "is_active": true,
        "created_at": "2026-09-21T14:00:00+02:00",
        "updated_at": "2026-09-21T14:00:00+02:00"
    }
}

GET /api/v1/vouchers/{code} #

O saldo de um vale-oferta.

Permissão necessária: read

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
code string · no caminho · obrigatório

O código do vale-oferta.

Exemplo de pedido

curl

curl "https://passavo.eu/api/v1/vouchers/BON-1234" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->get('https://passavo.eu/api/v1/vouchers/BON-1234');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/vouchers/BON-1234', {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.get("https://passavo.eu/api/v1/vouchers/BON-1234", headers=headers)
data = response.json()["data"]

Respostas

200 — O saldo de um vale-oferta.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": {
        "code": "string",
        "balance": {
            "amount_cent": 1,
            "currency": "EUR"
        },
        "initial_balance": {
            "amount_cent": 1,
            "currency": "EUR"
        },
        "currency": "string",
        "status": "string",
        "is_redeemable": true,
        "expires_at": "2026-09-21",
        "recipient_name": "string",
        "is_active": true,
        "created_at": "2026-09-21T14:00:00+02:00",
        "updated_at": "2026-09-21T14:00:00+02:00"
    }
}

POST /api/v1/vouchers/{code}/redeem #

Descontar parte de um vale-oferta.

Permissão necessária: write

Este pedido envia um body.

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
Idempotency-Key string · como cabeçalho · opcional

Repita um pedido em segurança: a mesma chave com o mesmo conteúdo dá a mesma resposta.
code string · no caminho · obrigatório

O código do vale-oferta.

Exemplo de pedido

curl

curl -X POST "https://passavo.eu/api/v1/vouchers/BON-1234/redeem" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

PHP

use Illuminate\Support\Facades\Http;
use Illuminate\Support\Str;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->withHeader('Idempotency-Key', (string) Str::uuid())
    ->post('https://passavo.eu/api/v1/vouchers/BON-1234/redeem', []);

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/vouchers/BON-1234/redeem', {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({}),
});

const { data } = await response.json();

Python

import uuid

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY", "Idempotency-Key": str(uuid.uuid4())}
response = requests.post("https://passavo.eu/api/v1/vouchers/BON-1234/redeem", headers=headers, json={})
data = response.json()["data"]

Respostas

201 — Descontar parte de um vale-oferta.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
409 — A encomenda não está num estado em que isto seja possível.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": {
        "code": "string",
        "requested": {
            "amount_cent": 1,
            "currency": "EUR"
        },
        "redeemed": {
            "amount_cent": 1,
            "currency": "EUR"
        },
        "balance": {
            "amount_cent": 1,
            "currency": "EUR"
        },
        "is_redeemable": true
    }
}

Encomendas

Criar, pagar, cancelar e reembolsar encomendas.

GET /api/v1/orders #

As encomendas da organização.

Permissão necessária: read

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
page[size] integer · no URL · opcional

Número por página, no máximo 100.
page[cursor] string · no URL · opcional

O next_cursor da página anterior.
sort string · no URL · opcional

Ordenar; um hífen antes inverte a ordem.

Valores: created_at, -created_at, paid_at, -paid_at, total_cent, -total_cent, id, -id
filter[status] string · no URL · opcional

Filtrar por status.
filter[channel] string · no URL · opcional

Filtrar por channel.
filter[reference] string · no URL · opcional

Filtrar por reference.
filter[email] string · no URL · opcional

Filtrar por email.
filter[from] string · no URL · opcional

Filtrar por from.
filter[to] string · no URL · opcional

Filtrar por to.
filter[sandbox] string · no URL · opcional

Filtrar por sandbox.
include string · no URL · opcional

Incluir estas relações: lines, tickets, payments, refunds.

Valores: lines, tickets, payments, refunds

Exemplo de pedido

curl

curl "https://passavo.eu/api/v1/orders" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->get('https://passavo.eu/api/v1/orders');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/orders', {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.get("https://passavo.eu/api/v1/orders", headers=headers)
data = response.json()["data"]

Respostas

200 — As encomendas da organização.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": [
        {
            "id": "string",
            "reference": "string",
            "status": "draft",
            "channel": "online",
            "venue_id": 1,
            "buyer": {
                "name": "string",
                "email": "string",
                "phone": "string",
                "locale": "string"
            },
            "totals": {
                "subtotal": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "discount": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "discount_code": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "voucher": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "vat": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "total": {
                    "amount_cent": 1,
                    "currency": "EUR"
                }
            },
            "discount_code": "string",
            "voucher_code": "string",
            "reserved_until": "2026-09-21T14:00:00+02:00",
            "sandbox": true,
            "test": true,
            "payment": {
                "provider": "string",
                "provider_ref": "string",
                "redirect_url": "string",
                "qr_code_url": "string"
            },
            "paid_at": "2026-09-21T14:00:00+02:00",
            "cancelled_at": "2026-09-21T14:00:00+02:00",
            "lines": [
                {
                    "id": 1,
                    "product_id": 1,
                    "slot_id": 1,
                    "description": "string",
                    "quantity": 1,
                    "unit_price": {
                        "amount_cent": 1,
                        "currency": "EUR"
                    },
                    "line_total": {
                        "amount_cent": 1,
                        "currency": "EUR"
                    },
                    "vat_rate_bp": 1,
                    "vat": {
                        "amount_cent": 1,
                        "currency": "EUR"
                    },
                    "valid_on": "2026-09-21",
                    "created_at": "2026-09-21T14:00:00+02:00"
                }
            ],
            "tickets": [
                {
                    "id": "9f1c0b4a-6b2f-4a1b-9c7e-1f2d3e4a5b6c",
                    "order_line_id": 1,
                    "order_id": "string",
                    "product_id": 1,
                    "slot_id": 1,
                    "description": "string",
                    "holder_name": "string",
                    "status": "valid",
                    "valid_on": "2026-09-21",
                    "is_scannable": true,
                    "used_at": "2026-09-21T14:00:00+02:00",
                    "created_at": "2026-09-21T14:00:00+02:00",
                    "updated_at": "2026-09-21T14:00:00+02:00"
                }
            ],
            "payments": [
                {
                    "id": 1,
                    "provider": "string",
                    "provider_ref": "string",
                    "method": "string",
                    "amount": {
                        "amount_cent": 1,
                        "currency": "EUR"
                    },
                    "status": "string",
                    "paid_at": "2026-09-21T14:00:00+02:00",
                    "created_at": "2026-09-21T14:00:00+02:00"
                }
            ],
            "refunds": [
                {
                    "id": 1,
                    "payment_id": 1,
                    "provider": "string",
                    "provider_ref": "string",
                    "amount": {
                        "amount_cent": 1,
                        "currency": "EUR"
                    },
                    "status": "pending",
                    "reason": "string",
                    "refunded_at": "2026-09-21T14:00:00+02:00",
                    "created_at": "2026-09-21T14:00:00+02:00"
                }
            ],
            "created_at": "2026-09-21T14:00:00+02:00",
            "updated_at": "2026-09-21T14:00:00+02:00"
        }
    ],
    "meta": {
        "next_cursor": "string"
    }
}

POST /api/v1/orders #

Uma nova encomenda, com os lugares retidos.

Permissão necessária: write

Este pedido envia um body.

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
Idempotency-Key string · como cabeçalho · obrigatório

Obrigatório. Sem esta chave, uma repetição após um erro de rede pode gerar uma segunda encomenda ou um segundo vale.

Exemplo de pedido

curl

curl -X POST "https://passavo.eu/api/v1/orders" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

PHP

use Illuminate\Support\Facades\Http;
use Illuminate\Support\Str;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->withHeader('Idempotency-Key', (string) Str::uuid())
    ->post('https://passavo.eu/api/v1/orders', []);

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/orders', {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({}),
});

const { data } = await response.json();

Python

import uuid

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY", "Idempotency-Key": str(uuid.uuid4())}
response = requests.post("https://passavo.eu/api/v1/orders", headers=headers, json={})
data = response.json()["data"]

Respostas

201 — Uma nova encomenda, com os lugares retidos.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
409 — O horário está cheio ou já começou.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": {
        "id": "string",
        "reference": "string",
        "status": "draft",
        "channel": "online",
        "venue_id": 1,
        "buyer": {
            "name": "string",
            "email": "string",
            "phone": "string",
            "locale": "string"
        },
        "totals": {
            "subtotal": {
                "amount_cent": 1,
                "currency": "EUR"
            },
            "discount": {
                "amount_cent": 1,
                "currency": "EUR"
            },
            "discount_code": {
                "amount_cent": 1,
                "currency": "EUR"
            },
            "voucher": {
                "amount_cent": 1,
                "currency": "EUR"
            },
            "vat": {
                "amount_cent": 1,
                "currency": "EUR"
            },
            "total": {
                "amount_cent": 1,
                "currency": "EUR"
            }
        },
        "discount_code": "string",
        "voucher_code": "string",
        "reserved_until": "2026-09-21T14:00:00+02:00",
        "sandbox": true,
        "test": true,
        "payment": {
            "provider": "string",
            "provider_ref": "string",
            "redirect_url": "string",
            "qr_code_url": "string"
        },
        "paid_at": "2026-09-21T14:00:00+02:00",
        "cancelled_at": "2026-09-21T14:00:00+02:00",
        "lines": [
            {
                "id": 1,
                "product_id": 1,
                "slot_id": 1,
                "description": "string",
                "quantity": 1,
                "unit_price": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "line_total": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "vat_rate_bp": 1,
                "vat": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "valid_on": "2026-09-21",
                "created_at": "2026-09-21T14:00:00+02:00"
            }
        ],
        "tickets": [
            {
                "id": "9f1c0b4a-6b2f-4a1b-9c7e-1f2d3e4a5b6c",
                "order_line_id": 1,
                "order_id": "string",
                "product_id": 1,
                "slot_id": 1,
                "description": "string",
                "holder_name": "string",
                "status": "valid",
                "valid_on": "2026-09-21",
                "is_scannable": true,
                "used_at": "2026-09-21T14:00:00+02:00",
                "created_at": "2026-09-21T14:00:00+02:00",
                "updated_at": "2026-09-21T14:00:00+02:00"
            }
        ],
        "payments": [
            {
                "id": 1,
                "provider": "string",
                "provider_ref": "string",
                "method": "string",
                "amount": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "status": "string",
                "paid_at": "2026-09-21T14:00:00+02:00",
                "created_at": "2026-09-21T14:00:00+02:00"
            }
        ],
        "refunds": [
            {
                "id": 1,
                "payment_id": 1,
                "provider": "string",
                "provider_ref": "string",
                "amount": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "status": "pending",
                "reason": "string",
                "refunded_at": "2026-09-21T14:00:00+02:00",
                "created_at": "2026-09-21T14:00:00+02:00"
            }
        ],
        "created_at": "2026-09-21T14:00:00+02:00",
        "updated_at": "2026-09-21T14:00:00+02:00"
    }
}

GET /api/v1/orders/{id} #

Uma encomenda.

Permissão necessária: read

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
id string · no caminho · obrigatório

A referência da encomenda, p. ex. ORD-AB12CD34EF.
include string · no URL · opcional

Incluir estas relações: lines, tickets, payments, refunds.

Valores: lines, tickets, payments, refunds

Exemplo de pedido

curl

curl "https://passavo.eu/api/v1/orders/12" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->get('https://passavo.eu/api/v1/orders/12');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/orders/12', {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.get("https://passavo.eu/api/v1/orders/12", headers=headers)
data = response.json()["data"]

Respostas

200 — Uma encomenda.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": {
        "id": "string",
        "reference": "string",
        "status": "draft",
        "channel": "online",
        "venue_id": 1,
        "buyer": {
            "name": "string",
            "email": "string",
            "phone": "string",
            "locale": "string"
        },
        "totals": {
            "subtotal": {
                "amount_cent": 1,
                "currency": "EUR"
            },
            "discount": {
                "amount_cent": 1,
                "currency": "EUR"
            },
            "discount_code": {
                "amount_cent": 1,
                "currency": "EUR"
            },
            "voucher": {
                "amount_cent": 1,
                "currency": "EUR"
            },
            "vat": {
                "amount_cent": 1,
                "currency": "EUR"
            },
            "total": {
                "amount_cent": 1,
                "currency": "EUR"
            }
        },
        "discount_code": "string",
        "voucher_code": "string",
        "reserved_until": "2026-09-21T14:00:00+02:00",
        "sandbox": true,
        "test": true,
        "payment": {
            "provider": "string",
            "provider_ref": "string",
            "redirect_url": "string",
            "qr_code_url": "string"
        },
        "paid_at": "2026-09-21T14:00:00+02:00",
        "cancelled_at": "2026-09-21T14:00:00+02:00",
        "lines": [
            {
                "id": 1,
                "product_id": 1,
                "slot_id": 1,
                "description": "string",
                "quantity": 1,
                "unit_price": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "line_total": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "vat_rate_bp": 1,
                "vat": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "valid_on": "2026-09-21",
                "created_at": "2026-09-21T14:00:00+02:00"
            }
        ],
        "tickets": [
            {
                "id": "9f1c0b4a-6b2f-4a1b-9c7e-1f2d3e4a5b6c",
                "order_line_id": 1,
                "order_id": "string",
                "product_id": 1,
                "slot_id": 1,
                "description": "string",
                "holder_name": "string",
                "status": "valid",
                "valid_on": "2026-09-21",
                "is_scannable": true,
                "used_at": "2026-09-21T14:00:00+02:00",
                "created_at": "2026-09-21T14:00:00+02:00",
                "updated_at": "2026-09-21T14:00:00+02:00"
            }
        ],
        "payments": [
            {
                "id": 1,
                "provider": "string",
                "provider_ref": "string",
                "method": "string",
                "amount": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "status": "string",
                "paid_at": "2026-09-21T14:00:00+02:00",
                "created_at": "2026-09-21T14:00:00+02:00"
            }
        ],
        "refunds": [
            {
                "id": 1,
                "payment_id": 1,
                "provider": "string",
                "provider_ref": "string",
                "amount": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "status": "pending",
                "reason": "string",
                "refunded_at": "2026-09-21T14:00:00+02:00",
                "created_at": "2026-09-21T14:00:00+02:00"
            }
        ],
        "created_at": "2026-09-21T14:00:00+02:00",
        "updated_at": "2026-09-21T14:00:00+02:00"
    }
}

POST /api/v1/orders/{id}/cancel #

Cancelar e libertar os lugares.

Permissão necessária: write

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
Idempotency-Key string · como cabeçalho · opcional

Repita um pedido em segurança: a mesma chave com o mesmo conteúdo dá a mesma resposta.
id string · no caminho · obrigatório

A referência da encomenda, p. ex. ORD-AB12CD34EF.

Exemplo de pedido

curl

curl -X POST "https://passavo.eu/api/v1/orders/12/cancel" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->post('https://passavo.eu/api/v1/orders/12/cancel');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/orders/12/cancel', {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.post("https://passavo.eu/api/v1/orders/12/cancel", headers=headers)
data = response.json()["data"]

Respostas

200 — Cancelar e libertar os lugares.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
409 — Esta encomenda não pode ser cancelada.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": {
        "id": "string",
        "reference": "string",
        "status": "draft",
        "channel": "online",
        "venue_id": 1,
        "buyer": {
            "name": "string",
            "email": "string",
            "phone": "string",
            "locale": "string"
        },
        "totals": {
            "subtotal": {
                "amount_cent": 1,
                "currency": "EUR"
            },
            "discount": {
                "amount_cent": 1,
                "currency": "EUR"
            },
            "discount_code": {
                "amount_cent": 1,
                "currency": "EUR"
            },
            "voucher": {
                "amount_cent": 1,
                "currency": "EUR"
            },
            "vat": {
                "amount_cent": 1,
                "currency": "EUR"
            },
            "total": {
                "amount_cent": 1,
                "currency": "EUR"
            }
        },
        "discount_code": "string",
        "voucher_code": "string",
        "reserved_until": "2026-09-21T14:00:00+02:00",
        "sandbox": true,
        "test": true,
        "payment": {
            "provider": "string",
            "provider_ref": "string",
            "redirect_url": "string",
            "qr_code_url": "string"
        },
        "paid_at": "2026-09-21T14:00:00+02:00",
        "cancelled_at": "2026-09-21T14:00:00+02:00",
        "lines": [
            {
                "id": 1,
                "product_id": 1,
                "slot_id": 1,
                "description": "string",
                "quantity": 1,
                "unit_price": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "line_total": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "vat_rate_bp": 1,
                "vat": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "valid_on": "2026-09-21",
                "created_at": "2026-09-21T14:00:00+02:00"
            }
        ],
        "tickets": [
            {
                "id": "9f1c0b4a-6b2f-4a1b-9c7e-1f2d3e4a5b6c",
                "order_line_id": 1,
                "order_id": "string",
                "product_id": 1,
                "slot_id": 1,
                "description": "string",
                "holder_name": "string",
                "status": "valid",
                "valid_on": "2026-09-21",
                "is_scannable": true,
                "used_at": "2026-09-21T14:00:00+02:00",
                "created_at": "2026-09-21T14:00:00+02:00",
                "updated_at": "2026-09-21T14:00:00+02:00"
            }
        ],
        "payments": [
            {
                "id": 1,
                "provider": "string",
                "provider_ref": "string",
                "method": "string",
                "amount": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "status": "string",
                "paid_at": "2026-09-21T14:00:00+02:00",
                "created_at": "2026-09-21T14:00:00+02:00"
            }
        ],
        "refunds": [
            {
                "id": 1,
                "payment_id": 1,
                "provider": "string",
                "provider_ref": "string",
                "amount": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "status": "pending",
                "reason": "string",
                "refunded_at": "2026-09-21T14:00:00+02:00",
                "created_at": "2026-09-21T14:00:00+02:00"
            }
        ],
        "created_at": "2026-09-21T14:00:00+02:00",
        "updated_at": "2026-09-21T14:00:00+02:00"
    }
}

POST /api/v1/orders/{id}/checkout #

A ligação de pagamento do fornecedor ligado.

Permissão necessária: write

Este pedido envia um body.

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
Idempotency-Key string · como cabeçalho · opcional

Repita um pedido em segurança: a mesma chave com o mesmo conteúdo dá a mesma resposta.
id string · no caminho · obrigatório

A referência da encomenda, p. ex. ORD-AB12CD34EF.

Exemplo de pedido

curl

curl -X POST "https://passavo.eu/api/v1/orders/12/checkout" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

PHP

use Illuminate\Support\Facades\Http;
use Illuminate\Support\Str;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->withHeader('Idempotency-Key', (string) Str::uuid())
    ->post('https://passavo.eu/api/v1/orders/12/checkout', []);

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/orders/12/checkout', {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({}),
});

const { data } = await response.json();

Python

import uuid

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY", "Idempotency-Key": str(uuid.uuid4())}
response = requests.post("https://passavo.eu/api/v1/orders/12/checkout", headers=headers, json={})
data = response.json()["data"]

Respostas

200 — A ligação de pagamento do fornecedor ligado.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
409 — Esta organização não tem nenhum fornecedor de pagamentos ligado.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": {
        "id": "string",
        "reference": "string",
        "status": "draft",
        "channel": "online",
        "venue_id": 1,
        "buyer": {
            "name": "string",
            "email": "string",
            "phone": "string",
            "locale": "string"
        },
        "totals": {
            "subtotal": {
                "amount_cent": 1,
                "currency": "EUR"
            },
            "discount": {
                "amount_cent": 1,
                "currency": "EUR"
            },
            "discount_code": {
                "amount_cent": 1,
                "currency": "EUR"
            },
            "voucher": {
                "amount_cent": 1,
                "currency": "EUR"
            },
            "vat": {
                "amount_cent": 1,
                "currency": "EUR"
            },
            "total": {
                "amount_cent": 1,
                "currency": "EUR"
            }
        },
        "discount_code": "string",
        "voucher_code": "string",
        "reserved_until": "2026-09-21T14:00:00+02:00",
        "sandbox": true,
        "test": true,
        "payment": {
            "provider": "string",
            "provider_ref": "string",
            "redirect_url": "string",
            "qr_code_url": "string"
        },
        "paid_at": "2026-09-21T14:00:00+02:00",
        "cancelled_at": "2026-09-21T14:00:00+02:00",
        "lines": [
            {
                "id": 1,
                "product_id": 1,
                "slot_id": 1,
                "description": "string",
                "quantity": 1,
                "unit_price": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "line_total": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "vat_rate_bp": 1,
                "vat": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "valid_on": "2026-09-21",
                "created_at": "2026-09-21T14:00:00+02:00"
            }
        ],
        "tickets": [
            {
                "id": "9f1c0b4a-6b2f-4a1b-9c7e-1f2d3e4a5b6c",
                "order_line_id": 1,
                "order_id": "string",
                "product_id": 1,
                "slot_id": 1,
                "description": "string",
                "holder_name": "string",
                "status": "valid",
                "valid_on": "2026-09-21",
                "is_scannable": true,
                "used_at": "2026-09-21T14:00:00+02:00",
                "created_at": "2026-09-21T14:00:00+02:00",
                "updated_at": "2026-09-21T14:00:00+02:00"
            }
        ],
        "payments": [
            {
                "id": 1,
                "provider": "string",
                "provider_ref": "string",
                "method": "string",
                "amount": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "status": "string",
                "paid_at": "2026-09-21T14:00:00+02:00",
                "created_at": "2026-09-21T14:00:00+02:00"
            }
        ],
        "refunds": [
            {
                "id": 1,
                "payment_id": 1,
                "provider": "string",
                "provider_ref": "string",
                "amount": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "status": "pending",
                "reason": "string",
                "refunded_at": "2026-09-21T14:00:00+02:00",
                "created_at": "2026-09-21T14:00:00+02:00"
            }
        ],
        "created_at": "2026-09-21T14:00:00+02:00",
        "updated_at": "2026-09-21T14:00:00+02:00"
    }
}

POST /api/v1/orders/{id}/invoice-request #

Pedir uma fatura em nome próprio.

Permissão necessária: write

Este pedido envia um body.

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
Idempotency-Key string · como cabeçalho · opcional

Repita um pedido em segurança: a mesma chave com o mesmo conteúdo dá a mesma resposta.
id string · no caminho · obrigatório

A referência da encomenda, p. ex. ORD-AB12CD34EF.

Exemplo de pedido

curl

curl -X POST "https://passavo.eu/api/v1/orders/12/invoice-request" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

PHP

use Illuminate\Support\Facades\Http;
use Illuminate\Support\Str;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->withHeader('Idempotency-Key', (string) Str::uuid())
    ->post('https://passavo.eu/api/v1/orders/12/invoice-request', []);

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/orders/12/invoice-request', {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({}),
});

const { data } = await response.json();

Python

import uuid

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY", "Idempotency-Key": str(uuid.uuid4())}
response = requests.post("https://passavo.eu/api/v1/orders/12/invoice-request", headers=headers, json={})
data = response.json()["data"]

Respostas

201 — Pedir uma fatura em nome próprio.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
409 — A encomenda não está num estado em que isto seja possível.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": {
        "order_id": "string",
        "requested_at": "2026-09-21T14:00:00+02:00",
        "company_name": "string",
        "vat_number": "string",
        "vat_number_valid": true,
        "country": "string",
        "invoice_number": "string"
    }
}

POST /api/v1/orders/{id}/mark-paid #

Pago fora do fornecedor (transferência bancária, dinheiro).

Permissão necessária: write

Este pedido envia um body.

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
Idempotency-Key string · como cabeçalho · opcional

Repita um pedido em segurança: a mesma chave com o mesmo conteúdo dá a mesma resposta.
id string · no caminho · obrigatório

A referência da encomenda, p. ex. ORD-AB12CD34EF.

Exemplo de pedido

curl

curl -X POST "https://passavo.eu/api/v1/orders/12/mark-paid" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

PHP

use Illuminate\Support\Facades\Http;
use Illuminate\Support\Str;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->withHeader('Idempotency-Key', (string) Str::uuid())
    ->post('https://passavo.eu/api/v1/orders/12/mark-paid', []);

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/orders/12/mark-paid', {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({}),
});

const { data } = await response.json();

Python

import uuid

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY", "Idempotency-Key": str(uuid.uuid4())}
response = requests.post("https://passavo.eu/api/v1/orders/12/mark-paid", headers=headers, json={})
data = response.json()["data"]

Respostas

200 — Pago fora do fornecedor (transferência bancária, dinheiro).
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
409 — A encomenda não está num estado em que isto seja possível.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": {
        "id": "string",
        "reference": "string",
        "status": "draft",
        "channel": "online",
        "venue_id": 1,
        "buyer": {
            "name": "string",
            "email": "string",
            "phone": "string",
            "locale": "string"
        },
        "totals": {
            "subtotal": {
                "amount_cent": 1,
                "currency": "EUR"
            },
            "discount": {
                "amount_cent": 1,
                "currency": "EUR"
            },
            "discount_code": {
                "amount_cent": 1,
                "currency": "EUR"
            },
            "voucher": {
                "amount_cent": 1,
                "currency": "EUR"
            },
            "vat": {
                "amount_cent": 1,
                "currency": "EUR"
            },
            "total": {
                "amount_cent": 1,
                "currency": "EUR"
            }
        },
        "discount_code": "string",
        "voucher_code": "string",
        "reserved_until": "2026-09-21T14:00:00+02:00",
        "sandbox": true,
        "test": true,
        "payment": {
            "provider": "string",
            "provider_ref": "string",
            "redirect_url": "string",
            "qr_code_url": "string"
        },
        "paid_at": "2026-09-21T14:00:00+02:00",
        "cancelled_at": "2026-09-21T14:00:00+02:00",
        "lines": [
            {
                "id": 1,
                "product_id": 1,
                "slot_id": 1,
                "description": "string",
                "quantity": 1,
                "unit_price": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "line_total": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "vat_rate_bp": 1,
                "vat": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "valid_on": "2026-09-21",
                "created_at": "2026-09-21T14:00:00+02:00"
            }
        ],
        "tickets": [
            {
                "id": "9f1c0b4a-6b2f-4a1b-9c7e-1f2d3e4a5b6c",
                "order_line_id": 1,
                "order_id": "string",
                "product_id": 1,
                "slot_id": 1,
                "description": "string",
                "holder_name": "string",
                "status": "valid",
                "valid_on": "2026-09-21",
                "is_scannable": true,
                "used_at": "2026-09-21T14:00:00+02:00",
                "created_at": "2026-09-21T14:00:00+02:00",
                "updated_at": "2026-09-21T14:00:00+02:00"
            }
        ],
        "payments": [
            {
                "id": 1,
                "provider": "string",
                "provider_ref": "string",
                "method": "string",
                "amount": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "status": "string",
                "paid_at": "2026-09-21T14:00:00+02:00",
                "created_at": "2026-09-21T14:00:00+02:00"
            }
        ],
        "refunds": [
            {
                "id": 1,
                "payment_id": 1,
                "provider": "string",
                "provider_ref": "string",
                "amount": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "status": "pending",
                "reason": "string",
                "refunded_at": "2026-09-21T14:00:00+02:00",
                "created_at": "2026-09-21T14:00:00+02:00"
            }
        ],
        "created_at": "2026-09-21T14:00:00+02:00",
        "updated_at": "2026-09-21T14:00:00+02:00"
    }
}

POST /api/v1/orders/{id}/refund #

Reembolsar total ou parcialmente.

Permissão necessária: write

Este pedido envia um body.

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
Idempotency-Key string · como cabeçalho · opcional

Repita um pedido em segurança: a mesma chave com o mesmo conteúdo dá a mesma resposta.
id string · no caminho · obrigatório

A referência da encomenda, p. ex. ORD-AB12CD34EF.

Exemplo de pedido

curl

curl -X POST "https://passavo.eu/api/v1/orders/12/refund" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

PHP

use Illuminate\Support\Facades\Http;
use Illuminate\Support\Str;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->withHeader('Idempotency-Key', (string) Str::uuid())
    ->post('https://passavo.eu/api/v1/orders/12/refund', []);

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/orders/12/refund', {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({}),
});

const { data } = await response.json();

Python

import uuid

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY", "Idempotency-Key": str(uuid.uuid4())}
response = requests.post("https://passavo.eu/api/v1/orders/12/refund", headers=headers, json={})
data = response.json()["data"]

Respostas

201 — Reembolsar total ou parcialmente.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
409 — Não há nada (ou já não há nada) a reembolsar.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": {
        "id": 1,
        "payment_id": 1,
        "provider": "string",
        "provider_ref": "string",
        "amount": {
            "amount_cent": 1,
            "currency": "EUR"
        },
        "status": "pending",
        "reason": "string",
        "refunded_at": "2026-09-21T14:00:00+02:00",
        "created_at": "2026-09-21T14:00:00+02:00"
    }
}

GET /api/v1/sandbox/payments/{reference} #

A página de pagamento simulada da sandbox.

Permissão necessária: Não precisa de chave

Parâmetros

reference string · no caminho · obrigatório

A referência da encomenda, p. ex. ORD-AB12CD34EF.
signature string · no URL · opcional

A assinatura da ligação; não a altere.
expires integer · no URL · opcional

Quando a ligação expira, como marca temporal.
return_url string · no URL · opcional

Para onde vai o comprador no fim.

Exemplo de pedido

curl

curl "https://passavo.eu/api/v1/sandbox/payments/12" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->get('https://passavo.eu/api/v1/sandbox/payments/12');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/sandbox/payments/12', {
  method: 'GET',
  headers: {
    Accept: 'application/json',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json"}
response = requests.get("https://passavo.eu/api/v1/sandbox/payments/12", headers=headers)
data = response.json()["data"]

Respostas

200 — A página de pagamento simulada da sandbox.
302 — Voltar ao return_url da integração.
403 — Esta ligação não é válida ou expirou.
404 — Não encontrado.

POST /api/v1/sandbox/payments/{reference} #

Concluir o pagamento simulado.

Permissão necessária: Não precisa de chave

Parâmetros

reference string · no caminho · obrigatório

A referência da encomenda, p. ex. ORD-AB12CD34EF.
signature string · no URL · opcional

A assinatura da ligação; não a altere.
expires integer · no URL · opcional

Quando a ligação expira, como marca temporal.
return_url string · no URL · opcional

Para onde vai o comprador no fim.

Exemplo de pedido

curl

curl -X POST "https://passavo.eu/api/v1/sandbox/payments/12" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->post('https://passavo.eu/api/v1/sandbox/payments/12');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/sandbox/payments/12', {
  method: 'POST',
  headers: {
    Accept: 'application/json',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json"}
response = requests.post("https://passavo.eu/api/v1/sandbox/payments/12", headers=headers)
data = response.json()["data"]

Respostas

200 — Concluir o pagamento simulado.
302 — Voltar ao return_url da integração.
403 — Esta ligação não é válida ou expirou.
404 — Não encontrado.

Bilhetes

Consultar, anular e reenviar bilhetes.

GET /api/v1/tickets #

Os bilhetes, com filtros para a lista da porta.

Permissão necessária: read

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
page[size] integer · no URL · opcional

Número por página, no máximo 100.
page[cursor] string · no URL · opcional

O next_cursor da página anterior.
sort string · no URL · opcional

Ordenar; um hífen antes inverte a ordem.

Valores: created_at, -created_at, valid_on, -valid_on, used_at, -used_at, id, -id
filter[status] string · no URL · opcional

Filtrar por status.
filter[valid_on] string · no URL · opcional

Filtrar por valid_on.
filter[product_id] string · no URL · opcional

Filtrar por product_id.
filter[order] string · no URL · opcional

Filtrar por order.
filter[from] string · no URL · opcional

Filtrar por from.
filter[to] string · no URL · opcional

Filtrar por to.

Exemplo de pedido

curl

curl "https://passavo.eu/api/v1/tickets" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->get('https://passavo.eu/api/v1/tickets');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/tickets', {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.get("https://passavo.eu/api/v1/tickets", headers=headers)
data = response.json()["data"]

Respostas

200 — Os bilhetes, com filtros para a lista da porta.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": [
        {
            "id": "9f1c0b4a-6b2f-4a1b-9c7e-1f2d3e4a5b6c",
            "order_line_id": 1,
            "order_id": "string",
            "product_id": 1,
            "slot_id": 1,
            "description": "string",
            "holder_name": "string",
            "status": "valid",
            "valid_on": "2026-09-21",
            "is_scannable": true,
            "used_at": "2026-09-21T14:00:00+02:00",
            "created_at": "2026-09-21T14:00:00+02:00",
            "updated_at": "2026-09-21T14:00:00+02:00"
        }
    ],
    "meta": {
        "next_cursor": "string"
    }
}

GET /api/v1/tickets/{uuid} #

Um bilhete.

Permissão necessária: read

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
uuid string · no caminho · obrigatório

O uuid do bilhete.

Exemplo de pedido

curl

curl "https://passavo.eu/api/v1/tickets/12" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->get('https://passavo.eu/api/v1/tickets/12');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/tickets/12', {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.get("https://passavo.eu/api/v1/tickets/12", headers=headers)
data = response.json()["data"]

Respostas

200 — Um bilhete.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": {
        "id": "9f1c0b4a-6b2f-4a1b-9c7e-1f2d3e4a5b6c",
        "order_line_id": 1,
        "order_id": "string",
        "product_id": 1,
        "slot_id": 1,
        "description": "string",
        "holder_name": "string",
        "status": "valid",
        "valid_on": "2026-09-21",
        "is_scannable": true,
        "used_at": "2026-09-21T14:00:00+02:00",
        "created_at": "2026-09-21T14:00:00+02:00",
        "updated_at": "2026-09-21T14:00:00+02:00"
    }
}

GET /api/v1/tickets/{uuid}/pdf #

Uma ligação assinada para o PDF com os bilhetes.

Permissão necessária: read

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
uuid string · no caminho · obrigatório

O uuid do bilhete.

Exemplo de pedido

curl

curl "https://passavo.eu/api/v1/tickets/12/pdf" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->get('https://passavo.eu/api/v1/tickets/12/pdf');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/tickets/12/pdf', {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.get("https://passavo.eu/api/v1/tickets/12/pdf", headers=headers)
data = response.json()["data"]

Respostas

200 — Uma ligação assinada para o PDF com os bilhetes.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": {
        "ticket_id": "9f1c0b4a-6b2f-4a1b-9c7e-1f2d3e4a5b6c",
        "order_id": "string",
        "url": "https://passavo.eu",
        "expires_at": "2026-09-21T14:00:00+02:00"
    }
}

POST /api/v1/tickets/{uuid}/resend #

Reenviar o e-mail de confirmação.

Permissão necessária: write

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
Idempotency-Key string · como cabeçalho · opcional

Repita um pedido em segurança: a mesma chave com o mesmo conteúdo dá a mesma resposta.
uuid string · no caminho · obrigatório

O uuid do bilhete.

Exemplo de pedido

curl

curl -X POST "https://passavo.eu/api/v1/tickets/12/resend" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->post('https://passavo.eu/api/v1/tickets/12/resend');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/tickets/12/resend', {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.post("https://passavo.eu/api/v1/tickets/12/resend", headers=headers)
data = response.json()["data"]

Respostas

200 — Reenviar o e-mail de confirmação.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
409 — A encomenda não está num estado em que isto seja possível.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": {
        "ticket_id": "9f1c0b4a-6b2f-4a1b-9c7e-1f2d3e4a5b6c",
        "order_id": "string",
        "sent_to": "string"
    }
}

POST /api/v1/tickets/{uuid}/void #

Invalidar o bilhete.

Permissão necessária: write

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
Idempotency-Key string · como cabeçalho · opcional

Repita um pedido em segurança: a mesma chave com o mesmo conteúdo dá a mesma resposta.
uuid string · no caminho · obrigatório

O uuid do bilhete.

Exemplo de pedido

curl

curl -X POST "https://passavo.eu/api/v1/tickets/12/void" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->post('https://passavo.eu/api/v1/tickets/12/void');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/tickets/12/void', {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.post("https://passavo.eu/api/v1/tickets/12/void", headers=headers)
data = response.json()["data"]

Respostas

200 — Invalidar o bilhete.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
409 — A encomenda não está num estado em que isto seja possível.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": {
        "id": "9f1c0b4a-6b2f-4a1b-9c7e-1f2d3e4a5b6c",
        "order_line_id": 1,
        "order_id": "string",
        "product_id": 1,
        "slot_id": 1,
        "description": "string",
        "holder_name": "string",
        "status": "valid",
        "valid_on": "2026-09-21",
        "is_scannable": true,
        "used_at": "2026-09-21T14:00:00+02:00",
        "created_at": "2026-09-21T14:00:00+02:00",
        "updated_at": "2026-09-21T14:00:00+02:00"
    }
}

GET /api/v1/tickets/{uuid}/wallet #

Ligações assinadas para os passes da carteira.

Permissão necessária: read

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
uuid string · no caminho · obrigatório

O uuid do bilhete.

Exemplo de pedido

curl

curl "https://passavo.eu/api/v1/tickets/12/wallet" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->get('https://passavo.eu/api/v1/tickets/12/wallet');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/tickets/12/wallet', {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.get("https://passavo.eu/api/v1/tickets/12/wallet", headers=headers)
data = response.json()["data"]

Respostas

200 — Ligações assinadas para os passes da carteira.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": {
        "ticket_id": "9f1c0b4a-6b2f-4a1b-9c7e-1f2d3e4a5b6c",
        "apple_url": "https://passavo.eu",
        "google_url": "https://passavo.eu",
        "expires_at": "2026-09-21T14:00:00+02:00"
    }
}

Entrada

Check-in à entrada.

GET /api/v1/check-ins #

Os check-ins à entrada.

Permissão necessária: read

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
page[size] integer · no URL · opcional

Número por página, no máximo 100.
page[cursor] string · no URL · opcional

O next_cursor da página anterior.
sort string · no URL · opcional

Ordenar; um hífen antes inverte a ordem.

Valores: scanned_at, -scanned_at, created_at, -created_at, id, -id
filter[result] string · no URL · opcional

Filtrar por result.
filter[from] string · no URL · opcional

Filtrar por from.
filter[to] string · no URL · opcional

Filtrar por to.
filter[ticket] string · no URL · opcional

Filtrar por ticket.

Exemplo de pedido

curl

curl "https://passavo.eu/api/v1/check-ins" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->get('https://passavo.eu/api/v1/check-ins');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/check-ins', {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.get("https://passavo.eu/api/v1/check-ins", headers=headers)
data = response.json()["data"]

Respostas

200 — Os check-ins à entrada.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": [
        {
            "id": 1,
            "result": "ok",
            "ticket_id": "9f1c0b4a-6b2f-4a1b-9c7e-1f2d3e4a5b6c",
            "pass_id": "9f1c0b4a-6b2f-4a1b-9c7e-1f2d3e4a5b6c",
            "scanned_at": "2026-09-21T14:00:00+02:00",
            "undone_at": "2026-09-21T14:00:00+02:00",
            "by": {
                "type": "api_key",
                "name": "string"
            },
            "created_at": "2026-09-21T14:00:00+02:00"
        }
    ],
    "meta": {
        "next_cursor": "string"
    }
}

POST /api/v1/check-ins #

Deixar alguém entrar.

Permissão necessária: write

Este pedido envia um body.

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
Idempotency-Key string · como cabeçalho · opcional

Repita um pedido em segurança: a mesma chave com o mesmo conteúdo dá a mesma resposta.

Exemplo de pedido

curl

curl -X POST "https://passavo.eu/api/v1/check-ins" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

PHP

use Illuminate\Support\Facades\Http;
use Illuminate\Support\Str;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->withHeader('Idempotency-Key', (string) Str::uuid())
    ->post('https://passavo.eu/api/v1/check-ins', []);

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/check-ins', {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({}),
});

const { data } = await response.json();

Python

import uuid

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY", "Idempotency-Key": str(uuid.uuid4())}
response = requests.post("https://passavo.eu/api/v1/check-ins", headers=headers, json={})
data = response.json()["data"]

Respostas

201 — Deixar alguém entrar.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
409 — Este código já fez check-in.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": {
        "id": 1,
        "result": "ok",
        "ticket_id": "9f1c0b4a-6b2f-4a1b-9c7e-1f2d3e4a5b6c",
        "pass_id": "9f1c0b4a-6b2f-4a1b-9c7e-1f2d3e4a5b6c",
        "scanned_at": "2026-09-21T14:00:00+02:00",
        "undone_at": "2026-09-21T14:00:00+02:00",
        "by": {
            "type": "api_key",
            "name": "string"
        },
        "created_at": "2026-09-21T14:00:00+02:00"
    }
}

DELETE /api/v1/check-ins/{id} #

Anular um check-in.

Permissão necessária: write

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
Idempotency-Key string · como cabeçalho · opcional

Repita um pedido em segurança: a mesma chave com o mesmo conteúdo dá a mesma resposta.
id integer · no caminho · obrigatório

O id do check-in.

Exemplo de pedido

curl

curl -X DELETE "https://passavo.eu/api/v1/check-ins/12" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->delete('https://passavo.eu/api/v1/check-ins/12');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/check-ins/12', {
  method: 'DELETE',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.delete("https://passavo.eu/api/v1/check-ins/12", headers=headers)
data = response.json()["data"]

Respostas

200 — Anular um check-in.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
409 — A encomenda não está num estado em que isto seja possível.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": {
        "id": 1,
        "result": "ok",
        "ticket_id": "9f1c0b4a-6b2f-4a1b-9c7e-1f2d3e4a5b6c",
        "pass_id": "9f1c0b4a-6b2f-4a1b-9c7e-1f2d3e4a5b6c",
        "scanned_at": "2026-09-21T14:00:00+02:00",
        "undone_at": "2026-09-21T14:00:00+02:00",
        "by": {
            "type": "api_key",
            "name": "string"
        },
        "created_at": "2026-09-21T14:00:00+02:00"
    }
}

Clientes

Compradores, resumidos a partir das encomendas.

GET /api/v1/customers #

Os compradores, resumidos por endereço de e-mail.

Permissão necessária: read

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
page[size] integer · no URL · opcional

Número por página, no máximo 100.
page[cursor] string · no URL · opcional

O next_cursor da página anterior.
sort string · no URL · opcional

Ordenar; um hífen antes inverte a ordem.

Valores: last_order_at, -last_order_at
filter[email] string · no URL · opcional

Filtrar por email.
filter[search] string · no URL · opcional

Filtrar por search.

Exemplo de pedido

curl

curl "https://passavo.eu/api/v1/customers" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->get('https://passavo.eu/api/v1/customers');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/customers', {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.get("https://passavo.eu/api/v1/customers", headers=headers)
data = response.json()["data"]

Respostas

200 — Os compradores, resumidos por endereço de e-mail.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": [
        {
            "id": "string",
            "email": "string",
            "name": "string",
            "orders": 1,
            "spent": {
                "amount_cent": 1,
                "currency": "EUR"
            },
            "first_order_at": "2026-09-21T14:00:00+02:00",
            "last_order_at": "2026-09-21T14:00:00+02:00"
        }
    ],
    "meta": {
        "next_cursor": "string"
    }
}

GET /api/v1/customers/{email}/orders #

As encomendas de um endereço de e-mail.

Permissão necessária: read

Parâmetros

email string · no caminho · obrigatório

O endereço de e-mail do comprador, codificado para URL.
Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
page[size] integer · no URL · opcional

Número por página, no máximo 100.
page[cursor] string · no URL · opcional

O next_cursor da página anterior.
sort string · no URL · opcional

Ordenar; um hífen antes inverte a ordem.

Valores: created_at, -created_at, paid_at, -paid_at, id, -id
filter[status] string · no URL · opcional

Filtrar por status.
include string · no URL · opcional

Incluir estas relações: lines, tickets, payments, refunds.

Valores: lines, tickets, payments, refunds

Exemplo de pedido

curl

curl "https://passavo.eu/api/v1/customers/12/orders" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->get('https://passavo.eu/api/v1/customers/12/orders');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/customers/12/orders', {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.get("https://passavo.eu/api/v1/customers/12/orders", headers=headers)
data = response.json()["data"]

Respostas

200 — As encomendas de um endereço de e-mail.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": [
        {
            "id": "string",
            "reference": "string",
            "status": "draft",
            "channel": "online",
            "venue_id": 1,
            "buyer": {
                "name": "string",
                "email": "string",
                "phone": "string",
                "locale": "string"
            },
            "totals": {
                "subtotal": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "discount": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "discount_code": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "voucher": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "vat": {
                    "amount_cent": 1,
                    "currency": "EUR"
                },
                "total": {
                    "amount_cent": 1,
                    "currency": "EUR"
                }
            },
            "discount_code": "string",
            "voucher_code": "string",
            "reserved_until": "2026-09-21T14:00:00+02:00",
            "sandbox": true,
            "test": true,
            "payment": {
                "provider": "string",
                "provider_ref": "string",
                "redirect_url": "string",
                "qr_code_url": "string"
            },
            "paid_at": "2026-09-21T14:00:00+02:00",
            "cancelled_at": "2026-09-21T14:00:00+02:00",
            "lines": [
                {
                    "id": 1,
                    "product_id": 1,
                    "slot_id": 1,
                    "description": "string",
                    "quantity": 1,
                    "unit_price": {
                        "amount_cent": 1,
                        "currency": "EUR"
                    },
                    "line_total": {
                        "amount_cent": 1,
                        "currency": "EUR"
                    },
                    "vat_rate_bp": 1,
                    "vat": {
                        "amount_cent": 1,
                        "currency": "EUR"
                    },
                    "valid_on": "2026-09-21",
                    "created_at": "2026-09-21T14:00:00+02:00"
                }
            ],
            "tickets": [
                {
                    "id": "9f1c0b4a-6b2f-4a1b-9c7e-1f2d3e4a5b6c",
                    "order_line_id": 1,
                    "order_id": "string",
                    "product_id": 1,
                    "slot_id": 1,
                    "description": "string",
                    "holder_name": "string",
                    "status": "valid",
                    "valid_on": "2026-09-21",
                    "is_scannable": true,
                    "used_at": "2026-09-21T14:00:00+02:00",
                    "created_at": "2026-09-21T14:00:00+02:00",
                    "updated_at": "2026-09-21T14:00:00+02:00"
                }
            ],
            "payments": [
                {
                    "id": 1,
                    "provider": "string",
                    "provider_ref": "string",
                    "method": "string",
                    "amount": {
                        "amount_cent": 1,
                        "currency": "EUR"
                    },
                    "status": "string",
                    "paid_at": "2026-09-21T14:00:00+02:00",
                    "created_at": "2026-09-21T14:00:00+02:00"
                }
            ],
            "refunds": [
                {
                    "id": 1,
                    "payment_id": 1,
                    "provider": "string",
                    "provider_ref": "string",
                    "amount": {
                        "amount_cent": 1,
                        "currency": "EUR"
                    },
                    "status": "pending",
                    "reason": "string",
                    "refunded_at": "2026-09-21T14:00:00+02:00",
                    "created_at": "2026-09-21T14:00:00+02:00"
                }
            ],
            "created_at": "2026-09-21T14:00:00+02:00",
            "updated_at": "2026-09-21T14:00:00+02:00"
        }
    ],
    "meta": {
        "next_cursor": "string"
    }
}

Webhooks

Mensagens que enviamos para o seu servidor.

GET /api/v1/webhook-deliveries #

O registo de entregas dos últimos trinta dias.

Permissão necessária: webhooks

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
page[size] integer · no URL · opcional

Número por página, no máximo 100.
page[cursor] string · no URL · opcional

O next_cursor da página anterior.
sort string · no URL · opcional

Ordenar; um hífen antes inverte a ordem.

Valores: created_at, -created_at, id, -id
filter[endpoint] string · no URL · opcional

Filtrar por endpoint.
filter[status] string · no URL · opcional

Filtrar por status.
filter[event] string · no URL · opcional

Filtrar por event.

Exemplo de pedido

curl

curl "https://passavo.eu/api/v1/webhook-deliveries" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->get('https://passavo.eu/api/v1/webhook-deliveries');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/webhook-deliveries', {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.get("https://passavo.eu/api/v1/webhook-deliveries", headers=headers)
data = response.json()["data"]

Respostas

200 — O registo de entregas dos últimos trinta dias.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": [
        {
            "id": 1,
            "event_id": "string",
            "event": "order.created",
            "endpoint_id": 1,
            "status": "pending",
            "sandbox": true,
            "attempts": 1,
            "last_status_code": 1,
            "body_excerpt": "string",
            "error": "string",
            "next_attempt_at": "2026-09-21T14:00:00+02:00",
            "delivered_at": "2026-09-21T14:00:00+02:00",
            "payload": {
                "id": "string",
                "type": "order.created",
                "created_at": "2026-09-21T14:00:00+02:00",
                "organisation_id": 1,
                "sandbox": true,
                "data": {}
            },
            "created_at": "2026-09-21T14:00:00+02:00"
        }
    ],
    "meta": {
        "next_cursor": "string"
    }
}

GET /api/v1/webhook-deliveries/{id} #

Uma entrega.

Permissão necessária: webhooks

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
id integer · no caminho · obrigatório

O id da entrega.

Exemplo de pedido

curl

curl "https://passavo.eu/api/v1/webhook-deliveries/12" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->get('https://passavo.eu/api/v1/webhook-deliveries/12');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/webhook-deliveries/12', {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.get("https://passavo.eu/api/v1/webhook-deliveries/12", headers=headers)
data = response.json()["data"]

Respostas

200 — Uma entrega.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
409 — Esta Idempotency-Key já foi utilizada noutro pedido.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": {
        "id": 1,
        "event_id": "string",
        "event": "order.created",
        "endpoint_id": 1,
        "status": "pending",
        "sandbox": true,
        "attempts": 1,
        "last_status_code": 1,
        "body_excerpt": "string",
        "error": "string",
        "next_attempt_at": "2026-09-21T14:00:00+02:00",
        "delivered_at": "2026-09-21T14:00:00+02:00",
        "payload": {
            "id": "string",
            "type": "order.created",
            "created_at": "2026-09-21T14:00:00+02:00",
            "organisation_id": 1,
            "sandbox": true,
            "data": {}
        },
        "created_at": "2026-09-21T14:00:00+02:00"
    }
}

POST /api/v1/webhook-deliveries/{id}/retry #

Reenviar uma entrega falhada.

Permissão necessária: webhooks

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
id integer · no caminho · obrigatório

O id da entrega.

Exemplo de pedido

curl

curl -X POST "https://passavo.eu/api/v1/webhook-deliveries/12/retry" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->post('https://passavo.eu/api/v1/webhook-deliveries/12/retry');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/webhook-deliveries/12/retry', {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.post("https://passavo.eu/api/v1/webhook-deliveries/12/retry", headers=headers)
data = response.json()["data"]

Respostas

202 — Reenviar uma entrega falhada.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
409 — Esta Idempotency-Key já foi utilizada noutro pedido.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": {
        "id": 1,
        "event_id": "string",
        "event": "order.created",
        "endpoint_id": 1,
        "status": "pending",
        "sandbox": true,
        "attempts": 1,
        "last_status_code": 1,
        "body_excerpt": "string",
        "error": "string",
        "next_attempt_at": "2026-09-21T14:00:00+02:00",
        "delivered_at": "2026-09-21T14:00:00+02:00",
        "payload": {
            "id": "string",
            "type": "order.created",
            "created_at": "2026-09-21T14:00:00+02:00",
            "organisation_id": 1,
            "sandbox": true,
            "data": {}
        },
        "created_at": "2026-09-21T14:00:00+02:00"
    }
}

GET /api/v1/webhook-endpoints #

Os destinos onde é notificado.

Permissão necessária: webhooks

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
page[size] integer · no URL · opcional

Número por página, no máximo 100.
page[cursor] string · no URL · opcional

O next_cursor da página anterior.
sort string · no URL · opcional

Ordenar; um hífen antes inverte a ordem.

Valores: created_at, -created_at, id, -id
filter[status] string · no URL · opcional

Filtrar por status.
filter[sandbox] string · no URL · opcional

Filtrar por sandbox.

Exemplo de pedido

curl

curl "https://passavo.eu/api/v1/webhook-endpoints" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->get('https://passavo.eu/api/v1/webhook-endpoints');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/webhook-endpoints', {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.get("https://passavo.eu/api/v1/webhook-endpoints", headers=headers)
data = response.json()["data"]

Respostas

200 — Os destinos onde é notificado.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": [
        {
            "id": 1,
            "url": "https://passavo.eu",
            "description": "string",
            "events": [
                "order.created"
            ],
            "status": "active",
            "sandbox": true,
            "consecutive_failures": 1,
            "last_delivery_at": "2026-09-21T14:00:00+02:00",
            "last_status_code": 1,
            "disabled_at": "2026-09-21T14:00:00+02:00",
            "disabled_reason": "string",
            "created_at": "2026-09-21T14:00:00+02:00",
            "updated_at": "2026-09-21T14:00:00+02:00"
        }
    ],
    "meta": {
        "next_cursor": "string"
    }
}

POST /api/v1/webhook-endpoints #

Criar um destino; o segredo é devolvido uma única vez.

Permissão necessária: webhooks

Este pedido envia um body.

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.

Exemplo de pedido

curl

curl -X POST "https://passavo.eu/api/v1/webhook-endpoints" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

PHP

use Illuminate\Support\Facades\Http;
use Illuminate\Support\Str;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->withHeader('Idempotency-Key', (string) Str::uuid())
    ->post('https://passavo.eu/api/v1/webhook-endpoints', []);

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/webhook-endpoints', {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({}),
});

const { data } = await response.json();

Python

import uuid

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY", "Idempotency-Key": str(uuid.uuid4())}
response = requests.post("https://passavo.eu/api/v1/webhook-endpoints", headers=headers, json={})
data = response.json()["data"]

Respostas

201 — Criar um destino; o segredo é devolvido uma única vez.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
409 — Esta Idempotency-Key já foi utilizada noutro pedido.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": {
        "id": 1,
        "url": "https://passavo.eu",
        "description": "string",
        "events": [
            "order.created"
        ],
        "status": "active",
        "sandbox": true,
        "consecutive_failures": 1,
        "last_delivery_at": "2026-09-21T14:00:00+02:00",
        "last_status_code": 1,
        "disabled_at": "2026-09-21T14:00:00+02:00",
        "disabled_reason": "string",
        "created_at": "2026-09-21T14:00:00+02:00",
        "updated_at": "2026-09-21T14:00:00+02:00"
    }
}

GET /api/v1/webhook-endpoints/{id} #

Um destino.

Permissão necessária: webhooks

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
id integer · no caminho · obrigatório

O id do destino.

Exemplo de pedido

curl

curl "https://passavo.eu/api/v1/webhook-endpoints/12" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->get('https://passavo.eu/api/v1/webhook-endpoints/12');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/webhook-endpoints/12', {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.get("https://passavo.eu/api/v1/webhook-endpoints/12", headers=headers)
data = response.json()["data"]

Respostas

200 — Um destino.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
409 — Esta Idempotency-Key já foi utilizada noutro pedido.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": {
        "id": 1,
        "url": "https://passavo.eu",
        "description": "string",
        "events": [
            "order.created"
        ],
        "status": "active",
        "sandbox": true,
        "consecutive_failures": 1,
        "last_delivery_at": "2026-09-21T14:00:00+02:00",
        "last_status_code": 1,
        "disabled_at": "2026-09-21T14:00:00+02:00",
        "disabled_reason": "string",
        "created_at": "2026-09-21T14:00:00+02:00",
        "updated_at": "2026-09-21T14:00:00+02:00"
    }
}

PATCH /api/v1/webhook-endpoints/{id} #

Alterar um destino.

Permissão necessária: webhooks

Este pedido envia um body.

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
id integer · no caminho · obrigatório

O id do destino.

Exemplo de pedido

curl

curl -X PATCH "https://passavo.eu/api/v1/webhook-endpoints/12" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

PHP

use Illuminate\Support\Facades\Http;
use Illuminate\Support\Str;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->withHeader('Idempotency-Key', (string) Str::uuid())
    ->patch('https://passavo.eu/api/v1/webhook-endpoints/12', []);

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/webhook-endpoints/12', {
  method: 'PATCH',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({}),
});

const { data } = await response.json();

Python

import uuid

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY", "Idempotency-Key": str(uuid.uuid4())}
response = requests.patch("https://passavo.eu/api/v1/webhook-endpoints/12", headers=headers, json={})
data = response.json()["data"]

Respostas

200 — Alterar um destino.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
409 — Esta Idempotency-Key já foi utilizada noutro pedido.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": {
        "id": 1,
        "url": "https://passavo.eu",
        "description": "string",
        "events": [
            "order.created"
        ],
        "status": "active",
        "sandbox": true,
        "consecutive_failures": 1,
        "last_delivery_at": "2026-09-21T14:00:00+02:00",
        "last_status_code": 1,
        "disabled_at": "2026-09-21T14:00:00+02:00",
        "disabled_reason": "string",
        "created_at": "2026-09-21T14:00:00+02:00",
        "updated_at": "2026-09-21T14:00:00+02:00"
    }
}

DELETE /api/v1/webhook-endpoints/{id} #

Eliminar um destino, com o respetivo registo de entregas.

Permissão necessária: webhooks

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
id integer · no caminho · obrigatório

O id do destino.

Exemplo de pedido

curl

curl -X DELETE "https://passavo.eu/api/v1/webhook-endpoints/12" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->delete('https://passavo.eu/api/v1/webhook-endpoints/12');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/webhook-endpoints/12', {
  method: 'DELETE',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.delete("https://passavo.eu/api/v1/webhook-endpoints/12", headers=headers)
data = response.json()["data"]

Respostas

204 — Eliminar um destino, com o respetivo registo de entregas.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

POST /api/v1/webhook-endpoints/{id}/rotate-secret #

Gerar um novo segredo; o antigo deixa de funcionar de imediato.

Permissão necessária: webhooks

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
id integer · no caminho · obrigatório

O id do destino.

Exemplo de pedido

curl

curl -X POST "https://passavo.eu/api/v1/webhook-endpoints/12/rotate-secret" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->post('https://passavo.eu/api/v1/webhook-endpoints/12/rotate-secret');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/webhook-endpoints/12/rotate-secret', {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.post("https://passavo.eu/api/v1/webhook-endpoints/12/rotate-secret", headers=headers)
data = response.json()["data"]

Respostas

200 — Gerar um novo segredo; o antigo deixa de funcionar de imediato.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
409 — Esta Idempotency-Key já foi utilizada noutro pedido.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": {
        "id": 1,
        "url": "https://passavo.eu",
        "description": "string",
        "events": [
            "order.created"
        ],
        "status": "active",
        "sandbox": true,
        "consecutive_failures": 1,
        "last_delivery_at": "2026-09-21T14:00:00+02:00",
        "last_status_code": 1,
        "disabled_at": "2026-09-21T14:00:00+02:00",
        "disabled_reason": "string",
        "created_at": "2026-09-21T14:00:00+02:00",
        "updated_at": "2026-09-21T14:00:00+02:00"
    }
}

GET /api/v1/webhook-endpoints/{id}/sample #

Um exemplo assinado para testar a sua própria verificação.

Permissão necessária: webhooks

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
id integer · no caminho · obrigatório

O id do destino.
event string · no URL · opcional

Que evento o exemplo simula; por omissão, test.ping.

Valores: order.created, order.paid, order.cancelled, order.refunded, ticket.issued, ticket.scanned, ticket.voided, slot.sold_out, slot.reopened, voucher.issued, voucher.redeemed, pass.issued, pos.session_closed, invoice.issued, test.ping

Exemplo de pedido

curl

curl "https://passavo.eu/api/v1/webhook-endpoints/12/sample" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->get('https://passavo.eu/api/v1/webhook-endpoints/12/sample');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/webhook-endpoints/12/sample', {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.get("https://passavo.eu/api/v1/webhook-endpoints/12/sample", headers=headers)
data = response.json()["data"]

Respostas

200 — Um exemplo assinado para testar a sua própria verificação.
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
409 — Esta Idempotency-Key já foi utilizada noutro pedido.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": {
        "endpoint_id": 1,
        "event": "string",
        "headers": {},
        "body": "string",
        "payload": {
            "id": "string",
            "type": "order.created",
            "created_at": "2026-09-21T14:00:00+02:00",
            "organisation_id": 1,
            "sandbox": true,
            "data": {}
        },
        "signature": {
            "header": "string",
            "timestamp": 1,
            "scheme": "string",
            "signed_payload": "string",
            "tolerance_seconds": 1
        }
    }
}

POST /api/v1/webhook-endpoints/{id}/test #

Enviar uma mensagem de teste (test.ping).

Permissão necessária: webhooks

Parâmetros

Accept-Language string · como cabeçalho · opcional

O idioma dos campos traduzidos, com recurso ao idioma da organização.
id integer · no caminho · obrigatório

O id do destino.

Exemplo de pedido

curl

curl -X POST "https://passavo.eu/api/v1/webhook-endpoints/12/test" \
  -H "Authorization: Bearer pv_live_YOUR_API_KEY" \
  -H "Accept: application/json"

PHP

use Illuminate\Support\Facades\Http;

$response = Http::acceptJson()
    ->withToken('pv_live_YOUR_API_KEY')
    ->post('https://passavo.eu/api/v1/webhook-endpoints/12/test');

$data = $response->json('data');

JavaScript

const response = await fetch('https://passavo.eu/api/v1/webhook-endpoints/12/test', {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer pv_live_YOUR_API_KEY',
  },
});

const { data } = await response.json();

Python

import requests

headers = {"Accept": "application/json", "Authorization": "Bearer pv_live_YOUR_API_KEY"}
response = requests.post("https://passavo.eu/api/v1/webhook-endpoints/12/test", headers=headers)
data = response.json()["data"]

Respostas

202 — Enviar uma mensagem de teste (test.ping).
401 — Esta chave não é válida.
403 — Esta chave não tem permissão para isto.
404 — Não encontrado.
409 — Esta Idempotency-Key já foi utilizada noutro pedido.
422 — O pedido não está correto.
429 — Demasiados pedidos. Tente novamente dentro de 60 segundos.

Exemplo de resposta

{
    "data": {
        "endpoint_id": 1,
        "event": "string",
        "delivery_id": 1,
        "event_id": "string"
    }
}