Worldfy PaymentsWorldfy Payments
SuporteDashboard
GuiaAPI Reference
SuporteDashboard

Começando

IntroduçãoAutenticaçãoErrosPaginação e Filtros
Cobranças
Visão GeralMétodos de PagamentoCaptura e Estorno
Financeiro
RecebíveisAntecipaçõesCarteiras e ExtratosSaques
Configuração
Chaves de APIRecebedores
SDK de Segurança
Visão geralTokenizaçãoAutenticação 3DSAnálise de fraudeFluxo simplificadoFluxo completoErrosProdução e segurança
Webhooks
Visão GeralConfiguraçãoRetentativas
Eventos
Eventos de CobrançasEventos de Saques

Introdução

Visão geral da API Worldfy para integrações de pagamento

Erros

Códigos de erro e como tratá-los na API Worldfy

Autenticação

Como autenticar requisições na API Worldfy

Chave de API (Basic Auth)

A API Worldfy utiliza HTTP Basic Authentication com suas chaves de API. Ao criar uma chave, você recebe um par:

  • Public Key: identificador público da chave
  • Secret Key: segredo da chave (exibido apenas uma vez na criação)

Para autenticar, envie o header Authorization com o valor Basic seguido da codificação Base64 de publicKey:secretKey:

curl -X GET https://api.worldfypayments.com/v1/charges \
  -H "Authorization: Basic $(echo -n 'pk_live_abc123:sk_live_xyz789' | base64)"

A Secret Key é exibida apenas uma vez no momento da criação. Armazene-a em local seguro. Se perdê-la, será necessário revogar a chave e criar uma nova.

Construindo o Header

Concatene as chaves

Junte a public key e a secret key separadas por dois pontos: publicKey:secretKey

Codifique em Base64

Codifique a string resultante em Base64.

Envie no header

Adicione o header Authorization: Basic {base64} em todas as requisições.

Exemplos por linguagem

curl -X GET https://api.worldfypayments.com/v1/charges \
  -u "pk_live_abc123:sk_live_xyz789"
const credentials = Buffer.from('pk_live_abc123:sk_live_xyz789').toString('base64');

const response = await fetch('https://api.worldfypayments.com/v1/charges', {
  headers: {
    'Authorization': `Basic ${credentials}`,
  },
});
import base64
import requests

credentials = base64.b64encode(b'pk_live_abc123:sk_live_xyz789').decode()

response = requests.get(
    'https://api.worldfypayments.com/v1/charges',
    headers={'Authorization': f'Basic {credentials}'},
)

Whitelist de IP

Ao criar ou atualizar uma chave de API, você pode configurar uma whitelist de IPs. Quando configurada, apenas requisições originadas dos IPs permitidos serão aceitas. Requisições de IPs fora da whitelist recebem 401 UNAUTHORIZED.

{
  "name": "Produção",
  "ip_whitelist": ["203.0.113.10", "203.0.113.11"]
}

A whitelist é opcional. Quando ip_whitelist está vazio ou ausente, a chave aceita requisições de qualquer IP.

Segurança

Nunca exponha suas chaves

Não inclua chaves em código frontend, repositórios públicos ou logs.

Use variáveis de ambiente

Armazene as chaves em variáveis de ambiente no servidor.

Rotacione periodicamente

Crie novas chaves e revogue as antigas regularmente.

Restrinja por IP

Configure a whitelist de IPs para limitar o acesso.

Introdução

Visão geral da API Worldfy para integrações de pagamento

Erros

Códigos de erro e como tratá-los na API Worldfy

On this page

Chave de API (Basic Auth)Construindo o HeaderConcatene as chavesCodifique em Base64Envie no headerExemplos por linguagemWhitelist de IPSegurança