HandyPay Pagamentos de Ecommerce API

REST API público para integrar pagamentos do HandyPay em qualquer aplicativo. Autentique com as chaves da API, gerencie produtos, clientes, sessões de pagamento, assinaturas e receba notificações do webhook.

URL Base

https://api.handypay.me/api/v1

javascript

Versão do API: 2025-01-01 — devolvidas no X-API-Version cabeçalho em cada resposta.

Início Rápido

Põe-te a funcionar em menos de um minuto. Pegue uma chave do API, configure o cliente, faça um pedido.

Obtenha a sua chave API

Gerar as chaves a partir do Portal do lojista. Todos os pedidos requerem um token do portador na Authorization Cabeçalho.

Authorization: Bearer hp_live_your_api_key_here

javascript

hp_test_Caixa de areia

hp_live_Produção

Configurar o cliente API

Crie uma função auxiliar reutilizável. Ela funciona com Next.js, React Native e Node.js.

lib/handypay.ts

const HANDYPAY_API_URL = "https://api.handypay.me/api/v1";
const HANDYPAY_API_KEY = process.env.HANDYPAY_API_KEY!;

async function handypay<T = any>(
  endpoint: string,
  options: RequestInit = {}
): Promise<T> {
  const res = await fetch(`${HANDYPAY_API_URL}${endpoint}`, {
    ...options,
    headers: {
      Authorization: `Bearer ${HANDYPAY_API_KEY}`,
      "Content-Type": "application/json",
      ...options.headers,
    },
  });

  const json = await res.json();

  if (!json.success) {
    throw new Error(`[${json.error.code}] ${json.error.message}`);
  }

  return json.data;
}

export { handypay };

javascript

Guardar a tua chave .env como HANDYPAY_API_KEY. Nunca o exponhas ao lado do cliente.

Faça o seu primeiro pedido

Liste seus produtos para verificar se tudo funciona.

TypeScript

const products = await handypay("/products?limit=10");
console.log(products);

javascript

Equivalência cURL

cURL

curl https://api.handypay.me/api/v1/products \
  -H "Authorization: Bearer hp_test_your_api_key_here"

javascript

Você deve voltar uma resposta do JSON com "success": true e os dados do seu produto.

Limites de Taxa

1.000 pedidos por hora por chave do API. Excedendo o limite retorna 429 com uma Retry-After Cabeçalho.

O que você pode construir

Pagamentos unidireccionais

Crie produtos e hospede sessões de checkout para compras individuais.

Assinaturas

Cobrança recorrente com intervalos flexíveis, testes e cancelamento.

Multimoeda

Aceite o USD, JMD, CAD e mais em 10 países.

Webhooks

Notificações de eventos em tempo real para pagamento e ciclo de vida de assinatura.

Intervalos de faturamento

Os produtos de assinatura suportam os seguintes intervalos de faturamento recorrentes.

weeklybi-weeklymonthlybi-monthlyquarterlysemi-annualannual

Passos Próximos

Consulte a referência completa da API para ver os detalhes dos endpoints ou vá direto às receitas de integração para Next.js, React Native e Express.

HandyPay Pagamentos de Ecommerce API

URL Base

https://api.handypay.me/api/v1

javascript

Versão do API: 2025-01-01 — devolvidas no X-API-Version cabeçalho em cada resposta.

Início Rápido

Põe-te a funcionar em menos de um minuto. Pegue uma chave do API, configure o cliente, faça um pedido.

Obtenha a sua chave API

Gerar as chaves a partir do Portal do lojista. Todos os pedidos requerem um token do portador na Authorization Cabeçalho.

Authorization: Bearer hp_live_your_api_key_here

javascript

hp_test_Caixa de areia

hp_live_Produção

Configurar o cliente API

Crie uma função auxiliar reutilizável. Ela funciona com Next.js, React Native e Node.js.

lib/handypay.ts

const HANDYPAY_API_URL = "https://api.handypay.me/api/v1";
const HANDYPAY_API_KEY = process.env.HANDYPAY_API_KEY!;

async function handypay<T = any>(
  endpoint: string,
  options: RequestInit = {}
): Promise<T> {
  const res = await fetch(`${HANDYPAY_API_URL}${endpoint}`, {
    ...options,
    headers: {
      Authorization: `Bearer ${HANDYPAY_API_KEY}`,
      "Content-Type": "application/json",
      ...options.headers,
    },
  });

  const json = await res.json();

  if (!json.success) {
    throw new Error(`[${json.error.code}] ${json.error.message}`);
  }

  return json.data;
}

export { handypay };

javascript

Guardar a tua chave .env como HANDYPAY_API_KEY. Nunca o exponhas ao lado do cliente.

Faça o seu primeiro pedido

Liste seus produtos para verificar se tudo funciona.

TypeScript

const products = await handypay("/products?limit=10");
console.log(products);

javascript

Equivalência cURL

cURL

curl https://api.handypay.me/api/v1/products \
  -H "Authorization: Bearer hp_test_your_api_key_here"

javascript

Você deve voltar uma resposta do JSON com "success": true e os dados do seu produto.

Limites de Taxa

1.000 pedidos por hora por chave do API. Excedendo o limite retorna 429 com uma Retry-After Cabeçalho.

O que você pode construir

Pagamentos unidireccionais

Crie produtos e hospede sessões de checkout para compras individuais.

Assinaturas

Cobrança recorrente com intervalos flexíveis, testes e cancelamento.

Multimoeda

Aceite o USD, JMD, CAD e mais em 10 países.

Webhooks

Notificações de eventos em tempo real para pagamento e ciclo de vida de assinatura.

Intervalos de faturamento

Os produtos de assinatura suportam os seguintes intervalos de faturamento recorrentes.

weeklybi-weeklymonthlybi-monthlyquarterlysemi-annualannual

Passos Próximos

Consulte a referência completa da API para ver os detalhes dos endpoints ou vá direto às receitas de integração para Next.js, React Native e Express.

HandyPay Pagamentos de Ecommerce API

URL Base

https://api.handypay.me/api/v1

javascript

Versão do API: 2025-01-01 — devolvidas no X-API-Version cabeçalho em cada resposta.

Início Rápido

Põe-te a funcionar em menos de um minuto. Pegue uma chave do API, configure o cliente, faça um pedido.

Obtenha a sua chave API

Gerar as chaves a partir do Portal do lojista. Todos os pedidos requerem um token do portador na Authorization Cabeçalho.

Authorization: Bearer hp_live_your_api_key_here

javascript

hp_test_Caixa de areia

hp_live_Produção

Configurar o cliente API

Crie uma função auxiliar reutilizável. Ela funciona com Next.js, React Native e Node.js.

lib/handypay.ts

const HANDYPAY_API_URL = "https://api.handypay.me/api/v1";
const HANDYPAY_API_KEY = process.env.HANDYPAY_API_KEY!;

async function handypay<T = any>(
  endpoint: string,
  options: RequestInit = {}
): Promise<T> {
  const res = await fetch(`${HANDYPAY_API_URL}${endpoint}`, {
    ...options,
    headers: {
      Authorization: `Bearer ${HANDYPAY_API_KEY}`,
      "Content-Type": "application/json",
      ...options.headers,
    },
  });

  const json = await res.json();

  if (!json.success) {
    throw new Error(`[${json.error.code}] ${json.error.message}`);
  }

  return json.data;
}

export { handypay };

javascript

Guardar a tua chave .env como HANDYPAY_API_KEY. Nunca o exponhas ao lado do cliente.

Faça o seu primeiro pedido

Liste seus produtos para verificar se tudo funciona.

TypeScript

const products = await handypay("/products?limit=10");
console.log(products);

javascript

Equivalência cURL

cURL

curl https://api.handypay.me/api/v1/products \
  -H "Authorization: Bearer hp_test_your_api_key_here"

javascript

Você deve voltar uma resposta do JSON com "success": true e os dados do seu produto.

Limites de Taxa

1.000 pedidos por hora por chave do API. Excedendo o limite retorna 429 com uma Retry-After Cabeçalho.

O que você pode construir

Pagamentos unidireccionais

Crie produtos e hospede sessões de checkout para compras individuais.

Assinaturas

Cobrança recorrente com intervalos flexíveis, testes e cancelamento.

Multimoeda

Aceite o USD, JMD, CAD e mais em 10 países.

Webhooks

Notificações de eventos em tempo real para pagamento e ciclo de vida de assinatura.

Intervalos de faturamento

Os produtos de assinatura suportam os seguintes intervalos de faturamento recorrentes.

weeklybi-weeklymonthlybi-monthlyquarterlysemi-annualannual

Passos Próximos

Consulte a referência completa da API para ver os detalhes dos endpoints ou vá direto às receitas de integração para Next.js, React Native e Express.

HandyPay Pagamentos de Ecommerce API

URL Base

https://api.handypay.me/api/v1

javascript

Versão do API: 2025-01-01 — devolvidas no X-API-Version cabeçalho em cada resposta.

Início Rápido

Põe-te a funcionar em menos de um minuto. Pegue uma chave do API, configure o cliente, faça um pedido.

Obtenha a sua chave API

Gerar as chaves a partir do Portal do lojista. Todos os pedidos requerem um token do portador na Authorization Cabeçalho.

Authorization: Bearer hp_live_your_api_key_here

javascript

hp_test_Caixa de areia

hp_live_Produção

Configurar o cliente API

Crie uma função auxiliar reutilizável. Ela funciona com Next.js, React Native e Node.js.

lib/handypay.ts

const HANDYPAY_API_URL = "https://api.handypay.me/api/v1";
const HANDYPAY_API_KEY = process.env.HANDYPAY_API_KEY!;

async function handypay<T = any>(
  endpoint: string,
  options: RequestInit = {}
): Promise<T> {
  const res = await fetch(`${HANDYPAY_API_URL}${endpoint}`, {
    ...options,
    headers: {
      Authorization: `Bearer ${HANDYPAY_API_KEY}`,
      "Content-Type": "application/json",
      ...options.headers,
    },
  });

  const json = await res.json();

  if (!json.success) {
    throw new Error(`[${json.error.code}] ${json.error.message}`);
  }

  return json.data;
}

export { handypay };

javascript

Guardar a tua chave .env como HANDYPAY_API_KEY. Nunca o exponhas ao lado do cliente.

Faça o seu primeiro pedido

Liste seus produtos para verificar se tudo funciona.

TypeScript

const products = await handypay("/products?limit=10");
console.log(products);

javascript

Equivalência cURL

cURL

curl https://api.handypay.me/api/v1/products \
  -H "Authorization: Bearer hp_test_your_api_key_here"

javascript

Você deve voltar uma resposta do JSON com "success": true e os dados do seu produto.

Limites de Taxa

1.000 pedidos por hora por chave do API. Excedendo o limite retorna 429 com uma Retry-After Cabeçalho.

O que você pode construir

Pagamentos unidireccionais

Crie produtos e hospede sessões de checkout para compras individuais.

Assinaturas

Cobrança recorrente com intervalos flexíveis, testes e cancelamento.

Multimoeda

Aceite o USD, JMD, CAD e mais em 10 países.

Webhooks

Notificações de eventos em tempo real para pagamento e ciclo de vida de assinatura.

Intervalos de faturamento

Os produtos de assinatura suportam os seguintes intervalos de faturamento recorrentes.

weeklybi-weeklymonthlybi-monthlyquarterlysemi-annualannual

Passos Próximos

Consulte a referência completa da API para ver os detalhes dos endpoints ou vá direto às receitas de integração para Next.js, React Native e Express.

HandyPay Pagamentos de Ecommerce API

URL Base

https://api.handypay.me/api/v1

javascript

Versão do API: 2025-01-01 — devolvidas no X-API-Version cabeçalho em cada resposta.

Início Rápido

Põe-te a funcionar em menos de um minuto. Pegue uma chave do API, configure o cliente, faça um pedido.

Obtenha a sua chave API

Gerar as chaves a partir do Portal do lojista. Todos os pedidos requerem um token do portador na Authorization Cabeçalho.

Authorization: Bearer hp_live_your_api_key_here

javascript

hp_test_Caixa de areia

hp_live_Produção

Configurar o cliente API

Crie uma função auxiliar reutilizável. Ela funciona com Next.js, React Native e Node.js.

lib/handypay.ts

const HANDYPAY_API_URL = "https://api.handypay.me/api/v1";
const HANDYPAY_API_KEY = process.env.HANDYPAY_API_KEY!;

async function handypay<T = any>(
  endpoint: string,
  options: RequestInit = {}
): Promise<T> {
  const res = await fetch(`${HANDYPAY_API_URL}${endpoint}`, {
    ...options,
    headers: {
      Authorization: `Bearer ${HANDYPAY_API_KEY}`,
      "Content-Type": "application/json",
      ...options.headers,
    },
  });

  const json = await res.json();

  if (!json.success) {
    throw new Error(`[${json.error.code}] ${json.error.message}`);
  }

  return json.data;
}

export { handypay };

javascript

Guardar a tua chave .env como HANDYPAY_API_KEY. Nunca o exponhas ao lado do cliente.

Faça o seu primeiro pedido

Liste seus produtos para verificar se tudo funciona.

TypeScript

const products = await handypay("/products?limit=10");
console.log(products);

javascript

Equivalência cURL

cURL

curl https://api.handypay.me/api/v1/products \
  -H "Authorization: Bearer hp_test_your_api_key_here"

javascript

Você deve voltar uma resposta do JSON com "success": true e os dados do seu produto.

Limites de Taxa

1.000 pedidos por hora por chave do API. Excedendo o limite retorna 429 com uma Retry-After Cabeçalho.

O que você pode construir

Pagamentos unidireccionais

Crie produtos e hospede sessões de checkout para compras individuais.

Assinaturas

Cobrança recorrente com intervalos flexíveis, testes e cancelamento.

Multimoeda

Aceite o USD, JMD, CAD e mais em 10 países.

Webhooks

Notificações de eventos em tempo real para pagamento e ciclo de vida de assinatura.

Intervalos de faturamento

Os produtos de assinatura suportam os seguintes intervalos de faturamento recorrentes.

weeklybi-weeklymonthlybi-monthlyquarterlysemi-annualannual

Passos Próximos

Consulte a referência completa da API para ver os detalhes dos endpoints ou vá direto às receitas de integração para Next.js, React Native e Express.

HandyPay Pagamentos de Ecommerce API

URL Base

https://api.handypay.me/api/v1

javascript

Versão do API: 2025-01-01 — devolvidas no X-API-Version cabeçalho em cada resposta.

Início Rápido

Põe-te a funcionar em menos de um minuto. Pegue uma chave do API, configure o cliente, faça um pedido.

Obtenha a sua chave API

Gerar as chaves a partir do Portal do lojista. Todos os pedidos requerem um token do portador na Authorization Cabeçalho.

Authorization: Bearer hp_live_your_api_key_here

javascript

hp_test_Caixa de areia

hp_live_Produção

Configurar o cliente API

Crie uma função auxiliar reutilizável. Ela funciona com Next.js, React Native e Node.js.

lib/handypay.ts

const HANDYPAY_API_URL = "https://api.handypay.me/api/v1";
const HANDYPAY_API_KEY = process.env.HANDYPAY_API_KEY!;

async function handypay<T = any>(
  endpoint: string,
  options: RequestInit = {}
): Promise<T> {
  const res = await fetch(`${HANDYPAY_API_URL}${endpoint}`, {
    ...options,
    headers: {
      Authorization: `Bearer ${HANDYPAY_API_KEY}`,
      "Content-Type": "application/json",
      ...options.headers,
    },
  });

  const json = await res.json();

  if (!json.success) {
    throw new Error(`[${json.error.code}] ${json.error.message}`);
  }

  return json.data;
}

export { handypay };

javascript

Guardar a tua chave .env como HANDYPAY_API_KEY. Nunca o exponhas ao lado do cliente.

Faça o seu primeiro pedido

Liste seus produtos para verificar se tudo funciona.

TypeScript

const products = await handypay("/products?limit=10");
console.log(products);

javascript

Equivalência cURL

cURL

curl https://api.handypay.me/api/v1/products \
  -H "Authorization: Bearer hp_test_your_api_key_here"

javascript

Você deve voltar uma resposta do JSON com "success": true e os dados do seu produto.

Limites de Taxa

1.000 pedidos por hora por chave do API. Excedendo o limite retorna 429 com uma Retry-After Cabeçalho.

O que você pode construir

Pagamentos unidireccionais

Crie produtos e hospede sessões de checkout para compras individuais.

Assinaturas

Cobrança recorrente com intervalos flexíveis, testes e cancelamento.

Multimoeda

Aceite o USD, JMD, CAD e mais em 10 países.

Webhooks

Notificações de eventos em tempo real para pagamento e ciclo de vida de assinatura.

Intervalos de faturamento

Os produtos de assinatura suportam os seguintes intervalos de faturamento recorrentes.

weeklybi-weeklymonthlybi-monthlyquarterlysemi-annualannual

Passos Próximos

Consulte a referência completa da API para ver os detalhes dos endpoints ou vá direto às receitas de integração para Next.js, React Native e Express.

HandyPay Pagamentos de Ecommerce API

URL Base

https://api.handypay.me/api/v1

javascript

Versão do API: 2025-01-01 — devolvidas no X-API-Version cabeçalho em cada resposta.

Início Rápido

Põe-te a funcionar em menos de um minuto. Pegue uma chave do API, configure o cliente, faça um pedido.

Obtenha a sua chave API

Gerar as chaves a partir do Portal do lojista. Todos os pedidos requerem um token do portador na Authorization Cabeçalho.

Authorization: Bearer hp_live_your_api_key_here

javascript

hp_test_Caixa de areia

hp_live_Produção

Configurar o cliente API

Crie uma função auxiliar reutilizável. Ela funciona com Next.js, React Native e Node.js.

lib/handypay.ts

const HANDYPAY_API_URL = "https://api.handypay.me/api/v1";
const HANDYPAY_API_KEY = process.env.HANDYPAY_API_KEY!;

async function handypay<T = any>(
  endpoint: string,
  options: RequestInit = {}
): Promise<T> {
  const res = await fetch(`${HANDYPAY_API_URL}${endpoint}`, {
    ...options,
    headers: {
      Authorization: `Bearer ${HANDYPAY_API_KEY}`,
      "Content-Type": "application/json",
      ...options.headers,
    },
  });

  const json = await res.json();

  if (!json.success) {
    throw new Error(`[${json.error.code}] ${json.error.message}`);
  }

  return json.data;
}

export { handypay };

javascript

Guardar a tua chave .env como HANDYPAY_API_KEY. Nunca o exponhas ao lado do cliente.

Faça o seu primeiro pedido

Liste seus produtos para verificar se tudo funciona.

TypeScript

const products = await handypay("/products?limit=10");
console.log(products);

javascript

Equivalência cURL

cURL

curl https://api.handypay.me/api/v1/products \
  -H "Authorization: Bearer hp_test_your_api_key_here"

javascript

Você deve voltar uma resposta do JSON com "success": true e os dados do seu produto.

Limites de Taxa

1.000 pedidos por hora por chave do API. Excedendo o limite retorna 429 com uma Retry-After Cabeçalho.

O que você pode construir

Pagamentos unidireccionais

Crie produtos e hospede sessões de checkout para compras individuais.

Assinaturas

Cobrança recorrente com intervalos flexíveis, testes e cancelamento.

Multimoeda

Aceite o USD, JMD, CAD e mais em 10 países.

Webhooks

Notificações de eventos em tempo real para pagamento e ciclo de vida de assinatura.

Intervalos de faturamento

Os produtos de assinatura suportam os seguintes intervalos de faturamento recorrentes.

weeklybi-weeklymonthlybi-monthlyquarterlysemi-annualannual

Passos Próximos

Consulte a referência completa da API para ver os detalhes dos endpoints ou vá direto às receitas de integração para Next.js, React Native e Express.