Objetos

Last update: 4 days ago by Marian Guzmán - JC

Estructura general

Nombre	Descripción	Tipo	Requerimientos
from	Teléfono (con código de país) del que se enviará el mensaje.	String	Obligatorio
to	Teléfono del destinatario en formato E.164, sin el signo +.	String	Obligatorio
type	Tipo de mensaje. Debe ser "interactive".	String	Obligatorio
order_details	Objeto que contiene el contenido del mensaje y los detalles del pago.	Objeto	Obligatorio

Objeto order details

Nombre	Descripción	Tipo	Requerimientos
body	Texto principal del mensaje.	String	Obligatorio
footer	Texto del pie del mensaje.	String	Opcional
action	Objeto que contiene la acción y sus parámetros.	Objeto	Obligatorio

Objeto action

Nombre	Descripción	Tipo	Requerimientos
name	Nombre de la acción. Debe ser "review_and_pay".	String	Obligatorio
parameters	Objeto con los datos del pedido y del pago.	Objeto	Obligatorio

Objeto parameters

Nombre	Descripción	Tipo	Requerimientos
reference_id	Identificador único del pedido. Solo admite letras del alfabeto inglés, números, guion, guion bajo y punto.	String	Obligatorio
payment_type	Debe ser "br" para activar las validaciones de Brasil.	String	Opcional
type	Tipo de bien. Los valores pueden ser: digital-goods physical-goods	String	Obligatorio
payment_settings	Lista de métodos de pago. Admite uno o varios métodos.	Array	Obligatorio
currency	Moneda del pago. Debe ser "BRL".	String	Obligatorio
total_amount.value	Monto total expresado como entero.	Integer	Obligatorio
total_amount.offset	Debe ser 100.	Integer	Obligatorio
order	Desglose del pedido (estado, impuestos, artículos y subtotal). Se omite en la carga simplificada.	Objeto	Opcional

Objeto payment settings

Nombre	Descripción	Tipo	Requerimientos
type	Método de pago. Los valores pueden ser: payment_link: Enlace de Pago. pix_dynamic_code: Código Dinámico de PIX. boleto: Boleto.	String	Obligatorio
payment_link	Objeto con los datos del Enlace de Pago.	Objeto	Obligatorio cuando type es payment_link
pix_dynamic_code	Objeto con los datos del Código Dinámico de PIX.	Objeto	Obligatorio cuando type es pix_dynamic_code
boleto	Objeto con los datos del Boleto.	Objeto	Obligatorio cuando type es boleto

Objeto payment link

Nombre	Descripción	Tipo	Requerimientos
uri	Dirección que se abre en el navegador al pulsar el botón. Debe usar el esquema https.	String	Obligatorio

Objeto pix dynamic code

Nombre	Descripción	Tipo	Requerimientos
code	Código dinámico de PIX que el comprador copia para realizar el pago.	String	Obligatorio
merchant_name	Nombre del titular de la cuenta de PIX.	String	Obligatorio
key	Llave de PIX del comercio.	String	Obligatorio
key_type	Tipo de llave. Los valores pueden ser: CPF CNPJ EMAIL PHONE EVP	String	Obligatorio

Objeto boleto

Nombre	Descripción	Tipo	Requerimientos
digitable_line	Línea digitable que el comprador copia para realizar el pago en su banco.	String	Obligatorio

Plantilla de detalles del pedido

Nombre	Descripción	Tipo	Requerimientos
type	Tipo de mensaje. Debe ser "template".	String	Obligatorio
template.name	Nombre de la plantilla aprobada.	String	Obligatorio
template.language	Lenguaje de la plantilla.	String	Obligatorio
components.type	Debe ser "button".	String	Obligatorio
components.subtype	Debe ser "order_details".	String	Opcional
components.index	Posición del botón dentro de la plantilla.	Integer	Obligatorio
parameters.type	Debe ser "action".	String	Obligatorio
action.order_details	Objeto con los mismos atributos del objeto parameters.	Objeto	Obligatorio

Crear plantilla de solicitud de pago

Nombre	Descripción	Tipo	Requerimientos
wba_id	Identificador de la cuenta empresarial de WhatsApp.	String	Obligatorio
name	Nombre de la plantilla. Debe ser único en la cuenta.	String	Obligatorio
language	Lenguaje de la plantilla.	String	Obligatorio
category	Categoría de la plantilla. Los valores pueden ser: UTILITY MARKETING	String	Obligatorio
structure.body.text	Texto principal de la plantilla.	String	Obligatorio
buttons.type	Debe ser "PAYMENT_REQUEST". Puede combinarse con botones de tipo URL y PHONE_NUMBER.	String	Obligatorio
buttons.text	Etiqueta del botón según el método de pago: Copy Pix code Copy Boleto code Open payment link	String	Obligatorio
payment_setting.type	Método de pago. Los valores pueden ser: pix_dynamic_code boleto payment_link	String	Obligatorio
pix_dynamic_code.code	Código de muestra de PIX. El valor real se envía al momento de enviar el mensaje.	String	Condicional
boleto.digitable_line	Línea digitable de muestra.	String	Condicional
payment_link.uri	Dirección de muestra.	String	Condicional

Enviar plantilla de solicitud de pago

Nombre	Descripción	Tipo	Requerimientos
components.type	Debe ser "button".	String	Obligatorio
components.subtype	Debe ser "payment_request".	String	Obligatorio
components.index	Posición del botón de pago dentro de la plantilla. Los valores pueden ser: 0, 1, 2.	Integer	Obligatorio
parameters.type	Debe ser "action".	String	Obligatorio
payment_setting.type	Método de pago. Los valores pueden ser: pix_dynamic_code boleto payment_link	String	Obligatorio
pix_dynamic_code.code	Código dinámico de PIX de la transacción.	String	Condicional
boleto.digitable_line	Línea digitable de la transacción.	String	Condicional
payment_link.uri	Dirección de pago de la transacción.	String	Condicional

Nota: en la plantilla de solicitud de pago, el objeto pix_dynamic_code admite únicamente el atributo code, a diferencia del utilizado en los mensajes de detalles del pedido.

Whatsapp — Anterior

Siguiente — Whatsapp