Guía de integración

Procobro

Comenza a aceptar todo tipo de pagos Empezá en sandbox hoy mismo: quickconnect-sandbox.pro-cobro.com

Montevideo, URY

Empezá en 3 pasos

De cero a tu primera operación en minutos, directo desde la terminal. Solo necesitás las credenciales de sandbox que te da Scanntech.

Obtené tu token

Canjeá el client_id y client_secret que recibís en el onboarding de Scanntech por un Bearer token. Dura 1 hora: cachealo y renovalo antes de que expire.

Reemplazá <CLIENT_ID> y <CLIENT_SECRET> por tus credenciales de sandbox. Guardá el access_token de la respuesta — va en el header Authorization de todos los pasos siguientes.

Ver la referencia completa →

Probalo
curl -X POST https://quickconnect-sandbox.pro-cobro.com/oauth/token \
  -H "Content-Type: application/json" \
  -d '
{
  "client_id": "<CLIENT_ID>",
  "client_secret": "<CLIENT_SECRET>"
}
'
Respuesta · 200
{
  "access_token": "eyJhbGciOi…",
  "token_type": "Bearer",
  "expires_in": 3600
}

Salí a producción

Validaste tus flujos en sandbox: pedile a Scanntech tus credenciales productivas y apuntá tu integración a https://quickconnect.pro-cobro.com. Mismos endpoints, mismos contratos.

Ver la referencia completa →

¿Integrás con un asistente de IA? Pasale /llms-full.txt — toda esta doc en markdown, lista para que tu agente escriba la integración. Y para buscar acá, apretá /.

Base URL

AmbienteURL
Sandboxhttps://quickconnect-sandbox.pro-cobro.com
Producciónhttps://quickconnect.pro-cobro.com

Todas las peticiones usan Content-Type: application/json.

Autenticación

Obtené un access token con las credenciales que recibís en el onboarding (un par por ambiente):

POST/oauth/token

El token dura 1 hora — cachealo y renovalo antes de que expire. Todas las demás llamadas lo llevan en el header Authorization; sin token válido la API devuelve 401.

Probalo
curl -X POST https://quickconnect-sandbox.pro-cobro.com/oauth/token \
  -H "Content-Type: application/json" \
  -d '
{
  "client_id": "<CLIENT_ID>",
  "client_secret": "<CLIENT_SECRET>"
}
'
Respuesta · 200
{
  "access_token": "eyJhbGciOi…",
  "token_type": "Bearer",
  "expires_in": 3600
}
Ejemplo
curl -X POST https://quickconnect-sandbox.pro-cobro.com/v1/payments \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Obtener un pago

GET/v1/payments/{id}

Devuelve el pago con su estado recomputado y el detalle de todas sus transacciones. Es la fuente de verdad: consultá acá después de recibir un evento, en vez de decidir por el nombre del evento.

CampoPara qué
statusEl estado recomputado del pago. Es la verdad (ver Estados)
current_amountEl monto vigente, ya con capturas parciales y reembolsos aplicados
transactions[]Cada movimiento con su fecha, para saber cómo se llegó hasta ahí
external_client_trace_idEl identificador que mandaste vos al crear el pago
Si el id no existe o es de otro cliente, la API responde 404 con "message": "payment not found".
Probalo
curl -X GET https://quickconnect-sandbox.pro-cobro.com/v1/payments/{id} \
  -H "Authorization: Bearer $ACCESS_TOKEN"
Respuesta · 200
{
  "id": "pay-dak3bkvudovnsbia9pj0",
  "intent": "authorization",
  "status": "REFUND_CAPTURED",
  "status_detail": "SUCCESS",
  "currency": "USD",
  "country": "URY",
  "initial_amount": 100,
  "current_amount": 0,
  "created_at": "2026-09-14T17:58:43.830183Z",
  "external_client_trace_id": "orden-12345",
  "transactions": [ { "id": "trx-…", "type": "AUTHORIZATION", "status": "APPROVED" } ]
}

Listar pagos

GET/v1/payments?page=1&page_size=50

Devuelve un listado paginado, ordenado por fecha de creación descendente. Se pagina con page y page_size.

ParámetroDefaultNotas
page1Número de página
page_size10Registros por página. No pidas más de 200 (ver abajo)
sortcreated_at:descTambién acepta created_at:asc
status—Filtra por estado del pago (ver Estados)
created_at_from / created_at_to—Rango de fechas, formato RFC3339
external_client_trace_id—Tu propio identificador de pedido
Campo de `pagination`Qué esperar
page / page_sizeLos valores efectivos de esta respuesta
totalCantidad de resultados. Se topea en 10000, y puede venir -1 cuando no se pudo contar
total_foundMismo valor que total. No aparece cuando no hay resultados
No pagines a ciegas contra total: con muchos resultados llega topeado en 10000 o en -1. Cortá cuando una página vuelva vacía, que es la señal confiable de fin de listado. Más allá del registro 10000 no se puede paginar.
Con page_size por encima de ~200 la respuesta se corta en 1 MB y el JSON llega inválido. Pedí de a 200 como máximo. Un parámetro que no exista devuelve 400 INVALID_QUERY_PARAM — no se ignora en silencio.

Los filtros de fecha se mandan en RFC3339 (2026-09-01T00:00:00Z). Ojo con las fechas de la respuesta: en este listado created_at y updated_at vuelven como Unix epoch en string ("1789408723"), mientras que GET /v1/payments/{id} las devuelve en RFC3339. Es el mismo pago con dos formatos según el endpoint.

Probalo
curl -X GET https://quickconnect-sandbox.pro-cobro.com/v1/payments?page=1&page_size=50 \
  -H "Authorization: Bearer $ACCESS_TOKEN"
Respuesta · 200
{
  "data": [ { "id": "pay-…", "status": "CAPTURED" } ],
  "pagination": {
    "page": 1,
    "page_size": 50,
    "total": 94,
    "total_found": 94
  }
}

Reembolsar un pago

POST/v1/refunds

Reembolsos parciales: enviá un amount menor al original. Solo aplica a pagos capturados (la captura automática tarda unos minutos); para deshacer un pago recién autorizado usá cancelar.

Probalo
curl -X POST https://quickconnect-sandbox.pro-cobro.com/v1/refunds \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '
{
  "payment_id": "pay-cu94vq1n8ql8u3v469gg",
  "amount": 1000,
  "currency": "COP"
}
'

Cancelar / Capturar

POST/v1/payments/{id}/cancel

Anula una autorización aún no capturada (void). Sin body.

POST/v1/payments/{id}/capture

Solo para captura diferida — por defecto los pagos se capturan automáticamente.

Probalo
curl -X POST https://quickconnect-sandbox.pro-cobro.com/v1/payments/{id}/cancel \
  -H "Authorization: Bearer $ACCESS_TOKEN"
Probalo
curl -X POST https://quickconnect-sandbox.pro-cobro.com/v1/payments/{id}/capture \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Contracargos

GET/v1/chargebacks

Se pagina igual que los pagos, con page y page_size, y la respuesta trae el detalle completo de cada disputa — no hace falta una segunda consulta.

Acá el tope de page_size es 25, y pedir más devuelve 400 BAD_PARAMETERS. Es distinto del listado de pagos — no asumas el mismo límite en los dos.

Mirá expires_at para el plazo de respuesta y reason_id para saber qué evidencia hace falta. Los estados que vas a ver son PENDING, INFO_REQUESTED y REPRESENTED.

Probalo
curl -X GET https://quickconnect-sandbox.pro-cobro.com/v1/chargebacks \
  -H "Authorization: Bearer $ACCESS_TOKEN"
Respuesta · 200
{
  "data": [
    {
      "id": "cbk-dak2l26kfdel09fpl9rg",
      "payment_id": "pay-dahebpuuf97kkem2n3fg",
      "transaction_id": "trx-dahebpuuf97kkem2n3f0",
      "status": "PENDING",
      "reason_id": "10_4",
      "reason_description": "Otros Fraudes – Ambiente de Tarjeta Ausente",
      "amount": 100,
      "currency": "URY",
      "created_at": "2026-09-14T17:10:32.26776Z",
      "expires_at": "2026-10-04T05:00:00Z"
    }
  ],
  "pagination": { "page": 1, "page_size": 25, "total": 3, "total_found": 3 }
}

Sandbox: probá el formulario

Antes de escribir una línea de backend, jugá con la sesión de captura acá mismo. Cambiá el layout, los labels, un color de variables o el submit_button y mirá cómo se redibuja el formulario de tarjeta. Es el mismo body que después le vas a mandar a POST /v1/instruments/collect-sessions.

Simulación localProbá el appearance de la sesión

Editá el JSON y mirá cómo se redibuja el formulario. Es una maqueta que corre en tu navegador: no es el iframe real y no sale una sola request. El formulario de producción lo sirve Akua desde su propio origen y no le podés pasar CSS ni clases tuyas: lo único que viaja es el objeto appearance, con un vocabulario cerrado que Akua valida y traduce a CSS de su lado. Probá romperlo —un valor fuera de rango, una clave que no existe— y vas a ver los mismos details[] que te devolvería un 400 invalid_appearance.

Config · POST /v1/instruments/collect-sessions

Config válido. El Idempotency-Key va en el header, no acá. Una vez creada la sesión su look queda congelado: para cambiarlo, creá una sesión nueva.

Datos de la tarjetaes
Nombre en la tarjeta
Número de tarjeta
Vencimiento
Código de seguridad

Fuera del iframe · submit_button.mode: "external" — este botón es tuyo, lo estilás vos y llama a submit().

trace_id: orden-83779 · layout two-row · labels floating

La maqueta dibuja base, empty, complete, focus e invalid. placeholder, disabled, autofill y hover se validan igual, pero acá no se ven. El ancho y el alto del iframe nunca los ponés vos.

Ojo con lo que te llevás de acá: tu CSS no entra al formulario. Se sirve en un iframe desde otro origen —por eso tu sitio queda en PCI SAQ A— y la única manera de moverlo es el objeto appearance, que Lo validamos y lo traducimos a CSS de nuestro lado. Probá meterle un valor fuera de rango o una propiedad que no esté en la tabla: vas a ver el mismo 400 invalid_appearance que te devolvería la API. El contrato completo está en Apariencia del formulario.

Cómo funcionan los campos de tarjeta

Akua Fields te deja cobrar con tarjeta sin que el cliente salga de tu sitio y sin que vos toques el número de tarjeta. Un iframe servido desde otro origen captura los datos, los guarda en la bóveda y te devuelve un instrument_id (ins-…). Tu backend cobra ese id.

Ni tus páginas ni tus servidores ven nunca un número de tarjeta. Eso es lo que te mantiene en PCI SAQ A, el alcance más chico: si el PAN pasara por tu dominio, el alcance se dispara.
PasoDónde correQué pasa
1Tu backendPedís un token con tus credenciales de comercio
2Tu backendCreás una sesión de captura y guardás su id
3BrowserEl iframe captura la tarjeta y la tokeniza
4Tu backendLeés la sesión y obtenés el ins-…
5Tu backendCobrás contra ese instrumento
6Tu backendLeés el pago para tu pantalla de resultado
Para desarrollar no hace falta habilitar nada: localhost y 127.0.0.1 se aceptan con cualquier puerto en sandbox. En producción se rechazan, igual que un dominio parecido como localhost.evil.com.

El browser nunca le habla a la API de pagos. Le habla a dos rutas tuyas, que construís vos en tu backend y que son las que llevan el token de comercio:

RutaQuién la construyeQué hace por dentro
POST /api/sessionVosCrea la sesión de captura y le devuelve al browser solo la url
POST /api/payVosLee la sesión, saca el ins-… y cobra
El iframeNosotrosLo monta el script. Va directo, sin pasar por tu backend
Los nombres /api/session y /api/pay son de ejemplo: poneles los que quieras. Lo que no cambia es que el secreto de comercio vive solo en tu backend — si el browser pudiera pedir un token, cualquiera podría cobrar en tu nombre.

Las llamadas de tu backend salen contra tu base URL, con Authorization: Bearer y nada más — las mismas de cualquier otro endpoint de esta doc.

QuéContra qué host vaPor qué
Tus llamadas de backendTu base URLEs la integración: corre sobre tu dominio
El <script> y el iframeOtro origenAhí viaja la tarjeta. Si se sirviera desde tu dominio, entraría en tu alcance PCI
La url de la sesiónOtro origenLa devuelve la API ya armada; apunta a la página que captura la tarjeta
Esos dos últimos no se proxean ni se re-hostean. No es una limitación: es exactamente lo que te deja en SAQ A, porque la tarjeta nunca toca un dominio tuyo.

Crear una sesión

Esto es lo que hace tu POST /api/session por dentro: una sesión por checkout, desde tu backend. Guardá el id con tu pedido y mandale al browser solo la `url`.

POST/v1/instruments/collect-sessions
CampoReq.Notas
trace_id—Tu identificador de pedido. Vuelve en la sesión y en el pago
appearance—El look del formulario: layout, labels, locale, show_holder, submit_button, placeholders, variables y styles. Ver Apariencia del formulario
Idempotency-Key✓Va en el header. Sin él la API responde 400 invalid_request
La parte #s= de la url es un secreto: es la capability que habilita esa sesión. No la loguees ni la guardes más allá del checkout. Las sesiones vencen a los 15 minutos.
Devolvé únicamente la url. El id de sesión te lo guardás vos: es lo que vas a usar en /api/pay para leer el instrumento, y no tiene por qué viajar al browser.

El appearance del ejemplo es el mínimo. Acá es el único momento en que podés definir cómo se ve el formulario —después queda congelado—, así que si querés acercarlo a tu marca, mandalo completo: el vocabulario entero está en Apariencia del formulario.

Probalo
curl -X POST https://quickconnect-sandbox.pro-cobro.com/v1/instruments/collect-sessions \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '
{
  "trace_id": "orden-83779",
  "appearance": {
    "locale": "es"
  }
}
'
Respuesta · 201
{
  "id": "ise-davvj6sv88n403qvlp70jicabrmbtv3p5gep",
  "url": "https://sandbox.akua.la/v1/pci-views/collect/ise-davvj6…#s=<capability>",
  "status": "OPEN",
  "expires_at": "2026-10-02T20:37:11Z",
  "view_version": "1.2.0",
  "trace_id": "orden-83779"
}
Tu backend · POST /api/session
// Tu base URL. Sale del onboarding, no se hardcodea por ambiente.
const BASE = "https://quickconnect-sandbox.pro-cobro.com";

// El browser llama a ESTA ruta, no a la API de pagos.
app.post("/api/session", async (req, res) => {
  const token = await getMerchantToken();   // cacheado, credencial mer-

  const r = await fetch(`${BASE}/v1/instruments/collect-sessions`, {
    method: "POST",
    headers: {
      Authorization: `Bearer ${token}`,
      "Idempotency-Key": crypto.randomUUID(),
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ trace_id: order.id, appearance: { locale: "es" } }),
  });
  const s = await r.json();

  await guardarSesion(order.id, s.id);       // el id queda de tu lado
  res.json({ url: s.url });                 // al browser va SOLO la url
});

Apariencia del formulario

El look del formulario se define al crear la sesión, en el objeto appearance del body de arriba. No le pasás CSS ni clases tuyas: mandás opciones de un vocabulario cerrado, Validamos cada valor y armamos el CSS de nuestro lado. Eso es lo que te deja acercarlo a tu marca sin que el iframe deje de ser de nosotros —y sin que tu sitio salga de PCI SAQ A.

Layout y comportamiento — las perillas de estructura:

ClaveValoresQué hace
layoutone-row · two-row · stackedCómo se acomodan los campos
labelsabove · floating · hiddenDónde va la etiqueta de cada campo
localees (default) · pt · enIdioma de etiquetas y mensajes
show_holdertrue · falseAgrega el campo de nombre del titular
submit_button.modeexternal · insideexternal: el botón es tuyo y llama a submit(). inside: el botón va adentro del frame
submit_button.textString, hasta 32 caracteresTexto del botón de adentro
placeholdersnumber · expiry · cvc · holderTexto de ejemplo de cada input, hasta 40 caracteres cada uno

`variables`: el tema. Se aplican a todo el formulario de una, y son lo primero que conviene tocar: con estas siete líneas el formulario ya se parece al tuyo.

VariableValor
colorText · colorPrimary · colorDanger · colorSuccessUn color: #hex, rgb() o hsl()
colorPlaceholder · colorBackground · colorBorderUn color: #hex, rgb() o hsl()
fontSizeBase12–24px
borderRadius0–24px
spacingUnit0–8px
fontFamilyUn font ID, no una lista CSS de fuentes. Hoy existe solo system; las self-hosted están planificadas

`styles`: el control fino. La forma es siempre styles.<elemento>.<estado>.<propiedad>:

NivelValores
Elementosinput · label · button · error
Estadosbase · focus · invalid · complete · empty · placeholder · disabled · autofill · hover

Y estas son las propiedades permitidas, con su rango. Lo que no está en la tabla no existe:

PropiedadRango
color · background-color · border-color · caret-colorUn color (#hex, rgb() o hsl())
font-size12–24px
font-weight100–900, de a 100
line-height1.00–2.00, sin unidad
letter-spacing0–2px
text-transformnone · uppercase · lowercase · capitalize
padding (de 1 a 4 valores) · padding-top · padding-right · padding-bottom · padding-left · margin-top0–32px
border-width0–4px
border-radius0–24px

Claves desconocidas. Cualquier clave o propiedad CSS que no esté en las tablas de arriba hace fallar la creación con 400 invalid_appearance, y details[] te lista todos los problemas de una, no el primero. Ahí caen url(), width, height, box-shadow, las transiciones y cualquier otra cosa que no figure.

Contraste. El texto, el error y el placeholder necesitan al menos 4.5:1 contra el fondo; el borde, 3:1. El color del texto del botón primario lo elige nosotros —blanco o casi negro, el que lea mejor—, no vos. Una paleta que no llega se rechaza al crear la sesión.

Defaults por cliente. La configuración de tu cliente puede traer un appearance_defaults. Lo que mandás al crear la sesión pisa esos defaults, y lo que no define ninguno de los dos lo completan los defaults de la plataforma.

Una vez creada la sesión, su apariencia queda congelada. No hay manera de repintar un formulario ya abierto: si querés cambiarlo, creá una sesión nueva.

Lo que no controlás, por más que lo mandes:

QuéPor qué
El ancho del iframeOcupa el contenedor que vos le des
El alto del iframeEl frame reporta su propio alto (entre 60 y 800px) y embed.js lo redimensiona
Todo lo que está afuera del iframeEl espaciado alrededor, o la tarjeta que lo envuelve, son tu página y tu CSS
appearance completo
{
  "trace_id": "orden-83779",
  "appearance": {
    "layout": "two-row",
    "labels": "floating",
    "locale": "es",
    "show_holder": true,
    "submit_button": { "mode": "external" },
    "placeholders": {
      "number": "1234 1234 1234 1234",
      "expiry": "MM/AA",
      "cvc": "CVC",
      "holder": "Nombre en la tarjeta"
    },
    "variables": {
      "colorBackground": "#1d232a",
      "colorText": "#e6e9ed",
      "colorBorder": "#7d8b99",
      "colorPlaceholder": "#98a3af",
      "colorPrimary": "#5aa7f0",
      "colorDanger": "#ff8b8f",
      "borderRadius": "8px",
      "fontSizeBase": "16px",
      "spacingUnit": "8px",
      "fontFamily": "system"
    },
    "styles": {
      "input": {
        "base": { "font-size": "18px", "padding": "12px 14px", "border-width": "1px", "letter-spacing": "1px" },
        "focus": { "border-color": "#5aa7f0" },
        "invalid": { "border-color": "#ff8b8f" }
      },
      "label": { "base": { "font-weight": 600, "text-transform": "uppercase" } },
      "button": { "base": { "border-radius": "12px" } }
    }
  }
}
Respuesta
{
  "styles": {
    "input": {
      "base": { "font-size": "18px", "padding": "12px 14px" },
      "focus": { "border-color": "#5aa7f0" },
      "invalid": { "border-color": "#ff8b8f" }
    },
    "label": { "base": { "font-weight": 600, "text-transform": "uppercase" } }
  }
}

Montar el formulario

Cargá el script con su hash SRI, montá el campo de tarjeta y pasá el submit de tu formulario por handleSubmit(payAction). El src del script y el iframe son lo único que apunta al origen de otro origen: ahí viaja la tarjeta.

Si preferís el build ES module, es el mismo recurso con otro nombre y su propio hash — el integrity es del archivo, así que no se puede reusar el del otro build.

Fijá siempre la versión del script y su integrity. Sin SRI, cualquier cambio en el archivo servido entra a tu página de checkout sin que te enteres.
Lo que ves en el JSA dónde va realmente
fetch("/api/session")Tu backend — el que creás vos (ver Crear una sesión)
fetch("/api/pay")Tu backend — lee la sesión y cobra (ver las dos secciones siguientes)
AkuaCardEntry.mount(...)Monta el iframe, que habla directo con Akua
Ninguna de esas dos rutas lleva credenciales en el browser: /api/session y /api/pay son tuyas, y el token de comercio no sale nunca de tu servidor. El browser solo mueve el sessionId.
HTML
<script src="https://sandbox.akua.la/v1/pci-views/1.2.0/embed.js"
        integrity="sha384-PWjrkxk2wTdMffNYwDW4Ir0+WKiANjvdEwbTVvzZfYVXn7dCawHNSfkGrfwSYfol"
        crossorigin="anonymous"></script>

<form id="checkout">
  <input name="email" type="email" required>
  <div id="card"></div>
  <button type="submit">Pagar</button>
</form>
JavaScript
const card = AkuaCardEntry.mount("#card", {
  // Tu endpoint llama al paso 2 y devuelve { url }.
  // Se vuelve a llamar solo si la sesion vence.
  session: async () => (await fetch("/api/session", { method: "POST" })).json(),
});

const form = document.getElementById("checkout");
form.onsubmit = card.handleSubmit(async ({ sessionId }) => {
  // La tarjeta ya esta en la boveda. Mandas solo el id de sesion:
  // tu backend hace los pasos 4 y 5.
  const r = await fetch("/api/pay", {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify({ sessionId }),
  });
  const out = await r.json();
  if (!r.ok) throw new Error("declined");
  location.assign(`/resultado/${out.order_id}`);
});

card.on("error", (e) => console.warn(e.code, e.source, e.retryable));
ES module
<script type="module"
        src="https://sandbox.akua.la/v1/pci-views/1.2.0/embed.mjs"
        integrity="sha384-JQyHgvWEyxR9dSCYmKI9MGzQMH3DXZxl/UBRKtsoaAq8n/3HaDyDIPeYsclJ/5wW"
        crossorigin="anonymous"></script>

Leer la sesión

Primer paso de tu POST /api/pay. El browser te manda el sessionId; con él leés la sesión. Cobrá solo si status es COMPLETED, y tomá el instrumento de esta respuesta — nunca del browser.

GET/v1/instruments/collect-sessions/{id}
`status`Qué significa
OPENTodavía no hay tarjeta cargada
COMPLETEDLa tarjeta quedó en la bóveda: podés cobrar
EXPIRED · REVOKEDCreá una sesión nueva
Un instrument.id que venga del browser no se cobra. El browser solo manda el sessionId; el ins-… sale de esta respuesta, del lado del servidor. Si confiaras en el id del cliente, cualquiera podría mandarte el instrumento de otro.
Probalo
curl -X GET https://quickconnect-sandbox.pro-cobro.com/v1/instruments/collect-sessions/{id} \
  -H "Authorization: Bearer $ACCESS_TOKEN"
Respuesta · 200
{
  "id": "ise-davvj6…",
  "status": "COMPLETED",
  "trace_id": "orden-83779",
  "merchant_id": "mer-d6g518rbl6sg4fe3a7b0",
  "instrument": {
    "id": "ins-dacercdni7pdrioheibg",
    "type": "CARD",
    "card": {
      "last_four_digits": "1111",
      "expiration_month": "12",
      "expiration_year": "30",
      "bin_data": { "card_brand": "VISA", "card_type": "DEBIT" }
    }
  }
}

Cobrar el instrumento

El monto y la moneda salen de tu pedido, nunca del browser. Usá una Idempotency-Key por intento de pago, guardada junto al pedido.

POST/v1/payments/authorizations
El amount.value va en unidades mínimas y como string: "1000" son 10,00 USD.

Cuotas. Para cobrar en cuotas mandá installments.quantity. La cantidad tiene que estar entre las habilitadas para tu comercio: cualquier otra se rechaza con invalid number of installments. Con quantity: 1 no hay plan de cuotas.

Mandá solo `quantity`. El tipo de plan lo resolvemos nosotros según cómo esté configurado tu comercio, y mandarlo a mano pisa esa configuración — que es casi siempre lo que no querés.

Si no mandás installments.type, se resuelve en este orden: el modo del producto del rail para esa cantidad, después el modo configurado para tu comercio, y si no hay ninguno, average-payment. En Uruguay los dos modos de comercio son plazo promedio ponderado (una sola presentación, cobrada al plazo promedio) y cuota a cuota (el comercio cobra una cuota por mes).

`type`Qué significa
average-paymentPlazo promedio ponderado: una presentación, al plazo promedio del plan
merchant-financedCuota a cuota — el comercio financia. Exige `capture.mode: AUTOMATIC`
issuer-financedFinancia el banco emisor
issuer-approved-zero-interestCuotas sin interés aprobadas por el emisor
acquirer-financedFinancia el adquirente
Un type fuera de esa lista se rechaza con invalid installment payment type. Y si mandás merchant-financed sin capture.mode: AUTOMATIC, la autorización se rechaza.

Ojo al leer el pago: el GET lo devuelve en singular y con un flag aparte — installment: { quantity, type } y with_installment: true.

La respuesta es sincrónica: 201 con la transacción aprobada, o un rechazo. Después, leé el pago con GET /v1/payments/{id} para tu pantalla de resultado.

Si el cobro te da timeout o 5xx, reintentá con la misma `Idempotency-Key`: te devolvemos el resultado original en vez de cobrar dos veces. Solo un intento nuevo lleva clave nueva.
Probalo
curl -X POST https://quickconnect-sandbox.pro-cobro.com/v1/payments/authorizations \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '
{
  "instrument": {
    "id": "ins-dacercdni7pdrioheibg"
  },
  "amount": {
    "value": "1000",
    "currency": "USD"
  },
  "intent": "authorization",
  "entry_mode": "not-present",
  "initiator": "customer",
  "order_type": "purchase",
  "capture": {
    "mode": "AUTOMATIC"
  },
  "installments": {
    "quantity": 12
  },
  "trace_id": "orden-83779"
}
'
Respuesta · 201
{
  "payment_id": "pay-davvj781lhpi4eppkbt0",
  "instrument_id": "ins-dacercdni7pdrioheibg",
  "response_code": "00",
  "response_code_description": "Approval and completed successfully",
  "transaction": { "id": "trx-…", "type": "AUTHORIZATION", "status": "APPROVED" }
}
Tu backend · POST /api/pay
// Mismo BASE que en /api/session.
const BASE = "https://quickconnect-sandbox.pro-cobro.com";

// El browser manda { sessionId } y nada mas. El monto sale de TU pedido.
app.post("/api/pay", async (req, res) => {
  const { sessionId } = req.body;
  const order = await buscarPedidoPorSesion(sessionId);
  const token = await getMerchantToken();
  const h = { Authorization: `Bearer ${token}` };

  // 1. Leer la sesion: de aca sale el instrumento.
  const s = await (await fetch(
    `${BASE}/v1/instruments/collect-sessions/${sessionId}`, { headers: h }
  )).json();
  if (s.status !== "COMPLETED") return res.status(409).json({ error: "sesion incompleta" });

  // 2. Cobrar. Una Idempotency-Key por intento, guardada con el pedido.
  const r = await fetch(`${BASE}/v1/payments/authorizations`, {
    method: "POST",
    headers: { ...h, "Idempotency-Key": order.payKey, "Content-Type": "application/json" },
    body: JSON.stringify({
      instrument: { id: s.instrument.id },
      amount: { value: order.amountMinor, currency: order.currency },
      intent: "authorization",
      entry_mode: "not-present",
      initiator: "customer",
      order_type: "purchase",
      capture: { mode: "AUTOMATIC" },
      trace_id: order.id,
    }),
  });

  const out = await r.json();
  res.status(r.status).json({ order_id: order.id, payment_id: out.payment_id });
});

Errores de Akua Fields

Los de la API de sesiones (pasos 2 y 4):

Código`error_code`Qué hacer
400validation_error · invalid_appearance · invalid_requestCorregí el campo que nombra details[]. Falta la Idempotency-Key → invalid_request
401—Token ausente o vencido: pedí uno nuevo
403merchant_token_requiredNecesitás una credencial de comercio
403authorization_denied · origin_not_allowedTu origen no está habilitado. Pedilo a tu proveedor
404resource_not_foundId de sesión inexistente, o de otro comercio
409idempotency_conflictReusaste una Idempotency-Key con otro body
429rate_limitedEsperá lo que diga Retry-After
503upstream_unavailableReintentá con la misma clave

Y los del formulario, que llegan por card.on("error"):

`code`Qué significa
invalid_number · invalid_expiry · invalid_cvcEl iframe ya le muestra el mensaje al cliente; lo corrige él
session_expired · session_inactiveCon session el script reemplaza la sesión una vez solo. Si no, remontá
frame_load_timeoutCasi siempre: tu origen no está habilitado, la URL de sesión ya se usó, o red
payment_failedTu payAction lanzó una excepción. El error original está en error.cause
invalid_usageLlamaste a card.handleSubmit sin pasarle el payAction

Desde la 1.0.0 el error que te llega por on("error") trae el trace_id del server. Guardalo: es el identificador con el que soporte encuentra ese request exacto, y te ahorra tener que describir el síntoma.

Alcanza con Authorization: Bearer (más Content-Type y la Idempotency-Key donde aplique). No mandes `Client-Id` ni `Merchant-Id`: la ruta matchea por tu base URL y el comercio sale del token, porque la credencial está atada a él. Por lo mismo tampoco hace falta merchant_id en el body de la autorización.

Cómo funcionan los webhooks

Un 201 significa que recibimos y procesamos tu solicitud, no que cobraste. El desenlace del emisor viaja adentro de esa respuesta, en transaction.status. Un rechazo también llega con 201.

Confirmar un pedido mirando solo el código HTTP es el error de integración más caro que se puede cometer. Leé transaction.status, nunca el 201 a secas.

Hay resultados que todavía no existen cuando tu request termina: la compensación en la red, el reembolso acreditado, un contracargo. Todo eso llega por otro canal — te hacemos POST a una URL tuya cada vez que algo cambia, con el cuerpo firmado.

Cómo cobrásQué trae la respuesta HTTPQué esperás por evento
Link de pagoEl link creado, todavía sin pagarTodo el resultado del cobro
CapturaQue la captura se registróQue completó la compensación en la red
CancelaciónQue la anulación se registróQue los fondos quedaron liberados
ReembolsoQue el reembolso se aceptóQue se acreditó al tarjetahabiente

Los payloads son delgados a propósito: traen identificadores, no el pago entero. Un cuerpo con el recurso completo llegaría desactualizado ante cualquier reintento o entrega tardía.

La regla es fija: recibís el evento, verificás la firma y vas a buscar el recurso con GET /v1/payments/{id}. Ese GET devuelve el estado recomputado y es la única fuente de verdad.
Respuesta
{
  "type": "payment.capture.cleared",
  "data": {
    "trace_id": "order-34324366",
    "payment_id": "pay-d07u8e218e1elk12b92g",
    "transaction_id": "trx-d0gv1122dpo29a8d7l4g"
  }
}

Configurar tu webhook

La configuración se hace desde el panel de comercios: ahí definís la URL HTTPS que recibe las entregas y los eventos a los que te suscribís. No hace falta llamar a ninguna API.

Al crearlo se genera el secreto de firma con el que vas a verificar cada entrega. Tratalo como una credencial.

Verificar la firma

Antes de mirar el contenido de un evento, comprobá que salió de nosotros. Cada entrega lleva tres encabezados que juntos son la prueba de origen.

EncabezadoQué contiene
akua-wh-idIdentificador único del mensaje, con prefijo msg_. Sirve además para deduplicar
akua-wh-timestampMomento del intento, en segundos Unix
akua-wh-signatureUna o varias firmas separadas por espacio, con el formato v1,<base64>

La firma es un HMAC-SHA256 sobre los tres elementos concatenados con puntos: id + "." + timestamp + "." + cuerpo_crudo. La clave es el secreto sin el prefijo whsec_, decodificado desde Base64.

Se firma el cuerpo crudo, byte por byte. Si tu framework parsea el JSON y lo volvés a serializar, cambia el espaciado y el orden de las claves, y la firma no va a coincidir nunca. Guardá los bytes originales antes de parsear.

Que el encabezado admita varias firmas no es decorativo: es lo que permite rotar el secreto sin cortar la entrega. Durante la rotación llegan dos y basta con que una cierre.

Una entrega real
POST /webhooks HTTP/1.1
Content-Type: application/json
User-Agent: akua-webhooks/1.0
akua-wh-id: msg_p5jXN8AQM9LWM0D4loKWxJek
akua-wh-timestamp: 1614265330
akua-wh-signature: v1,g0hM9SsE+OTPJTGt/tmIKtSyZlE3uFJELVlNIOLJ1OE=

{"type":"payment.authorization.processed","data":{"trace_id":"order-34324366","payment_id":"pay-d07u8e218e1elk12b92g","transaction_id":"trx-d0gv1122dpo29a8d7l4g"}}
Node.js, sin dependencias
import crypto from "crypto";

const TOLERANCIA = 5 * 60;

export function verificarFirma(secret, headers, rawBody) {
  const id = headers["akua-wh-id"];
  const ts = headers["akua-wh-timestamp"];
  const firmas = headers["akua-wh-signature"];
  if (!id || !ts || !firmas) return false;

  // Ventana temporal, contra ataques de repeticion.
  if (Math.abs(Math.floor(Date.now() / 1000) - parseInt(ts, 10)) > TOLERANCIA) {
    return false;
  }

  const clave = Buffer.from(secret.replace(/^whsec_/, ""), "base64");
  const esperada = crypto
    .createHmac("sha256", clave)
    .update(`${id}.${ts}.${rawBody}`)
    .digest();

  // Comparacion en tiempo constante contra cada firma v1.
  return firmas
    .split(" ")
    .filter((p) => p.startsWith("v1,"))
    .map((p) => Buffer.from(p.slice(3), "base64"))
    .some((f) => f.length === esperada.length && crypto.timingSafeEqual(f, esperada));
}

Entrega y reintentos

La entrega es al menos una vez: es preferible que un evento llegue dos veces a que se pierda. Tu receptor tiene que tolerar duplicados, y el código con el que respondés decide qué pasa después.

Qué respondésQué hacemos
2xxEntrega exitosa. No hay más intentos
5xxEscalera completa: hasta 8 intentos a lo largo de unas 27 horas
408 o 429Escalera completa, con un piso de 60 segundos entre intentos
400, 401, 403, 404Escalera corta: 3 intentos en unas 6 horas
Resto de 4xxTerminal. Se descarta en el primer intento
Nada (timeout)Escalera completa, con piso de 60 segundos

El timeout de entrega es de 15 segundos. Tu endpoint tiene dos trabajos: verificar la firma y acusar recibo rápido. Todo lo demás va después del 200, en una cola tuya.

Si actualizás inventario, cobrás impuestos y mandás un correo antes de responder, tarde o temprano vas a superar los 15 segundos y el evento va a volver a entrar como si nunca hubiera llegado.
IntentoEspera desde el anteriorAcumulado
1inmediato0
25 segundos5 s
35 minutos5 min
430 minutos35 min
52 horas2 h 35 min
65 horas7 h 35 min
710 horas17 h 35 min
810 horas27 h 35 min

Sobre esas esperas se aplica un ruido aleatorio de ±20 %, para que mil comercios que caen a la vez no reintenten en el mismo instante. Si tu respuesta trae Retry-After, lo respetamos, acotado entre la espera base y el doble de esa espera.

Si un webhook falla de forma continua durante 24 horas, sin ninguna entrega exitosa que reinicie el contador, se desactiva y deja de recibir eventos. Cualquier entrega exitosa reinicia la ventana. Los eventos de ese período se recuperan consultando los pagos.

El mismo evento puede llegar más de una vez. La defensa es una sola: guardá el akua-wh-id de cada mensaje procesado y descartá el que ya viste. Que el candado viva en la base de datos, con una restricción de unicidad — un chequeo en memoria falla en cuanto tenés dos instancias del receptor.

IdentificadorPara qué sirve
Idempotency-KeyProtege los requests que vos nos mandás
akua-wh-idDeduplica los eventos que nosotros te mandamos
payment_idIdentifica el recurso, no el mensaje. No sirve para deduplicar

Eventos de pago

Los eventos del ciclo de vida de un pago. Cada nombre sigue el patrón recurso.accion.resultado y todos comparten el mismo payload de tres campos: trace_id, payment_id y transaction_id.

EventoQué significaQué hacer
payment.authorization.processedEl emisor aprobó la autorización. Los fondos quedaron reservadosConsultar el pago y avanzar el pedido. Todavía no se cobró nada
payment.authorization.rejectedEl emisor o la red rechazaron la autorizaciónConsultar el pago para leer el código de red y ofrecer otro medio
payment.capture.manual.processedRecibimos tu captura y sale a la red en el ciclo siguienteMarcar el pedido como cobrado a la espera de compensación
payment.capture.automatic.processedLo mismo, para una captura automáticaIgual que la manual
payment.capture.clearedLa captura completó el ciclo de compensaciónCerrar el pedido. Es el final del ciclo de red
payment.cancel.processedSe anuló una autorización. Los fondos quedaron liberadosLiberar el pedido y avisar al cliente
payment.cancel.rejectedLa anulación fue rechazada, por ejemplo porque ya se capturóConsultar el pago. Si ya está capturado, el camino es un reembolso
payment.refund.clearedEl reembolso completó el ciclo de compensaciónCerrar el caso de devolución
payment.refund.rejectedLa red rechazó el reembolsoConsultar el pago y revisar el motivo antes de reintentar
En sandbox no corre el ciclo de compensación. payment.capture.cleared y payment.refund.cleared no se pueden probar ahí: si los estás esperando, no están tardando.

Suscribite solo a lo que vas a procesar. Un webhook que recibe todo y descarta la mayoría gasta capacidad de tu receptor y hace más difícil leer tus logs.

Si cobrás asíSuscribite a
Captura manualauthorization.processed, authorization.rejected, capture.manual.processed, capture.cleared
Captura automáticaauthorization.processed, authorization.rejected, capture.automatic.processed, capture.cleared
Devolucionesrefund.cleared, refund.rejected

Reconstruir el estado

Los eventos no llegan en orden. Un capture.cleared puede llegarte antes que el capture.manual.processed que lo precedió, porque el primero salió limpio y el segundo tuvo que reintentar. Una integración que trate el último evento recibido como el estado actual va a marcar como rechazados pedidos que se cobraron.

No decidas nada con el nombre del evento. Decidí con el status que devuelve el GET. El evento es el disparador; el pago es el dato.

El estado de un pago no es un campo que se sobrescribe: se recalcula ordenando todas sus transacciones por timestamp. Guardá la marca temporal de lo que aplicaste y rechazá cualquier escritura más vieja. Y una regla que no cuesta nada: un estado terminal no se revisa.

Ningún receptor tiene 100 % de disponibilidad. Un barrido periódico cierra la brecha sin depender de que la entrega haya funcionado: consultá los pagos que quedaron en un estado no terminal dentro de una ventana de tiempo. Cada 15 minutos sobre la última hora cubre la mayoría de los casos, más una pasada diaria más ancha.

No hagas polling agresivo sobre GET /v1/payments/{id} como reemplazo de los eventos. Consultar cada segundo por cada pago abierto te va a costar cuota y no te va a enterar antes: el evento sale en cuanto el estado cambia.
Reconciliar ante cada evento
async function reconciliar(paymentId) {
  const pago = await api.get(`/v1/payments/${paymentId}`);

  // La transaccion mas reciente marca hasta donde llega esta foto del pago.
  const marca = pago.transactions.map((t) => t.timestamp).sort().at(-1);

  // UPDATE ... WHERE marca_aplicada < $marca. Una foto vieja no pisa una nueva.
  await guardarSiEsMasNuevo(paymentId, pago.status, marca);
}

Estados de un pago

El status del pago. Es el valor que devuelve GET /v1/payments/{id} y el que acepta el filtro status del listado.

EstadoSignificado
CREATEDCreado, todavía sin procesar
PENDING_CUSTOMEREsperando que el cliente complete el pago
FRAUD_REVIEWEn revisión antifraude
AUTHORIZEDAutorizado: fondos reservados, pendiente de captura
REJECTEDRechazado por el emisor o la red
CANCELLEDAnulado antes de la captura
CAPTURE_IN_PROGRESSCaptura en curso
CAPTURE_PRESENTEDCaptura presentada a la red, esperando compensación
CAPTUREDCapturado
SETTLEDLiquidado
COMPLETEDCompletado
REFUND_AUTHORIZED · REFUND_PRESENTED · REFUND_CAPTUREDEl reembolso avanzando en la red hasta acreditarse
REFUND_REJECTED · REFUND_FAILEDEl reembolso no prosperó
FAILEDError técnico durante el procesamiento
No existen los estados APPROVED, PENDING ni REFUNDED. APPROVED es el estado de una transacción dentro de transactions[], no del pago. Filtrar por un estado que no existe devuelve 200 con la lista vacía, sin ningún error que te avise.

Errores

CódigoCausa
400 · INVALID_QUERY_PARAMUn parámetro de query que el endpoint no soporta. El mensaje dice cuál
400 · BAD_PARAMETERSUn valor fuera de rango, por ejemplo page_size mayor al máximo
401Falta el token, está vencido o la firma no cierra
404Recurso inexistente (payment not found) o ruta inexistente (route not found)
429Rate limit — reintentá con backoff
5xxError transitorio — reintentá con backoff

Los errores vienen con la misma forma. Guardá el trace_id: es lo que hace falta para que soporte encuentre tu request.

Un parámetro mal escrito no se ignora: devuelve 400 y la llamada no se ejecuta. En cambio un valor no numérico en page o page_size sí se ignora y se usa el default.
Respuesta
{
  "error_code": "resource_not_found",
  "error_type": "not_found",
  "message": "payment not found",
  "trace_id": "req-dampr99ma4dqhvj1d1p0"
}

Tarjetas de prueba (sandbox)

NúmeroResultado
4111 1111 1111 1111Aprobada (Visa)
5186 1700 7000 1108Aprobada (Mastercard)