Skip to main content
GET
/
organizations
/
{organizationId}
/
vouchers
/
{voucherId}
Buscar Voucher
curl --request GET \
  --url https://api.example.com/organizations/{organizationId}/vouchers/{voucherId} \
  --header 'Authorization: <authorization>'
{
  "voucherId": "019525fd-e4b8-7cb0-b8d4-0e2f4a6c8d0a",
  "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
  "externalRef": "ext_ref_abc123",
  "name": "Welcome Credit",
  "amount": 10000,
  "currency": "BRL",
  "effectiveAt": "2026-01-01T00:00:00.000Z",
  "expiresAt": "2026-12-31T23:59:59.000Z",
  "amountRedeemed": 2500,
  "status": "ACTIVE",
  "createdBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "deletedBy": null,
  "deletedAt": null
}
Requer permissao voucher:read.

​
Headers

​
Authorization
string
required
Bearer token.

​
Parametros de Path

​
organizationId
string
required
UUID da organizacao.
​
voucherId
string
required
UUID do voucher.

​
Resposta

​
voucherId
string
UUID do voucher.
​
organizationId
string
UUID da organizacao.
​
externalRef
string
Referencia externa.
​
name
string
Nome do voucher.
​
amount
integer
Valor do credito em centavos.
​
currency
string
Codigo da moeda.
​
effectiveAt
string
Data de vigencia.
​
expiresAt
string
Data de expiracao.
​
amountRedeemed
integer
Valor resgatado em centavos.
​
status
string
Status do voucher.
​
createdBy
string
Identificador do criador.
​
createdAt
string
Timestamp de criacao.
​
updatedBy
string
Identificador do ultimo atualizador.
​
updatedAt
string
Timestamp da ultima atualizacao.
​
deletedBy
string
Deleter identifier.
​
deletedAt
string
Deletion timestamp.
{
  "voucherId": "019525fd-e4b8-7cb0-b8d4-0e2f4a6c8d0a",
  "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
  "externalRef": "ext_ref_abc123",
  "name": "Welcome Credit",
  "amount": 10000,
  "currency": "BRL",
  "effectiveAt": "2026-01-01T00:00:00.000Z",
  "expiresAt": "2026-12-31T23:59:59.000Z",
  "amountRedeemed": 2500,
  "status": "ACTIVE",
  "createdBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "deletedBy": null,
  "deletedAt": null
}

​
Exemplos de Codigo

curl https://api.awsales.io/admin/organizations/019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2/vouchers/019525fd-e4b8-7cb0-b8d4-0e2f4a6c8d0a \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

​
Codigos de Erro

StatusCodigoDescricao
400validation_errorEntrada invalida ou campos obrigatorios ausentes
401unauthorizedAutenticacao ausente ou invalida
403forbiddenPermissoes insuficientes
404organization.not_foundOrganizacao nao encontrada
404voucher.not_foundVoucher nao encontrado
500internal_server_errorOcorreu um erro inesperado