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

POSTCapturar cobrança

Captura uma cobrança autorizada

GETBuscar cobrança

Busca uma cobrança pelo ID

Cobranças

Criar cobrança

Cria uma nova cobrança

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

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/v1/charges" \  -H "Content-Type: application/json" \  -d '{    "amount": 1,    "product_type": "physical",    "customer": {      "name": "string",      "email": "user@example.com",      "tax_id": "stringstrin",      "phone": "string",      "type": "individual"    },    "items": [      {        "name": "string",        "quantity": 1,        "unit_price": 0,        "tangible": true      }    ],    "payment_method": "credit_card",    "payment_details": {}  }'
Empty

POSTCapturar cobrança

Captura uma cobrança autorizada

GETBuscar cobrança

Busca uma cobrança pelo ID

amount*number
shipping_amount?number
currency?string
product_type*string|string
customer*
billing_address?
shipping_address?
items*array<>
metadata?
three_ds?
fraud_session_id?string
client_ip?string
split?array<>
payment_method*string
payment_details*