Evaluate a proposed payment against the tenant's effective SimplePay payment policy

curl --request POST \
  --url https://api.simplepay.mx/v1/payment-policy/evaluate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "amount_minor": 2,
  "currency": "mxn",
  "payment_method_types": [
    "<string>"
  ]
}
'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({amount_minor: 2, currency: 'mxn', payment_method_types: ['<string>']})
};

fetch('https://api.simplepay.mx/v1/payment-policy/evaluate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.simplepay.mx/v1/payment-policy/evaluate"

payload = {
    "amount_minor": 2,
    "currency": "mxn",
    "payment_method_types": ["<string>"]
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "version": "simplepay_payment_policy_preflight.v1",
  "allowed": true,
  "code": "<string>",
  "pricing": {
    "base_amount_minor": 123,
    "gross_amount_minor": 123,
    "payer_financing_fee_minor": 123,
    "merchant_financing_markup_minor": 123,
    "monthly_payment_minor": 123,
    "selected_months": 123,
    "quote_id": "<string>",
    "quote_hash": "<string>",
    "quote_expires_at": "2023-11-07T05:31:56Z",
    "disclosure_snapshot": {}
  },
  "evaluated_methods": [
    {}
  ],
  "installment_quote": {
    "quote_id": "<string>",
    "hash": "<string>",
    "expires_at": "2023-11-07T05:31:56Z",
    "snapshot": {},
    "options": [
      {
        "months": 123,
        "customer_total_minor": 123,
        "monthly_payment_minor": 123,
        "payer_financing_fee_minor": 123,
        "merchant_net_minor": 123,
        "simplepay_fee_minor": 123,
        "merchant_markup_minor": 123,
        "platform_margin_minor": 123,
        "display_label": "<string>",
        "disclosure_text": "<string>"
      }
    ]
  }
}

POST

https://api.simplepay.mx

payment-policy

evaluate

Evaluate a proposed payment against the tenant's effective SimplePay payment policy

curl --request POST \
  --url https://api.simplepay.mx/v1/payment-policy/evaluate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "amount_minor": 2,
  "currency": "mxn",
  "payment_method_types": [
    "<string>"
  ]
}
'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({amount_minor: 2, currency: 'mxn', payment_method_types: ['<string>']})
};

fetch('https://api.simplepay.mx/v1/payment-policy/evaluate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.simplepay.mx/v1/payment-policy/evaluate"

payload = {
    "amount_minor": 2,
    "currency": "mxn",
    "payment_method_types": ["<string>"]
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "version": "simplepay_payment_policy_preflight.v1",
  "allowed": true,
  "code": "<string>",
  "pricing": {
    "base_amount_minor": 123,
    "gross_amount_minor": 123,
    "payer_financing_fee_minor": 123,
    "merchant_financing_markup_minor": 123,
    "monthly_payment_minor": 123,
    "selected_months": 123,
    "quote_id": "<string>",
    "quote_hash": "<string>",
    "quote_expires_at": "2023-11-07T05:31:56Z",
    "disclosure_snapshot": {}
  },
  "evaluated_methods": [
    {}
  ],
  "installment_quote": {
    "quote_id": "<string>",
    "hash": "<string>",
    "expires_at": "2023-11-07T05:31:56Z",
    "snapshot": {},
    "options": [
      {
        "months": 123,
        "customer_total_minor": 123,
        "monthly_payment_minor": 123,
        "payer_financing_fee_minor": 123,
        "merchant_net_minor": 123,
        "simplepay_fee_minor": 123,
        "merchant_markup_minor": 123,
        "platform_margin_minor": 123,
        "display_label": "<string>",
        "disclosure_text": "<string>"
      }
    ]
  }
}

Uso

Usalo para inspeccionar o evaluar reglas efectivas antes de crear cobros, reservas o flujos con monto variable.

Antes de llamar

Tema	Detalle
Metodo	`POST`
Ruta	`/v1/payment-policy/evaluate`
Auth	Bearer API key del ambiente correcto.
Scope	`policies:read`
Idempotencia	Recomendada para cualquier retry. Usa una key deterministica por operacion de negocio.
Guia relacionada	API Reference overview

Patron recomendado

Ejecuta este endpoint desde backend o job seguro, nunca desde frontend con API keys.
Manda Idempotency-Key cuando el endpoint cree, convierta, reprograme, cancele, capture o reembolse estado.
Persiste IDs SimplePay (spcs_..., sppi_..., splink_..., refund IDs o booking IDs) para reconciliacion.
Consulta el bloque OpenAPI de esta pagina para el shape exacto de parametros, body y respuestas.

Ejemplo minimo

terminal

curl -sS -X POST "https://api.simplepay.mx/v1/payment-policy/evaluate" \
  -H "Authorization: Bearer $SIMPLEPAY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: evaluate-payment-policy_v1" \
  -d '{ ... }'

Errores a manejar

400 indica payload, parametros o estado invalido.
401 o 403 indican API key, ambiente o scopes incorrectos.
409 suele indicar conflicto de estado, duplicado o idempotencia incompatible.
429 y 5xx se pueden reintentar con backoff; en writes conserva la misma idempotency key.

Contrato OpenAPI

El playground, parametros, body y respuestas de abajo salen de /openapi.json. Si el contrato cambia, actualiza la spec y regenera esta pagina.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key

string

required

Required string length: 8 - 255

Body

application/json

amount_minor

integer

required

Required range: x >= 1

currency

enum<string>

required

Available options:

mxn

payment_method_types

string[]

required

Minimum array length: 1

payment_surface

enum<string>

required

Available options:

hosted_checkout,

payment_link

product_key

enum<string>

required

Available options:

hosted_checkout,

payment_link,

bookable_payments

installments

object

Optional card installments capability request. This is a payment capability, not a SimplePay product.

Hide child attributes

installments.enabled

boolean

installments.months

enum<integer>

Available options:

3,

6,

9,

12,

18

installments.desired_months

enum<integer>[]

Available options:

3,

6,

9,

12,

18

installments.pricing_strategy

enum<string>

Available options:

merchant_absorbed,

payer_transparent,

blended_price,

pass_through_plus_margin

installments.merchant_financing_markup_bps

integer

Required range: 0 <= x <= 10000

installments.quote_hash

string

Pattern: ^[a-f0-9]{64}$

Response

200 - application/json

Sanitized policy preflight result

version

enum<string>

required

Available options:

simplepay_payment_policy_preflight.v1

allowed

boolean

required

code

string

required

pricing

object

required

Hide child attributes

pricing.base_amount_minor

integer

pricing.gross_amount_minor

integer

pricing.payer_financing_fee_minor

integer

pricing.merchant_financing_markup_minor

integer

pricing.monthly_payment_minor

integer

pricing.pricing_strategy

enum<string>

Available options:

merchant_absorbed,

payer_transparent,

blended_price,

pass_through_plus_margin

pricing.selected_months

integer

pricing.quote_id

string

Pattern: ^spq_[a-f0-9]{32}$

pricing.quote_hash

string

Pattern: ^[a-f0-9]{64}$

pricing.quote_expires_at

string<date-time>

pricing.disclosure_snapshot

object

evaluated_methods

object[]

required

installment_quote

object

Policy-controlled card installments quote matrix. Use quote_hash on payment creation to detect stale pricing or policy changes.

Hide child attributes

installment_quote.quote_id

string

Pattern: ^spq_[a-f0-9]{32}$

installment_quote.hash

string

Pattern: ^[a-f0-9]{64}$

installment_quote.expires_at

string<date-time>

installment_quote.snapshot

object

installment_quote.options

object[]

Hide child attributes

installment_quote.options.months

integer

required

installment_quote.options.customer_total_minor

integer

required

installment_quote.options.monthly_payment_minor

integer

required

installment_quote.options.payer_financing_fee_minor

integer

required

installment_quote.options.merchant_net_minor

integer

required

installment_quote.options.simplepay_fee_minor

integer

required

installment_quote.options.merchant_markup_minor

integer

required

installment_quote.options.platform_margin_minor

integer

required

installment_quote.options.display_label

string

installment_quote.options.disclosure_text

string

Last modified on June 21, 2026

Retrieve the effective SimplePay payment policy for the tenant environment List tenant products

Overview

Checkout

Payment Links

Refunds

Payment Policy

Products

Catalog

Customer Hub

Bookable: setup

Bookable: resources

Bookable: disponibilidad

Bookable: event types

Bookable: holds y bookings

Webhooks y eventos

Meta

Evaluate a proposed payment against the tenant's effective SimplePay payment policy

Uso

Antes de llamar

Patron recomendado

Ejemplo minimo

Errores a manejar

Contrato OpenAPI

Authorizations

Headers

Body

Response

​Uso

​Antes de llamar

​Patron recomendado

​Ejemplo minimo

​Errores a manejar

​Contrato OpenAPI

Authorizations

Headers

Body

Response

Uso

Antes de llamar

Patron recomendado

Ejemplo minimo

Errores a manejar

Contrato OpenAPI