Visão geral da API Worldfy para integrações de pagamento
A API Worldfy permite que você integre funcionalidades de pagamento diretamente na sua aplicação. Com ela, você pode:
Todas as requisições devem ser feitas para:
https://api.worldfypayments.com/v1A API aceita e retorna dados no formato JSON. Todas as requisições que enviam dados no corpo devem incluir o header:
Content-Type: application/jsonTodas as respostas seguem um formato padronizado:
{
"status": 200,
"message": "Cobrança encontrada com sucesso",
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"amount": 10000,
"status": "paid"
}
}{
"status": 200,
"message": "Cobranças listadas com sucesso",
"data": [],
"pagination": {
"page": 1,
"limit": 20,
"total": 150,
"totalPages": 8
}
}{
"status": 404,
"message": "Cobrança não encontrada",
"error": "CHARGE_NOT_FOUND"
}| Campo | Tipo | Descrição |
|---|---|---|
status | number | Código HTTP da resposta (ex: 200, 404, 500) |
message | string | Mensagem descritiva do resultado |
data | object | array | Dados retornados (presente em respostas de sucesso) |
error | string | Código de erro em inglês (presente em respostas de erro) |
pagination | object | Informações de paginação (presente em listagens) |
Todos os valores monetários são representados em centavos (inteiros). Por exemplo, R$ 100,00 é representado como 10000.
Cada cobrança carrega uma moeda (currency) no formato ISO 4217 de três letras (ex: BRL, USD). Quando omitida na criação, o padrão é BRL. A moeda é validada contra as moedas ativas da plataforma e normalizada para maiúsculas.
As listagens de cobranças, recebíveis, antecipações e saques aceitam o filtro currency para restringir os resultados a uma moeda específica.