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

GETGráfico de faturamento

Retorna dados mensais agregados de faturamento para o gráfico

POSTEstornar cobrança

Estorna uma cobrança capturada

Cobranças

Listar cobranças

Lista cobranças com paginação e filtros

GET
/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

Query Parameters

merchant_id?string
status?string|string|string|string|string|string|string|string
payment_method?string|string|string|string
date_from?string
date_to?string
amount_min?number
amount_max?number
installments?number
search?string
payment_link_id?string
currency?string
page?number
limit?number

Response Body

curl -X GET "https://example.com/v1/charges"
Empty

GETGráfico de faturamento

Retorna dados mensais agregados de faturamento para o gráfico

POSTEstornar cobrança

Estorna uma cobrança capturada