AME

Esta documentación describe la integración con AME a través de Carat Portal, utilizando el enrutamiento CardSE a través de SiTef.

Información de Registro#

El Carat debe estar configurado para aceptar pagos para el autorizador AME a través de CardSE.

Pago REST#

flujo#

  1. El comerciante crea la transacción en Carat Portal pasando alguna información adicional de AME y recibe un NIT como respuesta.
  2. El comercio llama al servicio de efectivización de pago y recibe un código QR y una transacción con estado PEN (pendiente).
  3. El comerciante muestra el código QR al cliente.
  4. El cliente escanea el código QR con la aplicación AME y realiza los trámites de confirmación de pago solicitados por el autorizador.
  5. Mientras el cliente finaliza el pago, Carat Portal consultará la situación de venta en el autorizador hasta que finalice la transacción.
  6. El comerciante, a su vez, debe consultar el estado de la transacción en Carat Portal hasta que ya no tenga el estado PEN.

Aviso:

Si el estado permanece pendiente (PEN) después de 3 (tres) minutos, Carat Portal deshacer la transacción junto con AME.

Información adicional al crear la transacción#

Para transacciones AME, se debe usar authorizer_id = 446.

A continuación se muestran los parámetros adicionales que se pueden enviar en las transacciones AME:

ParámetroDescripciónFormatoRequerido
additional_data.items[]
eanCódigo de producto EAN.

Atención: si se envían simultáneamente EAN y SKU, solo se considerará EAN.
< 255 ANNO
skuCódigo de producto SKU.

Atención: si se envían simultáneamente EAN y SKU, solo se considerará el EAN.
< 255 ANNO
descriptionDescripción del Producto.< 30 ANNO
quantityCantidad de producto.< 15 NNO
quantity_typeTipo de cantidad:
  • u - Unidades
  • g - Gramos
  • ml - Mililitros
< 2 ANNO
unit_pricePrecio unitario del producto en centavos.< 12 norteNO

Ejemplo:

Iniciando transacción#

--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-raw '
{
"merchant_usn":"12042142155",
"order_id":"1651001767957",
"installments":"1",
"installment_type":"4",
"authorizer_id":"446",
"amount":"1000",
"additional_data": {
"items": [
{
"quantity": "1",
"quantity_type": "u",
"unit_price": "50000",
"ean": "9283746529385",
"description": "bola para jogar 1"
},
{
"quantity": "2",
"quantity_type": "u",
"unit_price": "25000",
"ean": "9283746529384",
"description": "bola para jogar 2"
}
]
}
}'

Solicitud de realización de pago#

Al utilizar AME, no será necesario enviar ningún dato de la tarjeta.

Ejemplo:

--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-raw '
{
}'

Devoluciones en la realización del Pago con diferente tamaño del estándar.#

ParámetroDescripciónFormato
authorization_numberNúmero de autorización< 100 AN

Aviso:

En caso de error de comunicación en esta operación, será necesario crear otra transacción.

Ejemplo:

"code": "0",
"message": "OK. Transaction successful.",
"payment": {
"authorizer_code": "000",
"status": "PEN",
"nit": "a479f7d0fc3e3bdfe22f489298b9ca56fa98c4c7c56e2529eb4fddb44c7a392c",
"order_id": "1651003189064",
"authorizer_id": "446",
"acquirer_id": "271",
"acquirer_name": "CardSE",
"authorizer_date": "26/04/2022T16:59",
"authorization_number": "111111111122222222223333333333444444444455555555556666666666 ",
"merchant_usn": "12042142155",
"esitef_usn": "220426096883310",
"sitef_usn": "265428",
"host_usn": "000000000 ",
"amount": "1000",
"payment_type": "O",
"authorizer_merchant_id": "084675745000140",
"terminal_id": "ES000041",
"payment_date": "26/04/2022T16:59",
"qr_code": "The quick brown fox jumps over the lazy dog"
}
}

Pago HTML#

No hay diferencias de flujo para el comerciante.

Al igual que en el Pago REST, se pueden enviar parámetros adicionales en la creación de la transacción, usando el mismo formato.

Cancelación REST#

Solicitud de cancelación efectiva#

Al utilizar AME, no será necesario enviar ningún dato de la tarjeta.

Ejemplo:

--request PUT "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/cancellations/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-raw '{
}'

Devoluciones por cancelación#

{
"code": "0",
"message": "OK. Transaction successful.",
"cancellation": {
"authorizer_code": "000",
"authorizer_message": "Lojista OK",
"status": "CON",
"nit": "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
"order_id": "1651003189064",
"customer_receipt": "=== COMPROVANTE ===",
"merchant_receipt": "=== COMPROVANTE ===",
"authorizer_id": "446",
"acquirer_id": "1271",
"acquirer_name": "CardSE",
"authorizer_date": "26/04/2022T17:12",
"authorization_number": "265429",
"merchant_usn": "12042142155",
"esitef_usn": "220426096883331",
"sitef_usn": "265429",
"host_usn": "00000000000004265429 ",
"amount": "1000",
"payment_type": "O",
"authorizer_merchant_id": "084675745000140",
"esitef_date": "26/04/2022T17:12",
"is_host_cancel": "false"
}
}

Generación de link de pago en el Portal del comerciante#

También es posible realizar pagos con AME a través de la funcionalidad de link de pago del Portal Lojista. Sin embargo, la posibilidad de enviar información adicional de AME aún no está disponible.