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

POSTSimular antecipação

Simula os valores de uma antecipação sem criá-la

GETBuscar saque

Busca um saque pelo ID

Saques

Criar saque

Solicita um novo saque (PIX ou TED)

POST
/v1/withdrawals

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

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/v1/withdrawals" \  -H "Content-Type: application/json" \  -d '{    "wallet_id": "d9a8fbfc-848f-43a2-9168-911ed3a04a48",    "amount": 1,    "idempotency_key": "string",    "type": "ted",    "bank_account": {      "bank_code": "string",      "branch_number": "string",      "account_number": "string",      "account_type": "checking",      "holder_name": "string",      "holder_tax_id": "stringstrin"    }  }'
Empty

POSTSimular antecipação

Simula os valores de uma antecipação sem criá-la

GETBuscar saque

Busca um saque pelo ID

wallet_id*string
amount*number
idempotency_key*string
transaction_pin?string
type*string
bank_account*