Simula a taxa e os juros de parcelamento de uma venda da comunidade
POST/api/fees/simulate
- Auth
- Requiere token
- X-CommunityId
X-CommunityIdEnvía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.
Mesmo cálculo do checkout (`calculateFees`). Com `installments` > 1 no cartão, a resposta traz os juros de parcelamento da Memberfy (F-43): `installmentInterestPayer`, `installmentInterestPercent`, `installmentInterest` (o que o comprador paga de juros; `0.00` quando a comunidade absorve), `totalWithInterest` e `installmentAmount`, além do objeto `installmentInterest` dentro do cálculo. `feePayer` e `installmentInterestPayer` aceitam `ORGANIZATION`/`BUYER` (e os nomes antigos `COMMUNITY`/`CUSTOMER`); o padrão dos dois é `BUYER`, como num produto. Nunca traz custo do provedor.
Headers
| Nombre | Tipo | Descripción |
|---|---|---|
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Cuerpo de la solicitud application/json
| Nombre | Tipo | Descripción |
|---|---|---|
amountobligatorio | number | Amount must be greater than 0 |
paymentMethodobligatorio | PIX | CREDIT_CARD | DEBIT_CARD | BOLETO | Invalid payment method |
installmentsopcional | integer | Installments must be between 1 and 12 |
feePayeropcional | ORGANIZATION | BUYER | COMMUNITY | CUSTOMER | Quem paga a taxa da plataforma; padrão BUYER |
installmentInterestPayeropcional | ORGANIZATION | BUYER | COMMUNITY | CUSTOMER | Quem paga os juros de parcelamento; padrão BUYER |
currencyopcional | BRL | USD | EUR | Invalid currency |
countryCodeopcional | string | Country code must be 2 characters · min 2, max 2 |
Respuestas
| Código | Descripción |
|---|---|
201 | Operação realizada com sucesso. |
400 | Requisição inválida — falha de validação. |
401 | Token ausente, inválido ou expirado. |
404 | Recurso não encontrado. |
500 | Erro interno do servidor. |
Ejemplo con curl
curl -X POST "https://api.memberfy.net/api/fees/simulate" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"amount":10,"paymentMethod":"PIX"}'