Worldfy PaymentsWorldfy Payments
SuporteDashboard
GuiaAPI Reference
SuporteDashboard
Bancos
GETBuscar banco por códigoGETBuscar banco por ISPBGETListar bancos
Cobranças
POSTCapturar cobrançaPOSTCriar cobrançaGETBuscar cobrançaGETMétodos de pagamento habilitadosGETResumo de cobrançasGETGráfico de faturamentoGETListar cobrançasPOSTEstornar cobrança
Links de Pagamento
POSTCriar link de pagamentoDELDesativar link de pagamentoGETBuscar link de pagamentoGETListar links de pagamentoDELRemover imagem de capaDELRemover logo do merchantPATCHAtualizar link de pagamentoPOSTUpload de imagem de capaPOSTUpload de logo do merchant
Carteiras
GETBusca carteira por IDGETGera extrato da carteiraGETLista lancamentos da carteiraGETLista carteiras
Recebíveis
GETDetalhe do recebívelGETResumo de recebíveisGETLista recebíveis
Antecipações
DELCancelar antecipaçãoPOSTSolicitar antecipaçãoGETDetalhe da antecipaçãoGETResumo de antecipaçõesGETLista antecipaçõesPOSTSimular antecipação
Saques
POSTCriar saqueGETBuscar saqueGETTaxa de saqueGETMétodos de saque habilitadosGETComprovante de saqueGETResumo de saquesGETListar saques
Recebedores
GETBuscar recipiente por tipoGETListar recipientesPUTCriar ou atualizar recipiente
Webhooks
POSTCria um novo endpoint de webhookDELRemove um endpoint de webhookGETObtém detalhes de um endpoint de webhookGETLista os logs de entrega de webhookGETLista os endpoints de webhook do merchantPOSTRegenera o secret de um endpoint de webhookPOSTReenvia uma notificação que falhouPATCHAtualiza um endpoint de webhook
Chaves de API
POSTCria uma nova chave de APIGETLista chaves de APIDELRevoga uma chave de APIPATCHAtualiza uma chave de API
Adquirentes
POSTRegistrar conta virtual de clienteGETConsultar cadastro de conta virtual
Checkout Público
GETRecuperar instruções e status da mesma compraGETBancos disponíveis para um método de pagamento

POSTCapturar cobrança

Captura uma cobrança autorizada

GETBuscar cobrança

Busca uma cobrança pelo ID

Cobranças

Criar cobrança

Cria uma cobrança com branding opcional em store e imagens opcionais em items[].image_url. Sem os novos campos, o checkout preserva o nome do merchant e a identidade Worldfy. Para apple_pay, não envie payment_details, token de carteira ou split. Redirecione para data.checkout_url no contexto principal do navegador, sem iframe. return_url é somente o destino final e não confirma pagamento. Google Pay permanece desativado.

POST
/v1/charges

Authorization

basicAuth
AuthorizationBasic <token>

Autenticação via chave de API. Use publicKey:secretKey codificado em Base64 no header Authorization: Basic {credentials}.

In: header

Request Body

Use apple_pay somente quando o método for retornado por GET /v1/charges/methods?currency={moeda}. Apple Pay usa os campos comuns da cobrança e não aceita payment_details nem split. Google Pay permanece desativado.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/v1/charges" \  -H "Content-Type: application/json" \  -d '{    "amount": 15900,    "currency": "EUR",    "payment_method": "apple_pay",    "product_type": "digital",    "return_url": "https://sualoja.com.br/pedidos/123",    "customer": {      "name": "Maria Silva",      "email": "maria@example.com",      "tax_id": "12345678901",      "phone": "11999998888",      "type": "individual"    },    "items": [      {        "name": "Curso Online",        "quantity": 1,        "unit_price": 15900,        "tangible": false      }    ]  }'
Empty
{
  "data": {
    "id": "f1e2d3c4-b5a6-7890-fedc-ba0987654321",
    "status": "pending",
    "payment_fields": {
      "payment_method": "apple_pay"
    },
    "checkout_url": "https://securecheckoutwp.com/wallet/0a1b2c3d-4e5f-6789-abcd-ef0123456789",
    "expires_at": "2026-08-25T18:30:00.000Z",
    "created_at": "2026-08-25T18:15:00.000Z"
  },
  "status": 201,
  "message": "Checkout de carteira criado com sucesso"
}

POSTCapturar cobrança

Captura uma cobrança autorizada

GETBuscar cobrança

Busca uma cobrança pelo ID

country?string
amount*number

Subtotal da cobrança em unidades mínimas da moeda. O total cobrado é amount + shipping_amount; não inclua o frete duas vezes.

shipping_amount?number

Frete em unidades mínimas da moeda, somado a amount. Omitido equivale a zero; o checkout exibe a linha de frete somente quando maior que zero.

currency?string

Código ISO 4217 de uma moeda habilitada para o merchant e o método. Consulte GET /v1/charges/methods?currency={moeda}. O checkout de carteira atual suporta EUR, GBP e USD, com valores em centavos.

product_type*|
customer*
billing_address?
shipping_address?
items*array<>
store?

Branding opcional persistido na cobrança. O cabeçalho exibe somente o logo; name identifica a loja no título e nos rótulos acessíveis. Campos ausentes usam, independentemente, o nome do merchant e a identidade visual Worldfy. URLs inseguras são recusadas; imagens indisponíveis usam fallback no checkout.

metadata?
return_url?string

URL pública HTTPS para o redirecionamento final. Não substitui checkout_url nem confirma pagamento.

three_ds?
fraud_session_id?string
client_ip?string
split?array<>
payment_method*||||||||||||||||||||||
payment_details*