Skip to main content
Una cotización se calcula una sola vez, puede ser consumida por un pago y caduca. Usa la API de Payment Quotes para mostrar a un comprador el total, los impuestos y la moneda antes de que pague, y luego pasa el id de la cotización como quote_id al crear el pago para cobrar exactamente esa cotización. Vuelve a cotizar cada vez que cambien el carrito, el código promocional o la dirección.

Endpoints

Atributos

string
requerido
ID de la cotización de pago, con el prefijo pq_.
string
requerido
La cuenta para la que se cotiza la compra, con el prefijo biz_.
object | null
requerido
La dirección de facturación con la que se cotizó la compra, o null. Es donde se calcularon los impuestos cuando no se indicó una dirección de envío, y la dirección a la que pertenece el registro fiscal.

Propiedades

string | null
requerido
La ciudad.
string | null
requerido
El código de país ISO 3166-1 alfa-2.
string | null
requerido
La primera línea de la dirección.
string | null
requerido
La segunda línea de la dirección.
string | null
requerido
El nombre de la dirección.
string | null
requerido
El código postal.
string | null
requerido
El estado, la provincia o la región.
string
requerido
Código ISO 4217 de tres letras de la moneda propia de las variantes, en minúsculas. Igual a currency cuando no se convirtió nada.
object
requerido
total en base_currency a exchange_rate: los precios propios de las variantes tras el código promocional, más tax_amount convertido a exchange_rate cuando los impuestos se suman al precio. Igual a total cuando no se convirtió nada. El pago cobra total, en currency.

Propiedades

string
requerido
El importe en unidades principales, como una cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún float lo redondee en tránsito.
string
requerido
Código de moneda ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales lleva el importe. Esta es la precisión con la que se ejecuta el cargo en sí.
integer
requerido
Cuántos decimales MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, así que es 2 y 0. Usa este valor para formatear el número en tu propia configuración regional.
string
requerido
Cuándo se cotizó, como marca de tiempo ISO 8601.
string
requerido
Código de moneda ISO 4217 de tres letras en el que se cotiza y cobra la compra, en minúsculas: la moneda propia de las variantes, o la presentment_currency a la que se convirtió.
object
requerido
Lo que descuenta el código promocional. Cero sin código.

Propiedades

string
requerido
El importe en unidades principales, como una cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún float lo redondee en tránsito.
string
requerido
Código de moneda ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales lleva el importe. Esta es la precisión con la que se ejecuta el cargo en sí.
integer
requerido
Cuántos decimales MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, así que es 2 y 0. Usa este valor para formatear el número en tu propia configuración regional.
string | null
requerido
Cuántas unidades de currency compra una unidad de base_currency, como una cadena decimal como "5.4321": la tasa a la que se convirtieron los precios de las variantes, fija hasta expires_at, y la tasa a la que se cobra un pago que consume la cotización. Es una cadena, como los importes monetarios, para que ningún float la redondee en tránsito. Null cuando no se convirtió nada.
string
requerido
Cuándo deja de poder cobrarse la cotización, como marca de tiempo ISO 8601. Vuelve a cotizar después.
object[]
requerido
Una entrada por variante, en el orden indicado, cada una con sus propios impuestos.

Propiedades

object
requerido
La parte del código promocional en esta línea. Cero sin código.

Propiedades

string
requerido
El importe en unidades principales, como una cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún float lo redondee en tránsito.
string
requerido
Código de moneda ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales lleva el importe. Esta es la precisión con la que se ejecuta el cargo en sí.
integer
requerido
Cuántos decimales MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, así que es 2 y 0. Usa este valor para formatear el número en tu propia configuración regional.
integer
requerido
Cuántas unidades de la variante cubre la línea.
object
requerido
El precio de la línea antes de la parte del código promocional y los impuestos; subtotal menos discount es lo que suma la línea tras el descuento. Los subtotales de las líneas suman el subtotal de la cotización.

Propiedades

string
requerido
El importe en unidades principales, como una cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún float lo redondee en tránsito.
string
requerido
Código de moneda ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales lleva el importe. Esta es la precisión con la que se ejecuta el cargo en sí.
integer
requerido
Cuántos decimales MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, así que es 2 y 0. Usa este valor para formatear el número en tu propia configuración regional.
object
requerido
Los impuestos de esta línea. Cero cuando tax_status no es calculated.

Propiedades

string
requerido
El importe en unidades principales, como una cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún float lo redondee en tránsito.
string
requerido
Código de moneda ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales lleva el importe. Esta es la precisión con la que se ejecuta el cargo en sí.
integer
requerido
Cuántos decimales MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, así que es 2 y 0. Usa este valor para formatear el número en tu propia configuración regional.
object
requerido
subtotal menos discount, más tax_amount cuando los impuestos se suman al precio, o sin él cuando el precio ya los incluye.

Propiedades

string
requerido
El importe en unidades principales, como una cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún float lo redondee en tránsito.
string
requerido
Código de moneda ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales lleva el importe. Esta es la precisión con la que se ejecuta el cargo en sí.
integer
requerido
Cuántos decimales MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, así que es 2 y 0. Usa este valor para formatear el número en tu propia configuración regional.
string | null
requerido
La variante que cotiza esta línea, con el prefijo plan_. Null cuando la compra describe la variante mediante variant y todavía no existe ninguna variante con esos atributos: el pago que consume la cotización la crea, y a partir de entonces la línea la nombra.
string | null
requerido
Para qué ubicación se calcularon los impuestos: shipping_address cuando incluye un país; si no, la address de facturación cuando lo incluye; si no, el presentment_country enviado; si no, la ip_address del comprador. Una cotización ubicada por presentment_country o ip_address es una vista previa que estima los impuestos: un pago no puede usarla, así que vuelve a cotizar con la dirección del comprador para pagar. Null cuando nada en la solicitud ubicó al comprador, algo que solo se permite para un vendedor que no recauda impuestos en esta compra; tax_status es entonces not_applicable.Opciones disponibles: shipping_address, address, presentment_country, ip_address
string | null
requerido
El pago que contiene esta cotización, con el prefijo pay_, o null mientras no se ha usado. Un pago rechazado conserva su cotización y puede reintentarse; consulta el status de ese pago.
string | null
requerido
El código promocional que aplicó la cotización, con el prefijo promo_, o null.
Códigos ISO 4217 en minúsculas para ofrecer al comprador en un selector de moneda, los más relevantes primero: la moneda del presentment_country enviado o, si no, la del país en el que está la ip_address del comprador, cuando esta compra puede convertirse a ella y un método de pago puede cobrarla; después, base_currency. Vuelve a cotizar con uno de ellos como presentment_currency para cotizar en esa moneda. Solo base_currency cuando la cotización se calculó sin presentment_currency ni presentment_country.
object | null
requerido
La dirección de envío con la que se cotizó la compra, o null. Cuando está presente, es donde se calcularon los impuestos.

Propiedades

string | null
requerido
La ciudad.
string | null
requerido
El código de país ISO 3166-1 alfa-2.
string | null
requerido
La primera línea de la dirección.
string | null
requerido
La segunda línea de la dirección.
string | null
requerido
El nombre de la dirección.
string | null
requerido
El código postal.
string | null
requerido
El estado, la provincia o la región.
object
requerido
El precio de todas las líneas antes del código promocional, los impuestos y las comisiones.

Propiedades

string
requerido
El importe en unidades principales, como una cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún float lo redondee en tránsito.
string
requerido
Código de moneda ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales lleva el importe. Esta es la precisión con la que se ejecuta el cargo en sí.
integer
requerido
Cuántos decimales MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, así que es 2 y 0. Usa este valor para formatear el número en tu propia configuración regional.
object
requerido
Los impuestos que cobra un pago que consume esta cotización. Cero salvo que tax_status sea calculated.

Propiedades

string
requerido
El importe en unidades principales, como una cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún float lo redondee en tránsito.
string
requerido
Código de moneda ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales lleva el importe. Esta es la precisión con la que se ejecuta el cargo en sí.
integer
requerido
Cuántos decimales MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, así que es 2 y 0. Usa este valor para formatear el número en tu propia configuración regional.
string | null
requerido
Si los impuestos se suman al precio (exclusive) o ya están incluidos en él (inclusive). Null cuando no se calcularon impuestos.Opciones disponibles: inclusive, exclusive
object[]
requerido
El registro fiscal del comprador con el que la cotización se calculó como compra empresarial. Vacío para una compra de consumidor.

Propiedades

string
requerido
El tipo de registro, como eu_vat.Opciones disponibles: ad_nrt, ao_tin, ar_cuit, al_tin, am_tin, aw_tin, au_abn, au_arn, eu_vat, az_tin, bs_tin, bh_vat, bd_bin, bb_tin, by_tin, bj_ifu, bo_tin, ba_tin, br_cnpj, br_cpf, bg_uic, bf_ifu, kh_tin, cm_niu, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, cv_nif, cl_tin, cn_tin, co_nit, cd_nif, cr_tin, hr_oib, do_rcn, ec_ruc, eg_tin, sv_nit, et_tin, eu_oss_vat, ge_vat, gh_tin, de_stn, gb_vat, gn_nif, hk_br, hu_tin, is_vat, in_gst, id_npwp, il_vat, jp_cn, jp_rn, jp_trn, kz_bin, ke_pin, kg_tin, la_tin, li_uid, li_vat, my_frp, my_itn, my_sst, mr_nif, mx_rfc, md_vat, me_pib, ma_vat, np_pan, nz_gst, ng_tin, mk_vat, no_vat, no_voec, om_vat, pe_ruc, ph_tin, pl_nip, ro_tin, ru_inn, ru_kpp, sa_vat, sn_ninea, rs_pib, sg_gst, sg_uen, si_tin, za_vat, kr_brn, es_cif, ch_uid, ch_vat, tw_vat, tj_tin, tz_vat, th_vat, tr_tin, ug_tin, ua_vat, ae_trn, us_ein, uy_ruc, uz_tin, uz_vat, ve_rif, vn_tin, zm_tin, zw_tin, sr_fin, xi_vat
string
requerido
El número de registro tal como lo introdujo el comprador, sin espacios en blanco (los valores eu_vat también eliminan puntos y guiones).
string
requerido
calculated: se cotizaron todas las líneas y un pago puede consumir la cotización. not_applicable: este vendedor no recauda impuestos en esta compra, por lo que la cotización no adeuda ninguno y aún puede consumirse. unavailable: no se pudieron calcular los impuestos (el proveedor no respondió, o la configuración fiscal de este vendedor no puede cotizar una compra aquí), así que un pago rechaza la cotización; vuelve a cotizar, o cobra sin quote_id para que los impuestos se calculen en el momento del cobro.Opciones disponibles: calculated, not_applicable, unavailable
object
requerido
Lo que paga el comprador: el subtotal menos el descuento, más tax_amount cuando los impuestos se suman al precio.

Propiedades

string
requerido
El importe en unidades principales, como una cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún float lo redondee en tránsito.
string
requerido
Código de moneda ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales lleva el importe. Esta es la precisión con la que se ejecuta el cargo en sí.
integer
requerido
Cuántos decimales MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, así que es 2 y 0. Usa este valor para formatear el número en tu propia configuración regional.
PaymentQuote