Sign in

v1

latestOpenAPI 3.1.02026-07-244531143.5 KB

Crear un nuevo pago - Argentina, Brasil, Chile, Ecuador y Perú

post/payment/new

Request body

currencystring required

Código ISO de la moneda: ARS/CLP/USD/PEN.

countrystring required

Código del país: AR/CL/EC/PE.

amountstring int32 required

Monto de la transacción <br>⚠️En Chile solo se aceptan montos enteros. Mientras que en Argentina, Perú y Ecuador se permite el uso de montos con decimales. <br><br/>Excepción: En Perú, los pagos con código de pago no permiten montos con decimales.

clientNamestring required

Nombre y apellido del cliente

clientEmailstring required

Correo electrónico del cliente. <br>

clientPhonestring required

Número de teléfono del cliente

clientDocumentTypestring

<br>⚠️<b>Requerido para Perú</b>. <br>Es el tipo de documento de identidad. El código puede ser: <br><br>DN: DNI <br>CE: Carné de extranjería <br>PP: Pasaporte <br><br> En <b>Argentina</b>, <b>Chile</b> y <b>Ecuador</b>, este tipo de documento no es requerido.

clientDocumentstring required

Número del documento de identidad del cliente. <br>

paymentMethodstring required

Método de pago. Consultar las tablas de Métodos por país de arriba.

bankCodestring

Para una solicitud a un banco específico (Direct Banks) en Chile. <br>Aquí debes colocar el valor del campo code obtenido en el endpoint de Lista de códigos bancarios.

Brasil Este campo es requerido para pagos con Pix en Brasil con cuenta bancaria registrada. Debes colocar el valor del campo bankCode obtenido de la Lista de códigos bancarios.

urlConfirmationstring required

Webhook. Conoce más información en este artículo.

urlFinalstring required

URL de redirección después de que el pago sea completado

urlRejectedstring required

URL de redirección en caso de que la transacción sea rechazada

orderstring int32 required

Identificador del pago a asociar. Debe ser único y no repetitivo

themestring

<b>Para personalizar el formulario de pago</b> (configuración válida para los paymentMethod: ar_chk_card_payment, ar_qr_payment, pe_qr_payment y pe_card_payment, mercadopagoqr_payment, mach_payment, yape_oneshot_payment, yape_cof_payment, bemovil_payment): <br>

<pre>"theme\": \"[{\\\"bgColor\\\": \\\"transparent\\\", \\\"mode\\\": \\\"dark\\\", \\\"logo\\\": \\\"hide\\\", \\\"type\\\": \\\"default\\\"}]"</pre> <br> <ul> <li>Valores posibles de <code>bgColor</code>: <code>transparent</code> | <code>#000000</code> (código hexadecimal de color) — Define el color de fondo de la interfaz. Valor por defecto: <code>#FFFFFF</code></li> <li>Valores posibles de <code>mode</code>: <code>dark</code> | <code>light</code> — Define el modo visual de la interfaz. Valor por defecto: <code>light</code></li> <li>Valores posibles de <code>type</code>: <code>default</code> | <code>simple</code> — Define el tipo de interfaz del contenedor. <code>simple</code> Muestra la interfaz sin contenedor, sin fondo ni espaciados. Recomendado para integraciones embebidas (ejemplo: iframes). Valor por defecto: <code>default</code></li> <li>Valores posibles de <code>logo</code>: <code>show</code> | <code>hide</code> — Indica si se muestra el logo del comercio en la interfaz. Valor por defecto: <code>hide</code></li> </ul>

<b>Para recibir el código QR directamente en la respuesta</b> (⚠️ configuración válida únicamente para el paymentMethod: pe_qr_payment y br_pix_payment):

<pre>"theme\": \"{\\\"type\\\":\\\"qr\\"}"</pre>
signstring required

La firma de los parámetros es única para cada transacción. Conoce cómo firmar en este artículo.

wallet_uidstring

⚠️Requerido solamente para los servicios de Perú-Yape On File. Es el identificador único (UID) de la afiliación de la wallet del cliente.

qr_onlystring

Para personalizar el QR payment template en Chile (configuración válida para el paymentMethod: mach_payment). Valores posibles: true | false

accountTypestring

Este parámetro es obligatorio para pagos con Pix en Brasil con cuentas bancarias registradas.

Estos son los posibles tipos de cuentas que se pueden enviar en el parámetro accountType para pagos con cuenta registrada con Pix en Brasil:

  • payment
  • checking
  • salary
  • savings
branchCodestring

Código de 4 dígitos que identifica la sucursal del banco asociada a la cuenta. Este campo es requerido para pagos con Pix en Brasil con cuenta bancaria registrada.

accountNumberstring

Número de cuenta del usuario. Este campo es requerido para pagos con Pix en Brasil con cuenta bancaria registrada.

citystring

Nombre de la ciudad del usuario. Este campo es requerido para pagos con Pix en Brasil con cuenta bancaria registrada.

codePostalstring

Código postal del usuario. Este campo es requerido para pagos con Pix en Brasil con cuenta bancaria registrada.

addressLine1string

Dirección del domicilio del usuario. Este campo es requerido para pagos con Pix en Brasil con cuenta bancaria registrada.

originstring required

Disponible para Yape One Shot. Define el origen desde donde se inicia la transacción. <br> Valores: <br>

  • mobile: La transacción se inicia desde una aplicación móvil.
  • web: La transacción se inicia desde un navegador web.