Finance
MerchantRisk - Seller risk health
Consulta o health de risco do merchant (chargeback/dispute/refund ratios, tier e thresholds para a janela configurada).
Consulta o health de risco do merchant (chargeback/dispute/refund ratios, tier e thresholds para a janela configurada).
Authorization
SelectKeyAuth selectkey<token>
API key for all authenticated requests. Send your key in the selectkey header (e.g. sandbox sl_test_…, production sl_live_…).
In: header
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/finance/risk-health"{
"object": "merchant_risk_health",
"window": "rolling30d",
"periodStart": "2026-03-13T00:00:00.000Z",
"periodEnd": "2026-04-12T00:00:00.000Z",
"tier": "ok",
"chargebackRatio": 0.008,
"chargebackCount": 2,
"disputeRatio": 0.012,
"refundRatio": 0.025,
"thresholds": {
"chargebackWarnRatio": 0.009,
"chargebackExcessiveRatio": 0.018,
"mastercardEcmRatio": 0.015,
"disputeWarnRatio": 0.009,
"refundWatchRatio": 0.15
},
"lastEvaluatedAt": "2026-04-12T17:56:33.000Z"
}{
"error": {
"status": "Bad Request",
"statusCode": 400,
"category": "validation",
"message": "Validation errors occurred",
"details": "One or more parameters are invalid or out of range. Please check the parameters and try again.",
"params": [
{
"payment[currency]": "currency must be one of [BRL]"
},
{
"amount": "amount is required"
}
],
"code": "invalidParameters",
"resource": "client"
}
}{
"error": {
"status": "Unauthorized",
"statusCode": 401,
"category": "authentication",
"message": "Unauthorized",
"details": "Authentication failed. The provided API key is invalid or does not have permission to operate.",
"code": "unauthorized"
}
}{
"error": {
"status": "Forbidden",
"statusCode": 403,
"category": "authorization",
"message": "Forbidden",
"details": "Access denied. This may be due to IP blocks, domain restrictions, or insufficient permissions.",
"code": "forbidden"
}
}{
"error": {
"status": "Not Found",
"statusCode": 404,
"category": "client",
"message": "Not Found",
"details": "The requested resource was not found on the server.",
"code": "notFound"
}
}{
"error": {
"status": "Unprocessable Entity",
"statusCode": 422,
"category": "validation",
"message": "Unprocessable Entity",
"details": "The request was understood, but contains invalid data that could not be processed.",
"code": "unprocessableEntity"
}
}{
"error": {
"status": "Too Many Requests",
"statusCode": 429,
"category": "rate_limit",
"message": "Too Many Requests",
"details": "The number of requests exceeded the limit allowed for the IP or user.",
"retryAfterMinutes": 60,
"code": "tooManyRequests"
}
}{
"error": {
"status": "Internal Server Error",
"statusCode": 500,
"category": "server",
"message": "Server error.",
"details": "An internal server error occurred. Please try again later.",
"code": "serverError",
"resource": "server"
}
}