Previsualiza un cargo antes de crearlo

Parámetros URI

No se tienen parámetros

Atributos de la petición

Id ( string )

Identificador unico de la transacción

Gclid ( string )

Google Click IDentifier - Opcional, en caso de existir se agrega a los datos del usuario Si el usuario ya tiene este dato, se ignora el dato nuevo para conservar el existente

OrderId ( string )

Identificador de orden a convertir en cargo

InvoiceData ( InvoiceDataBindingModel )

Datos para generacInvoiceIdion de factura

PaymentType ( string )

Tipo de pago

Required

Matching regular expression pattern: card|bank|store|oxxo|paypal

CardId ( string )

Token de la tarjeta

TokenId ( string )

Token de la tarjeta

SellerId ( string )

Seller id Entidad fiscal que vende (Solo lectura)

CustomerId ( string )

Cliente de la tabla cliente que hace la compra (solo lectura)

PromoCode ( string )

Código de promoción

Items ( Atributos de ItemBindingModel )

Conceptos a comprar

TotalAmount ( decimal number )

De solo lectura

Description ( string )

De solo lectura

Date ( date )

Fecha de pago

Status ( string )

Estado del pago

PaymentReceiptPdfUrl ( string )

Recibo de pago (Solo pago en tienda o banco)

PaymentReceiptHtmlUrl ( string )

Url Recibo de pago en pdf (solo banco o tienda)

UrlToApprove ( string )

Url para aprobar el pago solo para paypal

Iva ( decimal number )

IVA solo lectira

Discount ( decimal number )

Descuento solo lectura

Subtotal ( decimal number )

Subtotal solo lectura

Reference ( string )

Referencia del Pago

Metadata ( Object )

Datos adicionales para pasarelas en especifico

InvoiceId ( string )

Datos de la factura

UserProfileId ( integer )

Identificador del usuario en la tabla de userprofile

RFC ( string )

RFC de la tabla taxEntities

ComercialName ( string )

ComercialName de la tabla taxEntities

Argumentos de respuesta

IHttpActionResult

No se tienen parámetros

http method:

POST

https://apisandbox.facturama.mx/api/charges/preview

Ejemplo de Petición

application/json, text/json

Ejemplo: 
{
  "Id": "sample string 1",
  "Gclid": "sample string 2",
  "OrderId": "sample string 3",
  "InvoiceData": {
    "CfdiUse": "sample string 1",
    "PaymentForm": "sample string 2"
  },
  "PaymentType": "sample string 4",
  "CardId": "sample string 5",
  "TokenId": "sample string 6",
  "SellerId": "sample string 7",
  "CustomerId": "sample string 8",
  "PromoCode": "sample string 9",
  "Items": [
    {
      "ProductId": "sample string 1",
      "Quantity": 2,
      "Description": "sample string 3",
      "Amount": 4.0,
      "Price": 5.0,
      "Subtotal": 6.0,
      "Iva": 7.0
    },
    {
      "ProductId": "sample string 1",
      "Quantity": 2,
      "Description": "sample string 3",
      "Amount": 4.0,
      "Price": 5.0,
      "Subtotal": 6.0,
      "Iva": 7.0
    }
  ],
  "TotalAmount": 10.0,
  "Description": "sample string 11",
  "Date": "2025-12-13T01:56:42.2780779-06:00",
  "Status": "sample string 13",
  "PaymentReceiptPdfUrl": "sample string 14",
  "PaymentReceiptHtmlUrl": "sample string 15",
  "UrlToApprove": "sample string 16",
  "Iva": 17.0,
  "Discount": 18.0,
  "Subtotal": 19.0,
  "Reference": "sample string 20",
  "Metadata": {},
  "InvoiceId": "sample string 22",
  "UserProfileId": 23,
  "RFC": "sample string 24",
  "ComercialName": "sample string 25"
}

Ejemplo de Respuesta

application/json, text/json

Ejemplo:

Sample not available.