3D Secure Processing

openapi: 3.0.0 info: title: API regional GetNet contact: {} version: 1.0.4 description: "Bienvenido a GetNet. Esta API permite a su empresa integrarse con la API regional de GetNet y aprovechar las soluciones de pago de primer nivel. GetNet proporciona servicios seguros y eficientes para procesar transacciones de comercio electrónico, lo que permite a los comerciantes aceptar tarjetas de crédito, débito y bancarias sin problemas en sus tiendas virtuales. Además del procesamiento de pagos, GetNet ofrece servicios de conciliación seguros, recurrentes, antifraude y otras funciones diseñadas para respaldar su negocio con rapidez y seguridad.

**Descripción general (lo que encontrará en esta documentación) **
Esta sección proporciona una descripción general de las principales funcionalidades de la API regional. Abarca los métodos de autenticación, la configuración básica de las URL y los puntos finales disponibles para procesar los pagos, gestionar las suscripciones, gestionar las cuotas y realizar las operaciones con tarjetas. Además, detalla las consultas sobre transacciones, los procesos posteriores a la venta, como las cancelaciones y los reembolsos, y la autenticación 3D Secure. Utilice esta documentación para comprender la estructura y el comportamiento de cada solicitud y respuesta de la API.

__Autenticación__

Todas las transacciones se autentican mediante un token portador generado mediante el protocolo OAuth 2.0. Para obtener un token, los clientes deben enviar una solicitud al punto final de autenticación con su ID de cliente y su secreto de cliente (haga clic aquí para ver cómo generar sus credenciales). El token de acceso generado debe incluirse en el encabezado de autorización de cada solicitud de API, lo que garantiza un acceso seguro y controlado a la API.

__Usage__

Una vez obtenido el token, inclúyalo en el encabezado de autorización de las solicitudes de la API de la siguiente manera:
`Authorization: Bearer {access_token} `

__Expiración y renovación del token__
: el token es válido durante el tiempo especificado en `expires_in` (normalmente 3599 segundos o aproximadamente 1 hora).
- Cuando el token caduque, debes solicitar uno nuevo mediante el mismo proceso de autenticación.

v20250820.1600" servers: - url: https://api.pre.globalgetnet.com - url: https://api.globalgetnet.com paths: /dpm/payments-gwproxy/v2/payments: post: tags: - Payments summary: Crear - Autorizar description: "__Crear transacción de pago__

El punto final de creación de pago permite a los comerciantes iniciar una transacción de pago con tarjetas de crédito o débito. Esta solicitud procesa la transacción y devuelve una respuesta que indica su estado.

**Escenarios de uso: **
_- Cobrar a los clientes por las compras en línea o en tiendas físicas.
- Se admiten los pagos en cuotas cuando corresponda.
- Garantizar un procesamiento de pagos seguro y sin problemas. _

**Notas: **
_- Algunas transacciones pueden requerir pasos adicionales, como la **autenticación** o la **tokenización**.
- Debe incluirse una **clave de idempotencia** para evitar transacciones duplicadas.
- Valide siempre la respuesta de pago para confirmar que la transacción se procesó correctamente.
- Para especificar el tipo de transacción, debes evitar el tipo que aparece en el campo **data.payment.payment_method**. Los valores posibles son _ CREDIT, DEBIT, CREDIT_AUTHORIZATION y CREDIT_PRE_AUTHORIZATION.
_- **Para transacciones en Uruguay (UY) :** **IVA: ** Básico 22%, Mínimo 10%, Exento
0%.
**Legislación: ** Las siguientes leyes **no** se aplican a estas transacciones: la Ley 19.210, la Ley 17.934 y la Ley 18.999. _
" operationId: payment_2 parameters: - $ref: "#/components/parameters/XTransactionChannelEntry" requestBody: content: application/json: schema: $ref: "#/components/schemas/PaymentDTO" required: true responses: "200": description: Transacción ejecutada correctamente. content: application/json: schema: $ref: "#/components/schemas/AutorizationResponseDTO" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "401": description: autenticación no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: Module or service that returned the error status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: No autorizado description_detail: Invalid client credentials "403": description: El producto no está activado content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Forbidden name: Module or service that returned the error status_code: 403 details: - status: DENIED error_code: CONFIG-403 description: Prohibido description_detail: Product not enabled "404": description: No se ha encontrado content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: Module or service that returned the error status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: No se ha encontrado description_detail: card_id Not Found "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Unprocessable Entity name: Module or service that returned the error status_code: 422 details: - status: DENIED error_code: Error code description: Entidad no procesable description_detail: Detailed error description "429": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 429 details: - status: DENIED error_code: Error code description: Demasiadas solicitudes description_detail: Detailed error description "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. "503": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Service Unavailable name: Module or service that returned the error status_code: 503 details: - status: ERROR error_code: GENERIC-503 description: Servicio no disponible description_detail: The server encountered an unexpected error. "504": description: Tiempo de espera de puerta de enlace content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Gateway Timeout name: Module or service that returned the error status_code: 504 details: - status: ERROR error_code: GENERIC-504 description: Tiempo de espera de puerta de enlace description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api patch: tags: - Payments summary: Ajuste description: "__Actualizar una transacción de pago__

Este punto final le permite actualizar una transacción de pago existente. Se usa para modificar atributos específicos de una transacción, como actualizar los metadatos, corregir la información o ajustar los detalles del pago antes de la liquidación final.

**Escenarios de uso: **
_- Actualización de los detalles de la transacción antes de procesarla.
- Corregir la información relacionada con los pagos.
- Añadir o modificar los metadatos relacionados con la transacción. _

**Notas: **
_- Solo se pueden actualizar algunos campos. Asegúrese de revisar los parámetros de la solicitud para verificar qué modificaciones están permitidas.
- Algunas actualizaciones pueden requerir una validación o aprobación adicional. _" operationId: adjustment_2 parameters: - $ref: "#/components/parameters/XTransactionChannelEntry" requestBody: content: application/json: schema: $ref: "#/components/schemas/AdjustmentDTO" required: true responses: "200": description: Transacción ejecutada correctamente. content: application/json: schema: $ref: "#/components/schemas/AutorizationResponseDTO" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "401": description: autenticación no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: Module or service that returned the error status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: No autorizado description_detail: Invalid client credentials "403": description: El producto no está activado content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Forbidden name: Module or service that returned the error status_code: 403 details: - status: DENIED error_code: CONFIG-403 description: Prohibido description_detail: Product not enabled "404": description: No se ha encontrado content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: Module or service that returned the error status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: No se ha encontrado description_detail: card_id Not Found "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Unprocessable Entity name: Module or service that returned the error status_code: 422 details: - status: DENIED error_code: Error code description: Entidad no procesable description_detail: Detailed error description "429": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 429 details: - status: DENIED error_code: Error code description: Demasiadas solicitudes description_detail: Detailed error description "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. "503": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Service Unavailable name: Module or service that returned the error status_code: 503 details: - status: ERROR error_code: GENERIC-503 description: Servicio no disponible description_detail: The server encountered an unexpected error. "504": description: Tiempo de espera de puerta de enlace content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Gateway Timeout name: Module or service that returned the error status_code: 504 details: - status: ERROR error_code: GENERIC-504 description: Tiempo de espera de puerta de enlace description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api /dpm/payments-gwproxy/v2/payments/capture: post: tags: - Payments summary: Capturar description: "__Capturar un pago autorizado__

El punto final de Capture se utiliza para finalizar un pago autorizado y garantizar que el importe de la transacción se deduzca de la cuenta del cliente y se liquide a nombre del comerciante.

**Escenarios de uso: **
_- Completar un pago después de una autorización exitosa.
- Dividir la autorización y la captura en pasos separados para controlar mejor el procesamiento de las transacciones.
- Reducir la cantidad capturada si es necesario antes de la liquidación final (si se admite la captura parcial). _

**Notas: **
_- El pago debe estar **previamente autorizado** antes de la captura.
- Algunas actualizaciones pueden requerir una validación o aprobación adicional.
- Si la transacción no se captura dentro del plazo permitido, la autorización puede caducar y requerir una nueva transacción. _" operationId: capture_4 requestBody: content: application/json: schema: $ref: "#/components/schemas/requestCapture" required: true responses: "200": description: Transacción ejecutada correctamente. content: application/json: schema: $ref: "#/components/schemas/paymentCaptureResponse" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "401": description: autenticación no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: Module or service that returned the error status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: No autorizado description_detail: Invalid client credentials "404": description: No se ha encontrado content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: Module or service that returned the error status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: No se ha encontrado description_detail: card_id Not Found "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Unprocessable Entity name: Module or service that returned the error status_code: 422 details: - status: DENIED error_code: Error code description: Entidad no procesable description_detail: Detailed error description "429": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 429 details: - status: DENIED error_code: Error code description: Demasiadas solicitudes description_detail: Detailed error description "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. "503": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Service Unavailable name: Module or service that returned the error status_code: 503 details: - status: ERROR error_code: GENERIC-503 description: Servicio no disponible description_detail: The server encountered an unexpected error. "504": description: Tiempo de espera de puerta de enlace content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Gateway Timeout name: Module or service that returned the error status_code: 504 details: - status: ERROR error_code: GENERIC-504 description: Tiempo de espera de puerta de enlace description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api /dpm/payments-gwproxy/v2/payments/qrcode: post: tags: - Payments summary: Código QR description: "__Capturar un pago autorizado__

El punto final de Capture se utiliza para finalizar un pago autorizado y garantizar que el importe de la transacción se deduzca de la cuenta del cliente y se liquide a nombre del comerciante.

**Escenarios de uso: **
_- Completar un pago después de una autorización exitosa.
- Dividir la autorización y la captura en pasos separados para controlar mejor el procesamiento de las transacciones.
- Reducir la cantidad capturada si es necesario antes de la liquidación final (si se admite la captura parcial). _

**Notas: **
_- El pago debe estar **previamente autorizado** antes de la captura.
- Algunas actualizaciones pueden requerir una validación o aprobación adicional.
- Si la transacción no se captura dentro del plazo permitido, la autorización puede caducar y requerir una nueva transacción. _" operationId: createQRCode requestBody: content: application/json: schema: $ref: "#/components/schemas/requestQRCode" required: true responses: "201": description: Código QR creado. content: application/json: schema: $ref: "#/components/schemas/responseQRCode" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "401": description: autenticación no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: Module or service that returned the error status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: No autorizado description_detail: Invalid client credentials "404": description: No se ha encontrado content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: Module or service that returned the error status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: No se ha encontrado description_detail: card_id Not Found "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Unprocessable Entity name: Module or service that returned the error status_code: 422 details: - status: DENIED error_code: Error code description: Entidad no procesable description_detail: Detailed error description "429": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 429 details: - status: DENIED error_code: Error code description: Demasiadas solicitudes description_detail: Detailed error description "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. "503": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Service Unavailable name: Module or service that returned the error status_code: 503 details: - status: ERROR error_code: GENERIC-503 description: Servicio no disponible description_detail: The server encountered an unexpected error. "504": description: Tiempo de espera de puerta de enlace content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Gateway Timeout name: Module or service that returned the error status_code: 504 details: - status: ERROR error_code: GENERIC-504 description: Tiempo de espera de puerta de enlace description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api /dpm/payments-gwproxy/v2/payments/cancel: post: tags: - Payments summary: Cancelar description: "__Cancelar un pago capturado__

El punto final de cancelación permite a los comerciantes anular un pago capturado anteriormente, lo que garantiza que el importe de la transacción se reembolse al cliente.

**Escenarios de uso: **
_- Anular un pago que se capturó por error.
- Gestionar las cancelaciones de pedidos que requieren un reembolso completo. _

**Notas: **
_- Solo se pueden cancelar los pagos **capturados**.
- El proceso de cancelación puede variar según el método de pago y el emisor.
- Algunas transacciones pueden requerir un tiempo de procesamiento adicional antes de que los fondos se devuelvan al cliente. _" operationId: cancel_7 requestBody: content: application/json: schema: $ref: "#/components/schemas/CancelDTO" required: true responses: "200": description: Transacción ejecutada correctamente. content: application/json: schema: $ref: "#/components/schemas/CancelResponseDTO" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "401": description: autenticación no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: Module or service that returned the error status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: No autorizado description_detail: Invalid client credentials "404": description: No se ha encontrado content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: Module or service that returned the error status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: No se ha encontrado description_detail: card_id Not Found "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Unprocessable Entity name: Module or service that returned the error status_code: 422 details: - status: DENIED error_code: Error code description: Entidad no procesable description_detail: Detailed error description "429": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 429 details: - status: DENIED error_code: Error code description: Demasiadas solicitudes description_detail: Detailed error description "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. "503": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Service Unavailable name: Module or service that returned the error status_code: 503 details: - status: ERROR error_code: GENERIC-503 description: Servicio no disponible description_detail: The server encountered an unexpected error. "504": description: Tiempo de espera de puerta de enlace content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Gateway Timeout name: Module or service that returned the error status_code: 504 details: - status: ERROR error_code: GENERIC-504 description: Tiempo de espera de puerta de enlace description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api /dpm/payments-gwproxy/v2/payments/boleto: post: summary: Crear una factura/boleto description: "__Generar pagos con Boleto__

El punto final de Boleto permite a los comerciantes generar un comprobante bancario (boleto) para que los clientes completen los pagos a través de canales bancarios, cajeros automáticos o ubicaciones autorizadas.

**Escenarios de uso: **
_- Ofrece un método de pago alternativo para los clientes sin tarjetas de crédito o débito.
- Permitir transacciones en efectivo con una fecha de vencimiento para el pago. _

**Notas: **
_- El boleto debe incluir una fecha de vencimiento, después de la cual el pago deja de ser válido.
- Una vez generado, el boleto no se puede modificar; se debe emitir uno nuevo si es necesario hacer cambios.
- Los tiempos de confirmación del pago varían según las políticas de procesamiento del banco. _" tags: - Payments operationId: paymentBoleto_1 requestBody: content: application/json: schema: $ref: "#/components/schemas/PaymentBoletoDTO" required: true responses: "201": description: Creado content: application/json: schema: $ref: "#/components/schemas/AutorizationResponseDTO" "400": description: Solicitud incorrecta content: "*/*": schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "404": description: No se ha encontrado content: "*/*": schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno del servidor content: "*/*": schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api /dpm/payments-gwproxy/v2/payments/qrcode/pix: post: tags: - Payments summary: Crear PIX description: "__Generar pago con PIX__

En este punto final, los datos de pago se procesan para generar un **código QR PIX** para la transacción. Una vez creado el código QR, la confirmación del pago se enviará al comerciante mediante una notificación HTTP. Para obtener más información, consulta la sección ** «Notificaciones PIX» ** en la sección **Notificaciones 1.1** de este documento.

**Escenarios de uso: **
_- Habilitar los pagos instantáneos con confirmación inmediata.
- Proporciona una alternativa rápida y segura a las transferencias bancarias o boletos tradicionales.
- Apoyamos a las empresas minoristas y de comercio electrónico con una disponibilidad de pago ininterrumpida. _

**Notas: **
_- Las transacciones PIX se procesan en tiempo real y no se pueden anular una vez completadas.
- Se requiere una **clave PIX única (código QR o ID de transacción) ** para el pago. _" operationId: pix parameters: - $ref: "#/components/parameters/XQrCodeExpirationTime" requestBody: content: application/json: schema: $ref: "#/components/schemas/PixDTO" required: true responses: "200": description: Código QR generado correctamente y pendiente de pago. content: application/json: schema: type: object additionalProperties: type: object "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "401": description: autenticación no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: Module or service that returned the error status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: No autorizado description_detail: Invalid client credentials "404": description: No se ha encontrado content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: Module or service that returned the error status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: No se ha encontrado description_detail: card_id Not Found "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api /dpm/security-gwproxy/v2/enrolments-initial: post: tags: - Payments operationId: initial description: "__Descripción general de la autenticación en 3D Secure (3DS) __

3D Secure es un protocolo de autenticación diseñado para mejorar la seguridad de las transacciones en línea al verificar la identidad de los titulares de las tarjetas antes de procesar un pago. Reduce el fraude y brinda protección de responsabilidad a los comerciantes y emisores.

**Notas: **
_Hay dos versiones principales del protocolo:
- **3DS 1.0.2 -** La versión original, que redirige a los clientes al sitio web del emisor de la tarjeta para autenticarse.
- **3DS 2.x —** La versión mejorada, que ofrece una experiencia fluida al utilizar la autenticación basada en el riesgo y solo requiere pasos adicionales cuando es necesario. _

Este enfoque estructurado garantiza la gestión adecuada de los flujos de la 3DS 1.0.2 y la 3DS 2.x, guiando al cliente a lo largo de los pasos necesarios y validando su estado de autenticación.

**Inicia el flujo de inscripción para la autenticación de la 3DS**

Este terminal inicia el proceso de autenticación de la 3DS para una transacción de pago.

Siga los pasos que se indican a continuación para autenticar correctamente al titular de la tarjeta: **1. Inicie el proceso de inscripción: ** Llame al punto final para iniciar el proceso.
**2. Determine la versión del protocolo 3DS: ** La respuesta de la llamada de inscripción inicial indica la versión del protocolo 3DS en uso.

**Si el protocolo es la 3DS 1.0.2: ** **
- Redirigir: ** Redirigir al cliente a la página de autenticación del emisor de la tarjeta mediante la URL proporcionada en la respuesta.
**- Validar: ** Una vez que el cliente se haya autenticado con el emisor de su tarjeta, llame a la operación **POST _/validations_** y, en la solicitud, proporcione la respuesta de autenticación del pagador que ha recibido para comprobar si el cliente se ha autenticado correctamente.

**Si el protocolo es 3DS 2.x: **
**- Continuar con la inscripción: ** Llame a la operación **POST _/enrolments-continue_** para generar la carga útil necesaria para que el cliente se autentique con el emisor de la tarjeta. Si el emisor de la tarjeta no necesita autenticar al cliente, la respuesta contiene el objeto **EnrollmentContinueFrictionLessResponse**, lo que significa que el estado de autenticación se encuentra en la respuesta y no es necesario realizar ninguna otra acción. Si el emisor de la tarjeta necesita autenticar al cliente, la respuesta contiene el objeto **EnrollmentContinueChallengeResponse** y debes continuar con los pasos siguientes.
**- Redirigir: ** Redirige al cliente mediante la URL de redireccionamiento incluida en la respuesta a la operación **POST _/enrolments-initial_** para llevar al cliente a la página del emisor de la tarjeta para su autenticación.
**- Validar: ** Una vez que el cliente se haya autenticado con el emisor de su tarjeta, llama a la operación **POST _/validations_** y, en la solicitud, proporciona la respuesta de autenticación del pagador que recibiste para verificar si el cliente se ha autenticado correctamente." summary: 3DS - Autenticación de inicio requestBody: content: application/json: schema: $ref: "#/components/schemas/EnrolmentsInitialDTO" required: true responses: "200": description: BIEN content: application/json: schema: $ref: "#/components/schemas/InitialResponseDTO" "400": description: Solicitud incorrecta content: "*/*": schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno del servidor content: "*/*": schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" /dpm/security-gwproxy/v2/enrolments-continue: post: tags: - Payments operationId: enrolmentsContinue summary: "3DS: Carga útil de autenticación de inicio de sesión bancario" description: Este punto final genera la carga útil necesaria para que el cliente se autentique con su inicio de sesión bancario. La respuesta incluye los detalles de autenticación requeridos, que se pueden usar para continuar con la transacción de forma segura. requestBody: content: application/json: schema: $ref: "#/components/schemas/EnrolmentsContinueDTO" required: true responses: "200": description: BIEN content: application/json: schema: $ref: "#/components/schemas/ContinueResponseDTO" "400": description: Solicitud incorrecta content: "*/*": schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno del servidor content: "*/*": schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" /dpm/security-gwproxy/v2/validations: post: tags: - Payments operationId: validations summary: 3DS - Validar la autenticación description: Este punto final valida una autenticación 3DS al verificar la respuesta de autenticación del pagador recibida del emisor de la tarjeta. Confirma si el cliente se ha autenticado correctamente, lo que permite que la transacción se lleve a cabo de forma segura. requestBody: content: application/json: schema: $ref: "#/components/schemas/ValidationsDTO" required: true responses: "200": description: BIEN content: application/json: schema: $ref: "#/components/schemas/ValidationsResponseDTO" "400": description: Solicitud incorrecta content: "*/*": schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno del servidor content: "*/*": schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" /dpm/hub-payment-info/v1/payments/info/{payment_id}: get: summary: Obtener transacción tags: - Payment Record Management operationId: get-v1-payments description: __Recuperar los detalles de la transacción con un identificador de transacción único__

El punto final de la consulta de transacciones le permite recuperar los detalles de una transacción específica mediante su identificador único. Esto es útil para verificar el estado de las transacciones, obtener los detalles del pago y rastrear las transacciones procesadas. responses: "200": description: BIEN content: application/json: schema: type: object properties: payment_id: $ref: "#/components/schemas/payment_id" order_id: $ref: "#/components/schemas/order_id" status: $ref: "#/components/schemas/status" payment: $ref: "#/components/schemas/payment" records: type: array items: $ref: "#/components/schemas/record" "404": description: No se ha encontrado content: application/json: schema: $ref: "#/components/schemas/notFound" "500": description: Error interno del servidor content: application/json: schema: $ref: "#/components/schemas/internalServerError" security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api parameters: - schema: type: string format: uuid example: 8719d0c4-2c3f-4360-abd9-8daf3834fe1f minLength: 36 maxLength: 36 in: path name: payment_id description: Identificador de pago. required: true /dpm/hub-payment-info/v1/payments/info/{payment_id}/{idempotency_key}: parameters: - $ref: "#/components/parameters/IdempotencyKeyPath" - $ref: "#/components/parameters/PaymentId" get: summary: Lograr superar la clave idempotente description: "__Recuperación de datos de transacciones mediante claves de idempotencia__

Este punto final permite consultar los componentes de la transacción vinculados a un pago específico mediante una **clave de idempotencia**. El mecanismo de idempotencia garantiza que las solicitudes repetidas con la misma clave siempre devuelvan la misma respuesta, lo que evita la creación de transacciones duplicadas.

**Notas: **
_- El uso de una clave de idempotencia garantiza que las consultas repetidas siempre devuelvan los mismos detalles de la transacción sin generar operaciones duplicadas.
- Este punto final es particularmente útil para recuperar los estados de las transacciones o confirmar las operaciones de pago ejecutadas anteriormente. _" tags: - Payment Record Management responses: "200": description: BIEN content: application/json: schema: type: object properties: rel: $ref: "#/components/schemas/rel" idempotency_key: $ref: "#/components/schemas/idempotency_key" registered_at: $ref: "#/components/schemas/registered_at" items: type: array items: type: object properties: registered_at: $ref: "#/components/schemas/registered_at" type: type: string enum: - request - response - result description: Tipo de registro. example: request content: description: Contenidos del registro. oneOf: - $ref: "#/components/schemas/paymentAuthorizationResponse" - $ref: "#/components/schemas/paymentCancelResponse" - $ref: "#/components/schemas/paymentCaptureResponse" - $ref: "#/components/schemas/paymentPurchaseResponse" - $ref: "#/components/schemas/requestPayment" - $ref: "#/components/schemas/requestCapture" - $ref: "#/components/schemas/requestCancel" - $ref: "#/components/schemas/cancelResult" "404": description: No se ha encontrado content: application/json: schema: $ref: "#/components/schemas/notFound" "500": description: Error interno del servidor content: application/json: schema: $ref: "#/components/schemas/internalServerError" security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api operationId: get-v1-payment-info-payment_id-component_id /dpm/payments-gwproxy/v2/payments/combined: post: tags: - Combined Payments summary: Autorizar description: "__Dividir una transacción entre varias tarjetas__

Este punto final le permite autorizar un pago combinado con varias tarjetas. Por lo general, se usa cuando un comprador desea dividir el importe total entre dos o más métodos de pago.

**Escenarios de uso: **
_- Ofrecer flexibilidad al cliente en cuanto a las opciones de pago.
- Gestión de transacciones divididas para mercados o plataformas. _

**Notas: **
_- **Solo se permiten pagos con tarjeta.** Los APM como PIX y Boleto **no son compatibles**.
- Este flujo es válido **solo para situaciones en las que la tarjeta no está presente** (comercio electrónico).
- El campo_ `combined_id` _ de la respuesta se usa para **realizar un seguimiento de la transacción** en general.
- Cada tarjeta debe estar representada como un objeto dentro de la matriz de pagos. _" operationId: combined_ parameters: - $ref: "#/components/parameters/XTransactionChannelEntry" requestBody: content: application/json: schema: $ref: "#/components/schemas/CombinedPaymentDTO" required: true responses: "200": description: Transacción ejecutada correctamente. content: application/json: schema: $ref: "#/components/schemas/CombinedResponseDTOCombinedAutorizationResponseData\ DTO" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "401": description: autenticación no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: Module or service that returned the error status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: No autorizado description_detail: Invalid client credentials "403": description: El producto no está activado content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Forbidden name: Module or service that returned the error status_code: 403 details: - status: DENIED error_code: CONFIG-403 description: Prohibido description_detail: Product not enabled "404": description: No se ha encontrado content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: Module or service that returned the error status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: No se ha encontrado description_detail: card_id Not Found "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Unprocessable Entity name: Module or service that returned the error status_code: 422 details: - status: DENIED error_code: Error code description: Entidad no procesable description_detail: Detailed error description "429": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 429 details: - status: DENIED error_code: Error code description: Demasiadas solicitudes description_detail: Detailed error description "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. "503": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Service Unavailable name: Module or service that returned the error status_code: 503 details: - status: ERROR error_code: GENERIC-503 description: Servicio no disponible description_detail: The server encountered an unexpected error. "504": description: Tiempo de espera de puerta de enlace content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Gateway Timeout name: Module or service that returned the error status_code: 504 details: - status: ERROR error_code: GENERIC-504 description: Tiempo de espera de puerta de enlace description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api /dpm/payments-gwproxy/v2/payments/combined/capture: post: tags: - Combined Payments summary: Capturar description: "__Capturar pagos combinados__

Este punto final le permite **capturar un pago combinado previamente autorizado**. Se usa para finalizar una transacción que se autorizó inicialmente con más de una tarjeta.

**Escenarios de uso: **
_- Completar un pago combinado después de completar el pedido.
- Capturar los fondos autorizados divididos entre varias tarjetas.
- Lógica de captura posterior a la autorización para mercados o plataformas. _

**Notas: **
_- El pago combinado debe haber sido **autorizado previamente** utilizando el punto final de autorización del pago combinado.
- Todos los componentes del pago deben estar incluidos en la matriz de pagos para que la captura sea válida.
- El importe de captura debe coincidir con el importe autorizado para cada método de pago.
- Se pueden enviar datos adicionales a través del campo `additional_data` para casos de uso personalizados o integraciones. _" operationId: capture parameters: - $ref: "#/components/parameters/XTransactionChannelEntry" requestBody: content: application/json: schema: $ref: "#/components/schemas/CombinedOperationsRequestDTOCombinedCapturetDataDTO" required: true responses: "200": description: Transacción ejecutada correctamente. content: application/json: schema: $ref: "#/components/schemas/CombinedResponseDTOCaptureResponseDTO" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "401": description: autenticación no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: Module or service that returned the error status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: No autorizado description_detail: Invalid client credentials "404": description: No se ha encontrado content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: Module or service that returned the error status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: No se ha encontrado description_detail: card_id Not Found "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Unprocessable Entity name: Module or service that returned the error status_code: 422 details: - status: DENIED error_code: Error code description: Entidad no procesable description_detail: Detailed error description "429": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 429 details: - status: DENIED error_code: Error code description: Demasiadas solicitudes description_detail: Detailed error description "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. "503": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Service Unavailable name: Module or service that returned the error status_code: 503 details: - status: ERROR error_code: GENERIC-503 description: Servicio no disponible description_detail: The server encountered an unexpected error. "504": description: Tiempo de espera de puerta de enlace content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Gateway Timeout name: Module or service that returned the error status_code: 504 details: - status: ERROR error_code: GENERIC-504 description: Tiempo de espera de puerta de enlace description_detail: The server encountered an unexpected error. /dpm/payments-gwproxy/v2/payments/combined/cancel: post: tags: - Combined Payments summary: Cancelar description: "__Cancelar pago combinado__

Este punto final le permite cancelar un pago combinado previamente autorizado. Por lo general, se usa cuando se debe anular todo el pago (realizado con más de una tarjeta) antes de capturarlo.

**Escenarios de uso: **
_- Anulación total de una autorización combinada debido a una solicitud del usuario o a un error.
- Rechazo del pago durante la fase de análisis o validación del fraude. _

**Notas: **
_- Solo se pueden cancelar los pagos autorizados, pero no los capturados.
- Todos los componentes de pago incluidos en la autorización combinada deben figurar en la matriz de pagos.
- Debe usarse un `request_id` único para garantizar la idempotencia de la cancelación.
- La cancelación puede no ser reversible en función de las normas del adquirente o emisor. _" operationId: cancel parameters: - $ref: "#/components/parameters/XTransactionChannelEntry" requestBody: content: application/json: schema: $ref: "#/components/schemas/CombinedOperationsRequestDTOCombinedCancelDataDTO" required: true responses: "200": description: Transacción ejecutada con éxito. content: application/json: schema: $ref: "#/components/schemas/CombinedResponseDTOCancelResponseDTO" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "401": description: autenticación no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: Module or service that returned the error status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: No autorizado description_detail: Invalid client credentials "404": description: No se ha encontrado content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: Module or service that returned the error status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: No se ha encontrado description_detail: card_id Not Found "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Unprocessable Entity name: Module or service that returned the error status_code: 422 details: - status: DENIED error_code: Error code description: Entidad no procesable description_detail: Detailed error description "429": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 429 details: - status: DENIED error_code: Error code description: Demasiadas solicitudes description_detail: Detailed error description "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. "503": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Service Unavailable name: Module or service that returned the error status_code: 503 details: - status: ERROR error_code: GENERIC-503 description: Servicio no disponible description_detail: The server encountered an unexpected error. "504": description: Tiempo de espera de puerta de enlace content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Gateway Timeout name: Module or service that returned the error status_code: 504 details: - status: ERROR error_code: GENERIC-504 description: Tiempo de espera de puerta de enlace description_detail: The server encountered an unexpected error. /dpm/payments-gwproxy/v1/crossborder/quote: post: tags: - Crossborder summary: Obtenga una cotización transfronteriza description: Recupere una cotización transfronteriza. operationId: getCrossborderQuote parameters: - name: category in: query description: Indica la categoría de citas. Establezca el valor DCC para la conversión dinámica de divisas. required: false schema: type: string - name: expense_type in: query description: ... required: false schema: type: string - name: payment_type in: query description: ... required: false schema: type: string - name: bin in: query description: Necesario para DCC. required: false schema: type: string - name: seller_code in: query description: Necesario para DCC. required: false schema: type: string - name: amount in: query description: Necesario para DCC. required: false schema: type: number - name: currency in: query description: Necesario para DCC. required: false schema: type: string responses: "201": description: Creado content: application/json: schema: $ref: "#/components/schemas/CrossborderQuoteResponseDTO" "400": description: Solicitud incorrecta content: "*/*": schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "404": description: No se ha encontrado content: "*/*": schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno del servidor content: "*/*": schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" /dpm/payments-gwproxy/v2/crossborder/validate-customer: post: summary: Validar cliente tags: - Crossborder description: Envía un nuevo cliente para la validación de la documentación. Si el document_number ya se ha enviado, el punto final recuperará el registro del cliente con su estado actualizado. Cuando se complete el análisis del cliente, enviaremos un webhook con el mismo formato de respuesta que el caso «200» a la URL registrada por el vendedor en el momento de la inscripción. operationId: validate_fx parameters: - $ref: "#/components/parameters/XTransactionChannelEntry" requestBody: content: application/json: schema: $ref: "#/components/schemas/ValidateCustomerDTO" required: true responses: "200": description: Transacción ejecutada correctamente. content: application/json: schema: $ref: "#/components/schemas/ValidateCustomerResponseDTO" "400": description: Solicitud incorrecta content: "*/*": schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "404": description: No se ha encontrado content: "*/*": schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno del servidor content: "*/*": schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" /dpm/payments-gwproxy/v2/payments/quotes: post: tags: - Installments summary: Obtenga cuotas description: "__Solicitar cotizaciones a plazos__

Este punto final le permite recuperar una lista de las cotizaciones de cuotas disponibles para la tarjeta de pago de un cliente. Cada cotización incluye las tasas de interés e impuestos finales, que se pueden utilizar si el comerciante no ha negociado previamente las tasas con el emisor.

**Escenarios de uso: **
_- Mostrar las opciones de pago a plazos a los usuarios durante el proceso de compra.
- Calcular los montos totales de pago con los intereses incluidos.
- Preparar una solicitud de compra que implique pagos a plazos. _

**Notas: **
_- Esta operación solo está disponible para comerciantes ubicados en **Argentina** y **Chile**.
-El identificador de la cotización en cuotas devuelto por esta operación es obligatorio en las operaciones de pago posteriores.
-Esta solicitud debe incluir el **BIN** (los primeros nueve dígitos) y el `number_token` de la tarjeta." operationId: getCuotesApi requestBody: content: application/json: schema: $ref: "#/components/schemas/InstallmentQuotesRequestDTO" required: true responses: "201": description: Creado content: application/json: schema: $ref: "#/components/schemas/InstallmentQuotesResponseDTO" examples: AR: $ref: "#/components/examples/InstallmentQuotesResponseAR" CL: $ref: "#/components/examples/InstallmentQuotesResponseCL" UY: $ref: "#/components/examples/InstallmentQuotesResponseUY" "400": description: Solicitud incorrecta content: "*/*": schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "404": description: No se ha encontrado content: "*/*": schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno del servidor content: "*/*": schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" /dpm/cofre-gw-proxy/v1/tokens/card: post: tags: - Cards summary: Generar token description: "__Generar el token de la tarjeta__

Este punto final permite la tokenización segura de los datos de la tarjeta, un paso necesario para realizar transacciones sin exponer los detalles confidenciales de la tarjeta. La tokenización reemplaza el número real de la tarjeta por un token, lo que garantiza el cumplimiento de la normativa PCI y la seguridad de las transacciones.

**Escenarios de uso: **
_- Generar un token para un almacenamiento seguro y pagos futuros.
- Preparar una tarjeta para transacciones únicas o recurrentes.
- Evitar la necesidad de manipular números de tarjetas sin procesar en su sistema. _

**Notas: **
_- No se requiere el CVV para generar el token.
- La tokenización es obligatoria antes de usar la tarjeta para cualquier transacción.
- El emisor debe verificar la tarjeta para completar este proceso. _" operationId: createToken parameters: - $ref: "#/components/parameters/XTraceID" requestBody: content: application/json: schema: $ref: "#/components/schemas/TokensCardRequest" required: true responses: "200": description: La verificación de la tarjeta se realizó correctamente. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/VerificationCardResponse" "400": description: Solicitud no válida. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: GatewayVerifyCardServiceError status_code: 400 details: - status: DENIED error_code: TOKENIZATION-400 description: Solicitud incorrecta description_detail: "card_number lenght should be between 13 and 19. Current length: 4" "401": description: Autenticación no válida. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: GatewayAuthenticationOAuth2ServiceError status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: No autorizado description_detail: Invalid client credentials "403": description: El producto seguro no está activado. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Forbidden name: GatewayParametersServiceError status_code: 403 details: - status: DENIED error_code: CONFIG-403 description: Prohibido description_detail: Product not enabled "404": description: No se ha encontrado. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: GatewayVerifyCardServiceError status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: No se ha encontrado description_detail: card_id Not Found "500": description: Error interno de servidor o servicio. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: GatewayRouterHTTPServicesError status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api /v2/cards/binlookup/{bin}: get: tags: - Cards summary: Búsqueda de BIN description: "__Búsqueda de BIN__

Este punto final recupera información detallada sobre un BIN (número de identificación bancaria) específico, incluida la marca, el país de emisión, el emisor y el tipo de producto. Se usa para identificar y clasificar las tarjetas de crédito o débito antes de procesarlas.

**Escenarios de uso: **
_- Identificar la marca o la red de una tarjeta mediante su BIN.
- Determinar el país emisor o la institución financiera.
- Clasificar el tipo de tarjeta (crédito, débito, prepago, etc.).
- Mejorar la prevención y el análisis del fraude mediante la comprensión del origen de la tarjeta. _

**Notas: **
_- Requiere el parámetro bin en la ruta, normalmente los primeros 9 dígitos del número de una tarjeta.
- Es útil para la validación, el enriquecimiento y la lógica de enrutamiento de tarjetas. _" operationId: consultaBinUsingGET parameters: - name: bin in: path description: basura required: true schema: type: string responses: "200": description: Solicitud ejecutada correctamente content: "*/*": schema: $ref: "#/components/schemas/consultaBinResponse" "401": description: Autenticación no válida. Compruebe sus credenciales o póngase en contacto con el Centro de Relaciones de Getnet. content: "*/*": schema: $ref: "#/components/schemas/ErrorDetail" "404": description: No se ha encontrado content: "*/*": schema: $ref: "#/components/schemas/ErrorDetail" "500": description: Error interno del servidor. Vuelva a intentarlo más tarde. content: "*/*": schema: $ref: "#/components/schemas/ErrorDetail" security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api deprecated: false /dpm/cofre-gw-proxy/v1/cards: get: tags: - Cards summary: Obtenga tarjetas por ID de cliente description: "__Obtenga las tarjetas guardadas del cliente__

Devuelve una lista de las tarjetas almacenadas anteriormente en la bóveda de Getnet, basada en el `customer_id` del comprador. Útil para mostrar las tarjetas guardadas para reutilizarlas o administrarlas.

**Escenarios de uso: **
_- Recupera los métodos de pago almacenados de un usuario.
- Rellene previamente la información de la tarjeta al finalizar la compra para los clientes habituales.
- Muestra las tarjetas guardadas en las interfaces de administración de cuentas. _" operationId: getCardList parameters: - $ref: "#/components/parameters/XTraceID" - $ref: "#/components/parameters/CustomerID" - $ref: "#/components/parameters/Status" responses: "200": description: Lista de tarjetas guardadas. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/ListCardDataResponse" "400": description: Solicitud no válida. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: GatewayVerifyCardServiceError status_code: 400 details: - status: DENIED error_code: TOKENIZATION-400 description: Solicitud incorrecta description_detail: "card_number lenght should be between 13 and 19. Current length: 4" "401": description: Autenticación no válida. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: GatewayAuthenticationOAuth2ServiceError status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: No autorizado description_detail: Invalid client credentials "403": description: El producto seguro no está activado. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Forbidden name: GatewayParametersServiceError status_code: 403 details: - status: DENIED error_code: CONFIG-403 description: Prohibido description_detail: Product not enabled "404": description: No se ha encontrado. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: GatewayVerifyCardServiceError status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: No se ha encontrado description_detail: card_id Not Found "500": description: Error interno de servidor o servicio. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: GatewayRouterHTTPServicesError status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api post: tags: - Cards summary: Almacena la tarjeta en Vault description: "__Almacene la tarjeta en el bóvedo__

Este terminal almacena de forma segura la información de la tarjeta de un consumidor en la bóveda digital de Getnet para usarla en el futuro. Permite crear un recurso de tarjetas reutilizable basado en datos previamente tokenizados, lo que permite realizar transacciones seguras y sin problemas sin tener que volver a necesitar los detalles de la tarjeta.

**Escenarios de uso: **
_- Tokenizar y guardar los datos de la tarjeta para futuros pagos.
- Habilitar las suscripciones o los ciclos de facturación sin tener que volver a introducir la información de la tarjeta.
- Minimizar el alcance de la PCI al aprovechar el almacenamiento seguro de datos confidenciales. _

**Notas: **
_- Esta operación requiere un número de tarjeta tokenizado previamente generado _ (`number_token`) _, que normalmente se obtiene mediante el punto final _ **/v1/tokens/card** _.
-Los datos de la tarjeta se almacenan de forma segura y los campos confidenciales, como el CVV, **nunca se almacenan**.
- Si lo desea, puede omitir la verificación de la tarjeta utilizando el encabezado_ `x-by-pass-parameters` _. _" operationId: saveCard parameters: - $ref: "#/components/parameters/XTraceID" - $ref: "#/components/parameters/XByPassParameters" requestBody: content: application/json: schema: $ref: "#/components/schemas/SaveCardDataRequest" required: true responses: "201": description: El identificador de tarjeta se creó correctamente. Tarjeta guardada en la caja fuerte. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/SaveCardDataResponse" "400": description: Solicitud no válida. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: GatewayVerifyCardServiceError status_code: 400 details: - status: DENIED error_code: TOKENIZATION-400 description: Solicitud incorrecta description_detail: "card_number lenght should be between 13 and 19. Current length: 4" "401": description: Autenticación no válida. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: GatewayAuthenticationOAuth2ServiceError status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: No autorizado description_detail: Invalid client credentials "403": description: El producto seguro no está activado. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Forbidden name: GatewayParametersServiceError status_code: 403 details: - status: DENIED error_code: CONFIG-403 description: Prohibido description_detail: Product not enabled "404": description: No se ha encontrado. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: GatewayVerifyCardServiceError status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: No se ha encontrado description_detail: card_id Not Found "500": description: Error interno de servidor o servicio. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: GatewayRouterHTTPServicesError status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api /dpm/cofre-gw-proxy/v1/cards/{card_id}: get: tags: - Cards summary: Obtenga la tarjeta por identificación description: "__Obtener tarjeta por ID__

Recupera información detallada sobre una tarjeta específica previamente almacenada en la bóveda de Getnet, utilizando su `card_id` único.

**Escenarios de uso: **
_- Recupera los detalles de una tarjeta guardada específica.
- Valida si una tarjeta almacenada sigue activa.
- Muestra o procesa una tarjeta guardada específica en el proceso de pago. _" operationId: getCard parameters: - $ref: "#/components/parameters/XTraceID" - $ref: "#/components/parameters/CardIDParam" responses: "200": description: Datos de la tarjeta. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/CardDataResponse" "400": description: Solicitud no válida. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: GatewayVerifyCardServiceError status_code: 400 details: - status: DENIED error_code: TOKENIZATION-400 description: Solicitud incorrecta description_detail: "card_number lenght should be between 13 and 19. Current length: 4" "401": description: Autenticación no válida. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: GatewayAuthenticationOAuth2ServiceError status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: No autorizado description_detail: Invalid client credentials "403": description: El producto seguro no está activado. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Forbidden name: GatewayParametersServiceError status_code: 403 details: - status: DENIED error_code: CONFIG-403 description: Prohibido description_detail: Product not enabled "404": description: No se ha encontrado. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: GatewayVerifyCardServiceError status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: No se ha encontrado description_detail: card_id Not Found "500": description: Error interno de servidor o servicio. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: GatewayRouterHTTPServicesError status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api delete: tags: - Cards summary: Eliminar tarjeta por ID description: "__Eliminar tarjeta por ID__

Elimina una tarjeta específica previamente almacenada en la bóveda de Getnet, identificada por su `card_id`.

Esta acción elimina la tarjeta de la lista de métodos de pago guardados del comprador y deja de estar disponible para futuras transacciones.

**Escenarios de uso: **
_- Elimina las tarjetas anticuadas o caducadas.
- Permita que los usuarios administren (eliminen) sus métodos de pago guardados.
- Mejore el cumplimiento de los requisitos de privacidad de los datos. _" operationId: removeCard parameters: - $ref: "#/components/parameters/XTraceID" - $ref: "#/components/parameters/CardIDParam" responses: "204": description: La tarjeta se retiró correctamente. "400": description: Solicitud no válida. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: GatewayVerifyCardServiceError status_code: 400 details: - status: DENIED error_code: TOKENIZATION-400 description: Solicitud incorrecta description_detail: "card_number lenght should be between 13 and 19. Current length: 4" "401": description: Autenticación no válida. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: GatewayAuthenticationOAuth2ServiceError status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: No autorizado description_detail: Invalid client credentials "403": description: El almacén de productos no está activado. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Forbidden name: GatewayParametersServiceError status_code: 403 details: - status: DENIED error_code: CONFIG-403 description: Prohibido description_detail: Product not enabled "404": description: No se ha encontrado. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: GatewayVerifyCardServiceError status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: No se ha encontrado description_detail: card_id Not Found "500": description: Error interno de servidor o servicio. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: GatewayRouterHTTPServicesError status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api /dpm/cofre-gw-proxy/v1/cards/verification: post: tags: - Cards summary: Verificación de la tarjeta description: "__Verificar una tarjeta__

Este punto final le permite validar una tarjeta de crédito utilizando su representación tokenizada. Confirma que la tarjeta es válida, está activa y no está sujeta a restricciones, como la cancelación, el bloqueo o la caducidad.

**Escenarios de uso: **
_- Asegúrese de que la tarjeta es válida antes de guardarla en la bóveda.
- Verificar una tarjeta antes de iniciar un pago o una suscripción.
- Reducir los errores en las transacciones al detectar anticipadamente las tarjetas no válidas o restringidas. _

**Notas: **
_- La solicitud debe incluir un número de tarjeta tokenizado, no datos brutos de la tarjeta.
- La información de la tarjeta, como la marca, la fecha de caducidad y el CVV, debe coincidir con la que se proporcionó originalmente.
- Una respuesta satisfactoria incluye un identificador de verificación, un código de autorización y un identificador de transacción, que se pueden registrar para su trazabilidad. _" operationId: verificationCard parameters: - $ref: "#/components/parameters/XTraceID" requestBody: content: application/json: schema: $ref: "#/components/schemas/VerificationCardRequest" required: true responses: "200": description: La verificación de la tarjeta se realizó correctamente. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/VerificationCardResponse" "400": description: Solicitud no válida. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: GatewayVerifyCardServiceError status_code: 400 details: - status: DENIED error_code: TOKENIZATION-400 description: Solicitud incorrecta description_detail: "card_number lenght should be between 13 and 19. Current length: 4" "401": description: Autenticación no válida. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: GatewayAuthenticationOAuth2ServiceError status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: No autorizado description_detail: Invalid client credentials "403": description: El producto seguro no está activado. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Forbidden name: GatewayParametersServiceError status_code: 403 details: - status: DENIED error_code: CONFIG-403 description: Prohibido description_detail: Product not enabled "404": description: No se ha encontrado. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: GatewayVerifyCardServiceError status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: No se ha encontrado description_detail: card_id Not Found "500": description: Error interno de servidor o servicio. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: GatewayRouterHTTPServicesError status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api /dpm/cofre-gw-proxy/v1/cards/export: get: tags: - Cards summary: Exportación de tarjetas description: "__Listar las tarjetas guardadas en la bóveda para exportar__

Este punto final devuelve todas las tarjetas guardadas en la bóveda segura, según la identificación del vendedor. Suele utilizarse para auditar, exportar datos de tarjetas o sincronizarlas con sistemas externos.

**Escenarios de uso: **
_- Exportación de la información almacenada de las tarjetas para realizar copias de seguridad o sincronizarlas.
- Publicar todas las tarjetas asociadas a un vendedor con fines administrativos.
- Auditar los métodos de pago almacenados en la bóveda. _

**Notas: **
_- Solo se requiere el identificador del vendedor (_`x-seller-id`_) para la autenticación y el filtrado.
- No se necesitan parámetros adicionales para recuperar la lista.
- Devuelve los datos de la tarjeta, incluidos los detalles de la máscara, la marca, la caducidad y el estado.
- Solo se incluyen las tarjetas guardadas en la bóveda; el filtrado a nivel de comprador no está disponible en este terminal. _" operationId: getCardList_1 responses: "200": description: Lista de tarjetas guardadas. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/ListCardDataResponse" "400": description: Solicitud no válida. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: GatewayVerifyCardServiceError status_code: 400 details: - status: DENIED error_code: TOKENIZATION-400 description: Solicitud incorrecta description_detail: "card_number lenght should be between 13 and 19. Current length: 4" "401": description: Autenticación no válida. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: GatewayAuthenticationOAuth2ServiceError status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: No autorizado description_detail: Invalid client credentials "403": description: El producto seguro no está activado. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Forbidden name: GatewayParametersServiceError status_code: 403 details: - status: DENIED error_code: CONFIG-403 description: Prohibido description_detail: Product not enabled "404": description: No se ha encontrado. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: GatewayVerifyCardServiceError status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: No se ha encontrado description_detail: card_id Not Found "500": description: Error interno de servidor o servicio. content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: GatewayRouterHTTPServicesError status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api /rpy/be-customer/v1/customers: get: tags: - Customers summary: Consigue clientes por identificador de vendedor description: "__Listar clientes para un vendedor especifico__

Este punto final recupera una lista paginada de clientes registrados asociados a un vendedor específico. Por lo general, se usa para la gestión de clientes, la facturación recurrente o las consultas administrativas dentro de la plataforma Getnet.

**Escenarios de uso: **
_- Visualización de todos los clientes creados con una cuenta de vendedor determinada.
- Realizar tareas administrativas, como la gestión de registros de clientes o el registro de auditorías.
- Validar si un cliente ya está registrado antes de intentar crear o actualizar sus datos. _

**Notas: **
_- Requiere el encabezado_ `x-seller-id` _ para identificar al vendedor que realiza la solicitud.
- La consulta admite la paginación mediante los parámetros _ `page` _y_ `limit` _.
- El punto final devuelve una lista estructurada de clientes que incluye sus identificadores y atributos registrados (por ejemplo, nombre, tipo de documento, correo electrónico) . _" operationId: getCustomers parameters: - $ref: "#/components/parameters/CustomerID" - name: id in: query description: Identificador de cliente. required: false schema: type: string - name: document_number in: query description: Número de documento del cliente. required: false schema: type: string - name: first_name in: query description: Nombre del cliente. required: false schema: type: string - name: last_name in: query description: Apellido del cliente. required: false schema: type: string - name: sort in: query description: Campo para realizar la clasificación. required: false schema: type: string default: last_name example: last_name - name: sort_type in: query description: Tipo de clasificación. Ascendente o descendente. required: false schema: type: string default: asc example: asc, desc - name: name in: query description: Nombre completo del cliente. required: false schema: type: string - name: status in: query description: Estado del cliente. required: false schema: type: string example: active, inactive - name: page in: query description: Número de página donde comienza la paginación. required: true schema: type: integer format: int32 - name: limit in: query description: Limita los resultados por página. required: true schema: type: integer format: int32 - $ref: "#/components/parameters/Country" - $ref: "#/components/parameters/Tenant" responses: "200": description: BIEN content: application/json: schema: $ref: "#/components/schemas/ListCustomersResponse" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "404": description: No se ha encontrado content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api post: tags: - Customers summary: Crear cliente description: "__Solicitar cotizaciones en cuotas __

Este punto final le permite crear un nuevo perfil de cliente dentro de la plataforma Getnet. Se usa principalmente para escenarios de recurrencia, ya que permite asociar los datos de los clientes con pagos futuros, como suscripciones, cargos recurrentes o transacciones tokenizadas.

**Escenarios de uso: **
_- Asociar los perfiles de los clientes con tarjetas guardadas o pagos tokenizados.
- Habilitar los metadatos y preferencias específicos del cliente para la personalización y el seguimiento. _

**Notas: ** _
- Los campos _ `seller_id` _y_ `customer_id` _ son obligatorios para identificar de forma exclusiva a la plataforma y al comprador.
- Se recopila información personal detallada, como el nombre, el tipo y número de documento, la fecha de nacimiento y la información de contacto.
-El document_type admite varios formatos según el país (por ejemplo, _ `CPF`, `CNPJ`, `DNI_AR`, `CI_CL`_, etc.).
-Los números de teléfono deben proporcionarse sin máscara ni formato.
-Opcionalmente, se puede agregar un bloque de direcciones para fines de facturación o verificación.
-La validación adecuada de los formatos y longitudes de los documentos es esencial para un registro exitoso. _" operationId: postCustomers requestBody: content: application/json: schema: $ref: "#/components/schemas/CustomerDTOSubs" required: true responses: "200": description: BIEN content: application/json: schema: $ref: "#/components/schemas/CustomerDTO" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "404": description: No se ha encontrado content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. "502": description: Puerta de enlace incorrecta content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "504": description: Tiempo de espera de puerta de enlace content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Gateway Timeout name: Module or service that returned the error status_code: 504 details: - status: ERROR error_code: GENERIC-504 description: Tiempo de espera de puerta de enlace description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api /rpy/be-customer/v1/customers/{customer_id}: get: tags: - Customers summary: Obtener cliente por identificación description: "__Obtener cliente por identificación__

Este punto final recupera información detallada de un cliente específico en función de su «ID de cliente» único. Se usa para obtener los registros completos de los clientes para las tareas de validación, procesamiento recurrente o soporte.

**Escenarios de uso: **
_- Obtener el perfil de un cliente para revisarlo o mostrarlo en un panel de control.
- Validar los detalles del cliente antes de procesar una nueva transacción recurrente.
- Verificar los datos almacenados, como la dirección, el tipo de documento o la información de contacto. _

**Notas: ** _
- Requiere el_ `customer_id` _ como parámetro de ruta en el formato_ **UUIDv4** _.
- Devuelve la información completa del cliente, incluidos los detalles personales, los datos de contacto y, opcionalmente, la dirección y los metadatos del documento. _" operationId: getCustomersById parameters: - name: customer_id in: path description: Identificador de cliente. required: true schema: type: string responses: "200": description: BIEN content: application/json: schema: $ref: "#/components/schemas/CustomerDTOSubs" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "404": description: No se ha encontrado content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. "502": description: Puerta de enlace incorrecta content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "504": description: Tiempo de espera de puerta de enlace content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Gateway Timeout name: Module or service that returned the error status_code: 504 details: - status: ERROR error_code: GENERIC-504 description: Tiempo de espera de puerta de enlace description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api /rpy/be-plan/v1/plans: get: tags: - Recurrence Plans summary: Obtén planes por identificador de vendedor description: "__Listar los planes de recurrencia para un vendedor especifico__

Este punto final le permite recuperar una lista paginada de los planes de recurrencia registrados anteriormente en la plataforma Getnet. Ayuda a gestionar las configuraciones de suscripción o pagos recurrentes existentes vinculadas a un vendedor específico.

**Escenarios de uso: **
_- Mostrar los planes disponibles para la inscripción de clientes.
- Revisar las configuraciones de los planes de facturación existentes.
- Auditar o mantener el ciclo de vida de los planes de recurrencia. _

**Notas: **
_- Requiere el encabezado_ `x-seller-id` _ para identificar al vendedor que realiza la solicitud.
- La consulta admite la paginación mediante los parámetros _ `page` _y_ `limit` _. _" operationId: plansGet_1 parameters: - name: page in: query description: Número de página donde comienza la paginación. required: true schema: minimum: 1 type: integer format: int32 - name: limit in: query description: Límite de resultados por página. required: true schema: maximum: 9999 minimum: 0 type: integer format: int32 - name: plan_id in: query description: Identificador del plan. required: false schema: type: string format: uuid - name: id in: query description: Identificador del plan. required: false schema: type: string format: uuid - name: status in: query description: Estado del plan. required: false schema: type: string - name: name in: query description: Nombre del plan de recurrencia. required: false schema: maxLength: 2147483647 minLength: 3 type: string - name: sort in: query description: Campo para realizar el pedido. required: false schema: type: string default: name - name: sort_type in: query description: Tipo de clasificación. Ascendente o descendente («asc» e «desc»). required: false schema: type: string - name: expand in: query description: Expandir. required: false schema: type: array items: type: string responses: "200": description: BIEN content: application/json: schema: $ref: "#/components/schemas/PlanDataWrapper" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "404": description: No se ha encontrado content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api post: tags: - Recurrence Plans summary: Crear plan de recurrencia description: "__Registrar un plan de periodicidad__

Este punto final permite la creación de un plan de recurrencia, que define la estructura de los pagos programados futuros. Estos planes se suelen usar para suscripciones, cuotas o servicios recurrentes.

**Escenarios de uso: **
_- Creación de planes de suscripción mensuales o anuales para servicios digitales o productos físicos. _

**Notas: **
_- El campo_ `seller_id` _es obligatorio y debe ser válido para la autorización.
- Debes especificar al menos un **tipo_de_pago** (p. ej., _ `credit_card`, `debit_card`_).
- El objeto período define el intervalo de recurrencia (p. ej., mensual con 12 ciclos).
- Los valores _type de producto_ aceptados definen la naturaleza de lo que se factura (por ejemplo, _ `productos_digitales`, `servicio`_).
- La _ `divisa` _ debe seguir el formato**ISO 4217** (p. ej., _ `BRL`, `ARS`, `USD`_) . _" operationId: plansPost_1 requestBody: content: application/json: schema: $ref: "#/components/schemas/PlanRequest" required: true responses: "200": description: BIEN content: application/json: schema: $ref: "#/components/schemas/Plan" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "404": description: No se ha encontrado content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. "502": description: Puerta de enlace incorrecta content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "504": description: Tiempo de espera de puerta de enlace content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Gateway Timeout name: Module or service that returned the error status_code: 504 details: - status: ERROR error_code: GENERIC-504 description: Tiempo de espera de puerta de enlace description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api /rpy/be-plan/v1/plans/{plan_id}: get: tags: - Recurrence Plans summary: Obtenga el plan por identificación description: "__Obtenga un plan de recurrencia por id__

Este punto final recupera información detallada sobre un plan de recurrencia específico mediante su `plan_id` único. Resulta útil para ver la configuración de un plan de suscripción, incluidos el ciclo de facturación, los métodos de pago y el importe.

**Escenarios de uso: **
_- Recuperar todos los detalles de un plan de periodicidad para mostrarlos o revisarlos.
- Validar la configuración de un plan específico antes de la suscripción del cliente. _

**Notas: ** _
- Requiere el_ `plan_id` _ como parámetro de ruta en el formato_ **UUIDv4** _.
- El encabezado_ `x-seller-id` _ es obligatorio para identificar al vendedor solicitante.
- Devuelve los metadatos completos del plan, incluidos el período, el importe, la moneda, los tipos de pago y los datos flotantes, si procede.
- Garantiza que solo se pueda acceder a los planes asociados al vendedor autenticado. _" operationId: plansIdGet parameters: - $ref: "#/components/parameters/PlanID" - name: expand in: query required: false schema: type: array items: type: string responses: "200": description: BIEN content: application/json: schema: $ref: "#/components/schemas/Plan" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "404": description: No se ha encontrado content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api patch: tags: - Recurrence Plans summary: Plan de actualización description: "__Actualizar un plan__

Este punto final le permite actualizar los atributos de un plan de recurrencia existente. Por lo general, se usa para modificar los metadatos del plan, como el nombre, la descripción o los datos de las cuotas flotantes, sin alterar su identidad o historial de suscripciones.

**Escenarios de uso: **
_- Corregir o mejorar la presentación del plan en las interfaces orientadas al usuario.
- Ajustar las opciones de pago a plazos (por ejemplo, añadir o modificar importes variables por pago). _

**Notas: **
_- Puedes actualizar atributos como los **nombre**, **descripción** y **floating_data** del plan, que contienen opciones personalizadas de **cuatro** (**número de cuatro** y el correspondiente **importa** en centavos).
- Solo se actualizarán los campos incluidos en el cuerpo de la solicitud; los campos que no estén presentes permanecerán sin cambios. _" operationId: plansIdPut parameters: - $ref: "#/components/parameters/PlanID" - name: username in: header description: Usuario que se está registrando. Esta información se puede utilizar con fines de auditoría. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdatePlan" required: true responses: "200": description: BIEN content: application/json: schema: $ref: "#/components/schemas/Plan" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "404": description: No se ha encontrado content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api /rpy/be-plan/v1/plans/subscriptions/migration: post: tags: - Recurrence Plans summary: Migrar suscripciones description: "__Migrar las suscripciones a otro plan__

Este punto final le permite migrar una o más suscripciones de un plan periódico existente (desde) a un nuevo plan de destino (hacia). Esto resulta útil a la hora de actualizar las condiciones o los precios de una suscripción activa sin interrumpir el servicio al cliente.

**Escenarios de uso: **
_- Trasladar a los clientes actuales de un plan antiguo a un plan recién estructurado o actualizado.
- Actualizar el precio de las suscripciones o la frecuencia de facturación y, al mismo tiempo, conservar las suscripciones activas.
- Consolidar las suscripciones en un solo plan para facilitar la administración. _

**Notas: **
_- Los ID del plan de origen y destino deben ser **UUIDs** válidos y pertenecer al mismo vendedor.
- Si no se proporciona la lista de suscripciones, todas las suscripciones vinculadas al plan de origen (desde) se migrarán al plan de destino (hacia).
- El encabezado del nombre de usuario debe proporcionarse con fines de auditoría y trazabilidad.
- Asegúrese de que el plan de destino tenga configuraciones compatibles para evitar problemas durante la migración. _" operationId: plansSubscriptionsMigration parameters: - name: username in: header description: Usuario que se está registrando. Esta información se puede utilizar con fines de auditoría. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/SubscriptionPlanMigration" required: true responses: "202": description: Aceptado content: application/json: schema: $ref: "#/components/schemas/SubscriptionPlanMigration" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "404": description: No se ha encontrado content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api /rpy/be-plan/v1/plans/{plan_id}/status/{status}: patch: tags: - Recurrence Plans summary: Actualizar el estado del plan operationId: plansUpdateStatus description: "__Actualizar el estado del plan__

Este punto final le permite actualizar el estado de un plan de recurrencia existente. Puedes usarlo para **activar** o **desactivar** (inactivo) un plan en función de las necesidades de tu empresa. Se usa comúnmente para activar o pausar planes sin eliminarlos.

**Escenarios de uso: **
_- Activar un nuevo plan después de la configuración inicial.
- Desactivar temporalmente un plan que ya no está disponible para nuevas suscripciones.
- Activar o desactivar un plan en función de los períodos promocionales o de las normas empresariales internas. _

**Notas: **
_- El _ `plan_id` _ debe proporcionarse en la ruta de la URL de la solicitud.
- El nuevo estado (_`activo` _o_ `inactivo`_) también se pasa como parámetro de ruta. _" parameters: - name: Content-Type in: header description: Tipo de contenido. required: true schema: type: string default: application/json; charset=utf-8 enum: - application/json; charset=utf-8 - $ref: "#/components/parameters/Username" - $ref: "#/components/parameters/PlanID" - name: status in: path description: Estado del plan. required: true schema: type: string enum: - active - inactive responses: "200": description: Devuelve los datos del plan. content: application/json: schema: $ref: "#/components/schemas/PlanResponse" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "404": description: No se ha encontrado content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api /rpy/be-subscription/v1/subscriptions: get: tags: - Subscriptions summary: Obtenga suscripciones description: "__Listar suscripciones__

Este punto final recupera una lista paginada de todas las suscripciones creadas por el vendedor, incluidos su estado actual, los detalles del cliente y las asociaciones de planes.

**Escenarios de uso: **
_- Supervisar las suscripciones activas o programadas vinculadas a clientes o planes específicos.
- Creación de paneles o informes con los estados actuales de las suscripciones.
- Auditar o depurar la actividad de las suscripciones en función de los filtros (por ejemplo, el cliente, la fecha o el plan). _

**Notas: **
_- Debes incluir el encabezado_ `x-seller-id` _ para identificar al vendedor.
- Soporta la paginación mediante los parámetros de consulta_ `page` _y_ `limit`.
- El resultado contendrá metadatos sobre cada suscripción, como el identificador, la referencia del plan, las fechas de creación y facturación y el estado actual (por ejemplo, _ `active`, `programada`, `cancelada`_) . _" operationId: subscriptionsGet parameters: - name: page in: query description: Número de página donde comienza la paginación. required: true schema: minimum: 1 type: integer format: int32 - name: limit in: query description: Limita los resultados por página. required: true schema: minimum: 1 type: integer format: int32 - $ref: "#/components/parameters/CustomerID" - $ref: "#/components/parameters/PlanID" - $ref: "#/components/parameters/OrderID" - $ref: "#/components/parameters/SubscriptionID" - name: id in: query description: Identificador de firma de recurrencia. required: false schema: type: string format: uuid - name: next_scheduled_date[start] in: query description: Fecha de inicio de la próxima cita. required: false schema: type: string - name: next_scheduled_date[end] in: query description: Fecha de finalización de la próxima cita. required: false schema: type: string - name: installment_start_date[start] in: query description: Busque la fecha de inicio por fecha de inicio del pago. required: false schema: type: string format: date - name: installment_start_date[end] in: query description: Buscar fecha de finalización por fecha de inicio del pago. required: false schema: type: string format: date - name: create_date[start] in: query description: Fecha de inicio de la creación de la suscripción. required: false schema: type: string - name: create_date[end] in: query description: Fecha de finalización de la creación de la suscripción. required: false schema: type: string - name: end_date[start] in: query description: Fecha de inicio de la suscripción. required: false schema: type: string - name: end_date[end] in: query description: Fecha de finalización de la suscripción. required: false schema: type: string - name: sort in: query description: Campo para realizar la clasificación. required: false schema: type: string default: status - name: sort_type in: query description: Tipo de clasificación. Ascendente o descendente. required: false schema: type: string default: asc - name: status in: query description: Estado de la suscripción. required: false schema: type: string - name: expand in: query description: Fluctuaciones de fecha y valor required: false schema: type: array items: type: string responses: "200": description: Solicitud realizada correctamente content: application/json: schema: $ref: "#/components/schemas/FilteredResponse" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "404": description: No se ha encontrado content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api post: tags: - Subscriptions summary: Crear suscripción description: "__Registrar una nueva suscripción__

según un plan predefinido. Se usa para inscribir a un cliente en un calendario de pagos recurrentes.

**Escenarios de uso: **
_- Iniciar una nueva suscripción para servicios digitales, membresías, etc.
- Asociar a un comprador a un plan específico con una facturación recurrente automatizada.
- Establecer una fecha de inicio personalizada para la suscripción a fin de controlar los ciclos de facturación. _

**Notas: **
_- Requiere un _ `plan_id` _ válido de un plan de periodicidad existente.
- El_ `installment_start_date` _ determina cuándo comienza a facturarse la suscripción. Hasta entonces, permanecerá en estado Programado.
- El objeto _ `suscripción` _debe incluir el _ `tipo de pago` _ elegido (por ejemplo, _ `crédito`_) y, opcionalmente, la dirección de facturación y la información de la cuota. _" operationId: subscriptionsPost parameters: - $ref: "#/components/parameters/Username" requestBody: content: application/json: schema: $ref: "#/components/schemas/SubscriptionCreation" required: true responses: "201": description: Solicitud realizada correctamente content: application/json;charset=UTF8: schema: $ref: "#/components/schemas/SubscriptionResponse" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "404": description: No se ha encontrado content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api /rpy/be-subscription/v1/subscriptions/{subscription_id}: get: tags: - Subscriptions summary: Obtenga la suscripción por ID description: "__Obtener suscripción por id__

Este punto final recupera información detallada sobre una suscripción específica mediante su identificador único. Devuelve datos sobre el plan, el ciclo de facturación, el cliente y el estado actual de la suscripción.

**Escenarios de uso: **
_- Mostrar todos los detalles de la suscripción en el panel de control del cliente o en el panel de administración.
- Verificar el estado actual de una suscripción (p. ej., activa, programada o cancelada).
- Recuperar el plan de facturación asociado, la configuración de pago y la próxima fecha de facturación. _" operationId: subscriptionGet parameters: - name: subscription_id in: path description: Identificador del comprador. required: true schema: type: string - name: expand in: query description: Fluctuaciones de fecha y valor required: false schema: type: array items: type: string responses: "200": description: Solicitud realizada correctamente content: "*/*": schema: $ref: "#/components/schemas/SubscriptionResponse" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "404": description: No se ha encontrado content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api /rpy/be-subscription/v1/subscriptions/{subscription_id}/cancel: post: tags: - Subscriptions summary: Cancelar suscripción description: "__Cancelar una suscripción existente__

Este punto final le permite cancelar una suscripción existente mediante su identificador único. Actualiza el estado de la suscripción a «CANCELADO» y, opcionalmente, registra el motivo con fines de auditoría y seguimiento.

**Escenarios de uso: **
_- Cuando un cliente solicita explícitamente detener su suscripción.
- Como parte de procesos automatizados (por ejemplo, pagos fallidos o infracciones de políticas).
- Cuando un servicio o producto deja de fabricarse. _

**Notas: **
_- Si lo desea, puede proporcionar un campo _ `status_details` _ para documentar el motivo de la cancelación (útil para obtener información empresarial o de auditoría).
- Una vez cancelada, la suscripción no generará más eventos de facturación ni renovaciones. _" operationId: subscriptionCancel parameters: - name: subscription_id in: path description: Identificador del comprador. required: true schema: type: string - $ref: "#/components/parameters/Username" requestBody: content: application/json: schema: $ref: "#/components/schemas/SubscriptionCancel" required: true responses: "200": description: Solicitud realizada correctamente content: application/json: schema: $ref: "#/components/schemas/SubscriptionResponse" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "404": description: No se ha encontrado content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api /rpy/be-subscription/v1/subscriptions/{subscription_id}/charges/projection: get: tags: - Subscriptions summary: Proyección de cargos description: "__Demuestra la proyección de los cargos__

Este punto final devuelve una proyección detallada de los próximos cargos de una suscripción específica. Es útil para comprender las fechas y los importes de facturación futuros, en función del ciclo de facturación de la suscripción y la configuración actual.

**Escenarios de uso: **
_- Mostrar los cargos futuros que se le cobrarán al cliente en un panel orientado al cliente.
- Validar los patrones de cobros recurrentes para productos o servicios basados en suscripciones.
- Estimar los ingresos a lo largo del tiempo para realizar análisis o previsiones.
- Confirmar los cargos futuros antes de ejecutar las renovaciones o los reintentos. _

**Notas: **
_- La respuesta incluye una o varias entradas con los importes de los cargos y las fechas de vencimiento proyectados.
- **No** activa ninguna facturación; se trata de una solicitud informativa de **solo lectura**.
- Ayuda a identificar problemas como la facturación desalineada o los valores incorrectos antes de que afecten a los flujos de pago. _" operationId: chargesProjection parameters: - name: subscription_id in: path description: Identificador de firma de recurrencia. required: true schema: type: string format: uuid - name: expand in: query description: Información adicional sobre el número de cuotas y/o las fluctuaciones en la fecha y el valor. {cuota, floating_data} required: false schema: type: string - name: limit in: query required: false schema: type: integer format: int32 responses: "200": description: Solicitud realizada correctamente content: application/json;charset=utf-8: schema: $ref: "#/components/schemas/AmountProjection" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "404": description: No se ha encontrado content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. "502": description: O serviço está indisponível. Por favor, tente mais tarde. content: application/json;charset=utf-8: schema: $ref: "#/components/schemas/AmountProjection" security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api /rpy/be-subscription/v1/subscriptions/{subscription_id}/confirmPayment: post: tags: - Subscriptions summary: Confirmar el pago de una suscripción description: "__Confirmar el pago de una suscripción__

Este punto final confirma el pago de un cargo específico asociado a una suscripción. Por lo general, se usa para confirmar los pagos de forma manual en los casos en que el pago se ha completado fuera del flujo de procesamiento normal y es necesario confirmarlo dentro del sistema.

**Escenarios de uso: **
_- Marcar un cargo como pagado después de recibir la confirmación manual o offline (por ejemplo, una transferencia bancaria).
- Sincronizar el estado de facturación de la suscripción después de resolver el procesamiento de pagos externo.
- Anular los estados fallidos o pendientes para cargos específicos, una vez validados por el vendedor. _

**Notas: **
- `status_detail` _ es opcional y se puede utilizar para añadir notas de contexto o de auditoría para la confirmación.
- Esta acción solo debe realizarse si el pago se ha completado, ya que actualiza directamente el estado de facturación de la suscripción.
_" operationId: confirmChargePayment parameters: - name: subscription_id in: path description: Identificador de firma de recurrencia. required: true schema: type: string format: uuid - $ref: "#/components/parameters/Username" requestBody: content: application/json: schema: $ref: "#/components/schemas/ConfirmPayment" required: true responses: "200": description: BIEN content: application/json: schema: $ref: "#/components/schemas/SubscriptionResponse" "201": description: El pago se ha confirmado correctamente. content: application/json: schema: $ref: "#/components/schemas/SubscriptionResponse" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "404": description: No se ha encontrado content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api /rpy/be-subscription/v1/subscriptions/{subscription_id}/paymentDate: patch: tags: - Subscriptions summary: Actualizar fecha de pago description: "__Actualizar la fecha de pago de la suscripción__

Este punto final permite a los comerciantes actualizar la fecha de pago recurrente de una suscripción activa. Modifica el día del mes en el que se generarán los cargos futuros.

**Escenarios de uso: **
_- Ajustar la programación de cargos según las preferencias del cliente.
- Alinear la fecha de facturación de la suscripción con la nómina u otros ciclos de pago.
- Corregir un error de configuración inicial relacionado con la fecha de cobro. _

**Notas: **
_- Solo se puede actualizar el día del mes con este punto final (por ejemplo, del 1 al 28 o al 31, según las restricciones del calendario).
- La actualización afecta a todos los ciclos de facturación futuros, a partir del siguiente cargo.
- Si la nueva fecha ya pasó en el mes actual, el cambio se aplicará a partir del siguiente ciclo de facturación disponible.
- Asegúrate de que la suscripción esté activa antes de intentar realizar esta actualización. Las suscripciones inactivas o canceladas no se pueden modificar. _" operationId: paymentDatePatch parameters: - name: subscription_id in: path description: Identificador del comprador. required: true schema: type: string - name: username in: header description: Usuario que se está registrando. Esta información se puede utilizar con fines de auditoría. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/PaymentDate" required: true responses: "200": description: Solicitud realizada correctamente content: application/json: schema: $ref: "#/components/schemas/SubscriptionResponse" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "404": description: No se ha encontrado content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api /rpy/be-subscription/v1/subscriptions/{subscription_id}/paymentType/credit/card: patch: tags: - Subscriptions summary: Actualizar datos de pago description: "__Actualizar los datos de pago de la

suscripción__ Este punto final permite a los comerciantes actualizar el método de pago de una suscripción existente, específicamente cambiar a una tarjeta de crédito nueva o actualizada.

**Escenarios de uso: **
_- Actualizar la tarjeta de crédito de una suscripción activa.
- Sustituir una tarjeta caducada o no válida.
- Cambiar a una marca o emisor de tarjeta diferente para la facturación. _

**Notas: **
_- La información de la nueva tarjeta debe estar tokenizada y proporcionarse de forma segura.
- Esta actualización se aplica a todos los ciclos de facturación futuros de la suscripción.
- Asegúrese de que la suscripción esté activa antes de utilizar esta operación. _" operationId: patchPaymentData parameters: - name: subscription_id in: path description: Identificador de firma de recurrencia. required: true schema: type: string format: uuid - name: username in: header description: Usuario que se está registrando. Esta información se puede utilizar con fines de auditoría. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/ReplaceCreditCard" required: true responses: "200": description: Los datos se actualizaron correctamente. content: application/json: schema: $ref: "#/components/schemas/SubscriptionResponse" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "404": description: No se encontró la firma. content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api /rpy/be-subscription/v1/subscriptions/{subscriptionId}/floating: get: tags: - Subscriptions summary: Obtenga cambios en las cuotas de suscripción description: "__Obtener cambios en las cuotas de la suscripción__

Este punto final recupera todos los cambios de fecha o valor realizados en el cronograma de facturación de una suscripción periódica específica. Te permite hacer un seguimiento de los ajustes en los montos de las cuotas o las fechas de facturación.

**Escenarios de uso: **
_- Auditoría de los cambios en las fechas o importes de facturación de las suscripciones.
- Validar los cambios programados antes de ejecutar un ciclo de facturación.
- Solucionar las discrepancias en las suscripciones debidas a la modificación de las cuotas. _

**Notas: **
_- Devuelve información detallada de cada cuota modificada, incluidos los valores originales y nuevos del importe y la fecha programada.
- Útil para la transparencia del cumplimiento, la elaboración de informes y la facturación. _" operationId: floatingDataGet parameters: - name: subscriptionId in: path description: Identificador de la suscripción recurrente. required: true schema: type: string format: uuid responses: "200": description: Solicitud realizada correctamente content: application/json: schema: $ref: "#/components/schemas/FloatingDataResponse" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "404": description: No se encontró la firma. content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api post: tags: - Subscriptions summary: Establecer cambios en las cuotas de la suscripción description: "__Establecer cambios en las cuotas de la suscripción__

En este punto final, puede crear un nuevo cambio de fecha o valor para uno o más cargos programados para la suscripción. Para usar este punto final, el establecimiento debe estar habilitado para este producto específico. Para obtener más información, consulta las reglas de cambio de fecha.

**Escenarios de uso: **
_- Ajustar el importe del cargo para una cuota específica debido a descuentos o correcciones.
- Cambiar el día de facturación de una cuota para mayor comodidad del cliente.
- Actualizar los planes de suscripción dinámicos con condiciones de facturación variables. _" operationId: subscriptionFloatingDataPost parameters: - name: subscriptionId in: path description: Identificador de firma de recurrencia. required: true schema: type: string format: uuid - $ref: "#/components/parameters/Username" requestBody: content: application/json: schema: type: array description: Solicitud que contiene datos para el registro de una nueva firma. items: $ref: "#/components/schemas/FloatingData" required: true responses: "200": description: Solicitud realizada correctamente content: application/json: schema: $ref: "#/components/schemas/FloatingDataResponse" "201": description: Creado content: application/json: schema: $ref: "#/components/schemas/FloatingDataResponse" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "403": description: La recurrencia del producto no está habilitada. Póngase en contacto con el Centro de Relaciones de Getnet. content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Forbidden name: Module or service that returned the error status_code: 403 details: - status: DENIED error_code: CONFIG-403 description: Prohibido description_detail: Product not enabled "404": description: No se encontró la firma. content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. "502": description: El servicio no está disponible. Vuelva a intentarlo más tarde. content: application/json: schema: $ref: "#/components/schemas/FloatingDataResponse" security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api delete: tags: - Subscriptions summary: Eliminar los cambios de las cuotas de suscripción description: "__Eliminar los cambios de las cuotas de la suscripción__

Este punto final elimina todos los datos flotantes (cambios específicos de la cuota) asociados a una suscripción determinada. Esto restaura de manera efectiva el cronograma de cuotas y los valores predeterminados, tal como los define el plan.

**Escenarios de uso: **
_- Revertir las fechas o importes de facturación personalizados a la configuración predeterminada del plan.
- Limpiar las entradas de datos flotantes desactualizadas o incorrectas.
- Restablecer el comportamiento de facturación de una suscripción después de que el cliente o la empresa hayan tomado decisiones. _

**Notas: **
_- Esta acción eliminará todos los datos flotantes asociados a la suscripción.
- Esta operación es irreversible: una vez eliminados, los datos flotantes se deben volver a crear manualmente si es necesario. _" operationId: floatingDataDeleteAll parameters: - name: subscriptionId in: path description: Identificador de firma. required: true schema: type: string format: uuid - $ref: "#/components/parameters/Username" responses: "200": description: La solicitud se completó parcialmente con éxito. Enumere las fluctuaciones que no se pueden eliminar y sus motivos. content: application/json: schema: $ref: "#/components/schemas/FloatingDataRemoveResponse" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "403": description: La recurrencia del producto no está habilitada. Póngase en contacto con el Centro de Relaciones de Getnet. content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Forbidden name: Module or service that returned the error status_code: 403 details: - status: DENIED error_code: CONFIG-403 description: Prohibido description_detail: Product not enabled "404": description: No se encontró la firma. content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. "502": description: El servicio no está disponible. Vuelva a intentarlo más tarde. content: application/json: schema: $ref: "#/components/schemas/FloatingDataRemoveResponse" security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api patch: tags: - Subscriptions summary: Actualizar los cambios de las cuotas de suscripción description: "__Actualizar los cambios de las cuotas de suscripción__

Este punto final actualiza o crea una entrada de datos flotante para una suscripción específica. Los datos flotantes permiten personalizar los valores de las cuotas en días específicos del mes, anulando la programación y los valores predeterminados establecidos en el plan de suscripción.

**Escenarios de uso: **
_- Modificar un valor de cuota flotante creado anteriormente.
- Ajustar el comportamiento de facturación para reflejar un valor negociado o promocional. _" operationId: subscriptionFloatingDataPatch parameters: - name: subscriptionId in: path description: Identificador de suscripción recurrente. required: true schema: type: string format: uuid - $ref: "#/components/parameters/Username" requestBody: content: application/json: schema: type: array description: Solicitud que contiene datos para el registro de una nueva firma. items: $ref: "#/components/schemas/FloatingData" required: true responses: "200": description: Solicitud realizada correctamente content: application/json: schema: $ref: "#/components/schemas/FloatingDataResponse" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "403": description: La recurrencia del producto no está habilitada. Póngase en contacto con el Centro de Relaciones de Getnet. content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Forbidden name: Module or service that returned the error status_code: 403 details: - status: DENIED error_code: CONFIG-403 description: Prohibido description_detail: Product not enabled "404": description: No se encontró la firma. content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. "502": description: O serviço está indisponível. Por favor, tente mais tarde. content: application/json: schema: $ref: "#/components/schemas/FloatingDataResponse" security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api /rpy/be-subscription/v1/subscriptions/{subscriptionId}/floating/installment/{installment}: put: tags: - Subscriptions summary: Actualizar la fluctuación de la cuota de suscripción description: "__Actualiza la fluctuación de fecha y valor en la suscripción para una cuota concreta__

Este punto final actualiza una cuota específica dentro de los datos flotantes de una suscripción, lo que permite ajustar con precisión tanto el importe como la fecha de facturación de esa cuota. Proporciona un control más preciso sobre la personalización de los pagos más allá de las reglas mensuales habituales.

**Escenarios de uso: **
_- Modificar el importe y la fecha de facturación de una cuota específica de una suscripción.
- Corregir un cargo por pago en cuotas previamente configurado.
- Solucionar las discrepancias en las suscripciones debidas a la modificación de las cuotas. _" operationId: subscriptionFloatingDataPut parameters: - name: subscriptionId in: path description: Identificador de suscripción recurrente. required: true schema: type: string format: uuid - name: installment in: path description: Identificador de la cuota de facturación. required: true schema: type: integer format: int32 - $ref: "#/components/parameters/Username" requestBody: content: application/json: schema: $ref: "#/components/schemas/FloatingDataUpdate" required: true responses: "200": description: Solicitud realizada correctamente content: application/json: schema: $ref: "#/components/schemas/FloatingDataResponse" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "403": description: La recurrencia del producto no está habilitada. Póngase en contacto con el Centro de Relaciones de Getnet. content: application/json: schema: $ref: "#/components/schemas/FloatingDataResponse" "404": description: No se encontró la firma. content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. "502": description: El servicio no está disponible. Vuelva a intentarlo más tarde. content: application/json: schema: $ref: "#/components/schemas/FloatingDataResponse" security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api delete: tags: - Subscriptions summary: Eliminar la fluctuación de la cuota de suscripciones description: "__Eliminar la fluctuación de fecha y valor en la suscripción para una cuota concreta__

Este punto final elimina una entrada de cuota flotante específica de una suscripción. Resulta útil cuando solo es necesario eliminar una cuota de la configuración flotante, en lugar de borrar toda la configuración flotante.

**Escenarios de uso: **
_- Eliminar una única configuración de instalación flotante incorrecta u obsoleta.
- Revertir una cuota específica para que siga la configuración del plan predeterminada.
- Permitir la redefinición o actualización manual de una cuota sin afectar a las demás. _" operationId: floatingDataDelete parameters: - name: subscriptionId in: path description: Identificador de suscripción. required: true schema: type: string format: uuid - name: installment in: path description: Identificador de la parcela de la cobranza. required: true schema: type: integer format: int32 - $ref: "#/components/parameters/Username" responses: "200": description: La solicitud se completó parcialmente con éxito. Enumere las fluctuaciones que no se pueden eliminar y sus motivos. content: application/json: schema: $ref: "#/components/schemas/FloatingDataRemoveResponse" "204": description: Solicitud realizada correctamente content: application/json: schema: $ref: "#/components/schemas/FloatingDataRemoveResponse" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "403": description: La recurrencia del producto no está habilitada. Póngase en contacto con el Centro de Relaciones de Getnet. content: application/json: schema: $ref: "#/components/schemas/FloatingDataRemoveResponse" "404": description: No se encontró la firma. content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. "502": description: El servicio no está disponible. Vuelva a intentarlo más tarde. content: application/json: schema: $ref: "#/components/schemas/FloatingDataResponse" security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api /rpy/be-subscription/v1/subscriptions/{subscriptionId}/plans/migration: post: tags: - Subscriptions summary: Migrar el plan de suscripción description: "__Migrar el plan de

suscripción__ Este punto final permite la migración de una suscripción de un plan a otro. Permite a los comerciantes actualizar los términos de una suscripción existente asignándole un plan predefinido diferente.

**Escenarios de uso: **
_- Migración de las suscripciones antiguas a planes nuevos o actualizados.
- Ajustar las funciones o la estructura de precios de una suscripción sin necesidad de cancelarla ni recrearla. _" operationId: migrateSubscriptionPlan parameters: - name: subscriptionId in: path description: Cambio de plan de suscripción. required: true schema: type: string format: uuid - $ref: "#/components/parameters/Username" requestBody: content: application/json: schema: $ref: "#/components/schemas/PlanMigrationRequest" required: true responses: "200": description: Solicitud realizada correctamente content: application/json: schema: $ref: "#/components/schemas/SubscriptionResponse" "400": description: Solicitud no válida content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Solicitud incorrecta description_detail: Detailed error description "404": description: No se encontró la firma. content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno de servidor o servicio content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Error interno del servidor description_detail: The server encountered an unexpected error. "502": description: El servicio no está disponible. Vuelva a intentarlo más tarde. content: application/json: schema: $ref: "#/components/schemas/FloatingDataResponse" security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api /rpy/be-subscription/v1/charges: get: tags: - Subscriptions summary: Obtenga todos los cargos description: "__Listar todos los cargos__

Este punto final recupera una lista de todos los cargos registrados en el sistema. Puedes aplicar varios filtros para reducir los resultados, como filtrar por suscripción, cliente, estado del cargo y fechas.

**Escenarios de uso: **
_- Visualización de todos los cargos dentro de un período de tiempo determinado.
- Filtrar los cargos por suscripción, cliente o plan.
- Supervisar los estados de los cargos (por ejemplo, pendientes, pagados o fallidos).
- Exportación de datos de cargos para su análisis o generación de informes. _" operationId: getAllCharges parameters: - name: page in: query required: false schema: type: integer format: int32 - name: limit in: query required: false schema: type: integer format: int32 - name: retries in: query required: false schema: type: integer format: int32 - name: plan_id in: query required: false schema: type: string - name: subscription_id in: query required: false schema: type: string - name: start_date in: query required: false schema: type: string format: date - name: end_date in: query required: false schema: type: string format: date - name: sort in: query required: false schema: type: string - name: sort_type in: query required: false schema: type: string - name: status in: query required: false schema: type: string - name: scheduled_date in: query required: false schema: type: string format: date - name: charge_id in: query required: false schema: type: string - name: customer_id in: query required: false schema: type: string - name: seller_id in: query required: false schema: type: string - name: payment_type in: query description: Tipo de pago. Delimitado por comas. schema: type: string enum: - credit_card - debit_card responses: "200": description: Solicitud ejecutada correctamente content: "*/*": schema: $ref: "#/components/schemas/PaymentResponse" "400": description: Solicitud no válida. content: "*/*": schema: $ref: "#/components/schemas/ErrorDetail" "401": description: Autenticación no válida. Compruebe sus credenciales o póngase en contacto con el Centro de Relaciones de Getnet. content: "*/*": schema: $ref: "#/components/schemas/ErrorDetail" "404": description: No se ha encontrado content: "*/*": schema: $ref: "#/components/schemas/ErrorDetail" "422": description: Entidad no procesable content: application/json: schema: $ref: "#/components/schemas/DefaultErrorHttpResponse" "500": description: Error interno del servidor. Vuelva a intentarlo más tarde. content: "*/*": schema: $ref: "#/components/schemas/ErrorDetail" "504": description: El servidor encontró un error temporal y no completó la solicitud. Vuelva a intentarlo más tarde. content: "*/*": schema: $ref: "#/components/schemas/ErrorDetail" security: - PROD: - digital-platform:gateway-api - PRE: - digital-platform:gateway-api - SBX: - digital-platform:gateway-api components: securitySchemes: PROD: type: oauth2 flows: clientCredentials: tokenUrl: https://api.globalgetnet.com/authentication/oauth2/access_token scopes: digital-platform:gateway-api: Read and write access PRE: type: oauth2 flows: clientCredentials: tokenUrl: https://api.pre.globalgetnet.com/authentication/oauth2/access_token scopes: digital-platform:gateway-api: Read and write access SBX: type: oauth2 flows: clientCredentials: tokenUrl: https://api-sbx.globalgetnet.com/authentication/oauth2/access_token scopes: digital-platform:gateway-api: Read and write access parameters: PaymentId: name: payment_id in: path description: ID de pago que se utilizará en la consulta required: true style: simple explode: false example: 44c1206c-fcfc-11ea-adc1-0242ac120002 schema: type: string format: uuid DigitalServiceID: name: digital-service-id in: query description: "Conjunto de servicios que se incluirán en la respuesta.

Los valores posibles son:
- ANTIFRAUD = Servicio antifraude que permite comprobar antifraude los pagos creados con una tarjeta
- CARD_VERIFICATION = servicio de verificación de tarjetas que se puede realizar antes de una transacción de pago para mejorar las tasas de autorización
- CHECKOUT = Servicio de pago que define la configuración de
pago de tu tienda web - PAYMENT = Servicio de pago que te permite utilizar la API de Checkout para crear pagos
- THREEDS = servicio 3DS que te permite autenticar a tus clientes mediante el
servicio 3DS - VAULT = Vault eso te permite para almacenar los métodos de pago de sus clientes
: TOKENIZACIÓN = Servicio de tokenización que le permite tokenizar los datos. Este servicio se utiliza principalmente para tokenizar los detalles del método de pago de un cliente.
- COMBINADO = Servicio de pago adicional además de «PAGO» que te permite crear pagos combinados" schema: type: array items: type: string enum: - ANTIFRAUD - VAULT - CARD_VERIFICATION - COMBINED - THREEDS - CHECKOUT - PAYMENT - TOKENIZATION IdempotencyKey: name: idempotency-key in: header description: Clave idempotente para la transacción.

Si se envía una solicitud idéntica varias veces, la clave garantiza que la respuesta esté siempre relacionada con el mismo pago (en lugar de crear varios pagos idénticos). schema: type: string format: uuidv4 example: fd23d518-e622-4744-bc1f-3870f23610de IdempotencyKeyPath: name: idempotency_key in: path description: Clave idempotente para la transacción.

Si se envía una solicitud idéntica varias veces, la clave garantiza que la respuesta esté siempre relacionada con el mismo pago (en lugar de crear varios pagos idénticos). required: true schema: type: string format: uuidv4 example: fd23d518-e622-4744-bc1f-3870f23610de XTransactionChannelEntry: name: x-transaction-channel-entry in: header description: Campo utilizado para identificar la plataforma que enviará la transacción

(el código a informar debe solicitarse previamente a GetNet) schema: type: string format: uuidv4 example: XX CardIDParam: name: card_id in: path description: ID de la tarjeta que se utilizará en la consulta example: e02200f0-ab41-11eb-bcbc-0242ac130002 required: true schema: type: string format: uuidv4 MethodIDParam: name: method_id in: path description: ID del método que se utilizará en la consulta example: e02200f0-ab41-11eb-bcbc-0242ac130002 required: true schema: type: string format: uuidv4 ExpirationPolicyParam: name: expiration-policy in: header description: "Política de caducidad de los tokens.

Los valores posibles son:
- caducidad = El token caduca a los 30 días
- sin caducidad = El token no caduca

El valor predeterminado es «caducidad»." required: false schema: type: string enum: - expiration - no-expiration PaymentIntentIDParam: name: payment_intent_id in: path description: ID de intención de pago que se utilizará en la consulta example: ee0b7dd5-92da-4ef4-ad3b-0ba369ad0efe required: true schema: type: string format: uuidv4 SellerID: name: seller_id in: path description: ID de vendedor que se utilizará en la consulta example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e required: true schema: type: string format: uuidv4 ServiceID: name: service_id in: path description: "ID de servicio que se utilizará en la consulta.

Los valores posibles son:
- ANTIFRAUD = Servicio antifraude que permite comprobar antifraude los pagos creados con una tarjeta
- CARD_VERIFICATION = servicio de verificación de tarjetas que se puede realizar antes de una transacción de pago para mejorar las tasas de autorización
- CHECKOUT = Servicio de pago que define la configuración de
pago de tu tienda web - PAYMENT = Servicio de pago que te permite utilizar la API de Checkout para crear pagos
- THREEDS = servicio 3DS que te permite autenticar a tus clientes mediante el
servicio 3DS - VAULT = Vault eso te permite para almacenar los métodos de pago de sus clientes
: TOKENIZACIÓN = Servicio de tokenización que le permite tokenizar los datos. Este servicio se utiliza principalmente para tokenizar los detalles del método de pago de un cliente.
- COMBINADO = Servicio de pago adicional además de «PAGO» que te permite crear pagos combinados" example: payments required: true schema: type: string enum: - ANTIFRAUD - CHECKOUT - PAYMENT - THREEDS - VAULT - CARD_VERIFICATION - TOKENIZATION - COMBINED UpdateServiceID: name: service_id in: path description: ID de servicio que se utilizará en la consulta example: PAYMENT required: true schema: type: string enum: - PAYMENT XTraceID: name: x-trace-id in: header description: Código enviado por la pasarela para rastrear la transacción. required: false schema: type: string example: c7a7e64d-6e42-4425-b123-3fb0afebca6e Country: name: country in: header required: false description: Identificador de país. schema: type: string default: BR Tenant: name: tenant in: header required: false description: Identificador de inquilino. schema: type: string default: santander CustomerID: name: customer_id in: query description: Identificador del comprador. Información definida por la aplicación que consume la API de la plataforma digital. required: true schema: type: string example: ec0e9f0b-d96f-405a-8e89-cb32f1da1841 Status: name: status in: query description: Filtro de estado para las tarjetas devueltas. Si no se le informa Sin filtro, se devolverán las tarjetas activas y renovadas. required: false schema: type: string enum: - all - active - renewed XByPassParameters: name: x-by-pass-parameters in: header description: Condición para no validar si el almacén de productos tiene parámetros habilitados. required: false schema: type: boolean example: false Authorization: name: Authorization in: header description: "Autorización: Portador *AuthString* Donde *authString*
es el token de acceso obtenido del punto final de autenticación." required: false schema: type: string PlanID: name: plan_id in: path description: Identificador del plan. required: true schema: type: string format: uuid OrderID: name: order_id in: query description: Código de identificación de compra utilizado en el comercio electrónico. required: false schema: type: string SubscriptionID: name: subscription_id in: query description: Identificador de la firma de registro. required: false schema: type: string format: uuid XQrCodeExpirationTime: name: x-qrcode-expiration-time in: header description: Es posible personalizar el tiempo de caducidad del código QR introduciendo el tiempo deseado en segundos. Si no se le informa, la operación se realizará con el valor predeterminado de 180 segundos. El valor máximo para el tiempo de caducidad es de 1800 s. schema: type: number default: "180" Username: name: username in: header description: Usuario que se está registrando. Esta información se puede utilizar con fines de auditoría. required: false schema: type: string examples: invalid_api_key: value: Invalid API Key invalid_api_token: value: Invalid Token vault_product_not_enabled: value: code: product_not_enabled message: Product is not enabled. details: [] transaction_expired: value: code: transaction_expired message: Transaction Expired details: [] invalid_token: value: code: invalid_token message: Invalid Token details: [] invalid_transaction_status: value: code: invalid_transaction_status message: Invalid Transaction Status details: [] transaction_not_found: value: code: transaction_not_found message: Transaction not found details: [] 3ds_product_is_not_enabled: value: code: product_is_not_enabled message: 3DS product not enabled details: [] mpi_error: value: code: mpi_error message: Message from provider details: [] token_not_found: value: code: token_not_found message: Token not found details: [] seller_not_found: value: code: seller_not_found message: Seller not found details: [] card_not_found: value: code: card_not_found message: Card not found details: [] product_not_enabled: value: code: product_not_enabled message: Product is not enabled details: [] payment_method_not_found: value: code: payment_method_not_found message: Payment method not found details: [] installment_quote_not_found: value: code: installment_quote_not_found message: Installment payment quote not found details: [] vault_product_is_not_enabled: value: code: product_is_not_enabled message: Vault product not enabled details: [] invalid_token_method_type: value: code: invalid_token_method_type message: Invalid token method type details: [] card_expiration_month_not_valid: value: code: card_expiration_not_valid message: Card expiration month not valid; it must be a future date details: [] card_expiration_year_not_valid: value: code: card_expiration_not_valid message: Card expiration year not valid; it must be a future date details: [] digital_service_not_found: value: code: digital_service_not_found message: Digital service not found details: [] payment_type_is_not_active: value: code: payment_type_is_not_active message: Payment type not active details: [] payment_brand_not_allowed: value: code: payment_brand_not_allowed message: The payment brand is not allowed to be used details: [] installment_number_not_supported: value: code: installment_number_not_supported message: Installment number not supported details: [] installment_type_not_available: value: code: installment_type_not_available message: Installment type not available details: [] installment_plan_not_contracted: value: code: installment_plan_not_contracted message: Installment plan not contracted details: [] installment_option_not_available: value: code: installment_option_not_available message: Installment option not available details: [] payment_does_not_exist: value: code: payment_does_not_exist message: Payment does not exist details: [] combined_payment_is_not_active: value: code: combined_payment_is_not_active message: Combined payment not active details: [] payment_amount_error: value: code: payment_amount_error message: Payment amount not the same as transaction amount details: [] cancelling_when_status_denied: value: code: invalid_status message: It's not possible to cancel a payment with status Denied details: [] cancelling_when_status_cancelled: value: code: invalid_status message: It's not possible to cancel a payment with status Cancelled details: [] refund_cancelled_and_mode_manual: value: code: invalid_status message: It's not possible to refund a payment with status Cancelled and capture_mode manual details: [] refund_denied_and_mode_manual: value: code: invalid_status message: It's not possible to refund a payment with status Denied and capture_mode manual details: [] refund_authorized_and_mode_manual: value: code: invalid_status message: It's not possible to refund a payment with status Authorized and capture_mode manual details: [] invalid_refund_amount: value: code: invalid_refund_amount message: The amount must be less than or equal to the original amount details: [] refund_already_completed: value: code: refund_already_completed message: The refund has already been completed details: [] capture_when_status_cancelled: value: code: invalid_status message: It's not possible to capture a payment with status Cancelled details: [] capture_when_status_denied: value: code: invalid_status message: It's not possible to capture a payment with status Denied details: [] invalid_capture_mode_to_capture: value: code: invalid_capture_mode message: It's not possible to capture a payment with capture_mode automatic details: [] checkout_product_not_enabled: value: code: product_is_not_enabled message: Checkout product not enabled details: [] amount_value_invalid: value: code: business_error message: Amount value must be greater than zero. details: [] checkout_configuration_not_found: value: code: checkout_configuration_not_found message: Checkout configuration not found. details: [] currency_not_allowed: value: code: currency_not_allowed message: Currency not allowed details: [] payment_intent_not_found: value: code: payment_intent_not_found message: Payment intent not found details: [] payment_intent_already_paid: value: code: payment_intent_already_paid message: Payment Intent has already been paid. details: [] payment_data_not_provided: value: code: payment_data_not_provided message: The `payment`.' parameter must be provided details: [] 3ds_not_enabled: value: code: 3ds_not_enabled message: 3DS is not enabled, `authentication` field is forbidden details: [] country_code_invalid_or_not_found: value: code: country_code_invalid_or_not_found message: country_code invalid or not found details: [] card_not_accepted: value: code: card_not_accepted message: Card not accepted for this operation, domestic interchange only details: [] bin_card_invalid: value: code: bin_card_invalid message: Bin card invalid for this operation details: [] bin_not_found: value: code: bin_not_found message: The Bin was not found details: [] request_installment_quote_with_one_plan: summary: La solicitud contiene 1 plan de pago a plazos description: La respuesta contiene cotizaciones de cuotas para un plan de pago único que consta de 6 cuotas sin intereses value: installment_schema: - plan_ahora installment_type: - no_interest number_installments: - 6 amount: 12000 bin: 60107000 request_installment_quote_with_many_plans: summary: La solicitud contiene varios planes de pago description: La respuesta contiene cotizaciones de 2 planes de cuotas que constan de 6 cuotas con intereses value: installment_schema: - plan_emisor - plan_emissor installment_type: - with_interest number_installments: - 6 amount: 12000 bin: 60107000 request_installment_quote_with_many_installments: summary: La solicitud contiene varias opciones para el número de cuotas description: La respuesta contiene cotizaciones de cuotas para un plan de pago único que consta de 3, 6, 9 o 12 cuotas sin intereses value: installment_schema: - plan_ahora installment_type: - no_interest number_installments: - 3 - 6 - 9 - 12 amount: 12000 bin: 60107000 InstallmentQuotesResponseAR: summary: Ejemplo de carga útil de respuesta a cotizaciones en cuotas para Argentina value: amount: 10000, options: - quote_id: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e schema: plan_ahora type: no_interest number: 2 installment_amount: "5000" total_amount: "10000" - quote_id: 506a9b69-2fd0-4ec2-bdff-e34ddfc21512 schema: plan_ahora type: no_interest number: 2 installment_amount: "5000" total_amount: "10000" InstallmentQuotesResponseCL: summary: Ejemplo de carga útil de respuesta a una cotización en cuotas para Chile value: amount: 10000, options: - quote_id: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e schema: plan_emisor type: no_interest number: 2 installment_amount: "5000" total_amount: "10000" - quote_id: 506a9b69-2fd0-4ec2-bdff-e34ddfc21512 schema: plan_emisor type: no_interest number: 2 installment_amount: "5000" total_amount: "10000" InstallmentQuotesResponseUY: summary: Ejemplo de carga útil de respuesta a una cotización en cuotas para Uruguay value: options: - schema: Q type: "00" number: 2 code: "00" - schema: Q type: "00" number: 3 code: "00" schemas: payment: title: pago type: object properties: payment_method: $ref: "#/components/schemas/payment_method" save_card_data: type: boolean example: false default: false description: Determina si la tarjeta debe guardarse para compras futuras. Solo para clientes que utilizan la bóveda de GetNet. transaction_type: type: string description: Tipo de transacción. Pago en efectivo o en cuotas al minorista o en cuotas al emisor. example: FULL enum: - FULL - INSTALL_NO_INTEREST - INSTALL_WITH_INTEREST number_installments: type: number example: 1 description: Número de cuotas. soft_descriptor: $ref: "#/components/schemas/soft_descriptor" dynamic_mcc: type: number example: 1234 description: Campo utilizado para indicar la transacción con otro código de categoría de comerciante (código de categoría de establecimiento) diferente del registrado. Si se envía un MCC no válido, se utilizará el predeterminado. Envía solo datos numéricos. card: type: object description: Conjunto de datos de la tarjeta. required: - number - brand - expiration_month - expiration_year properties: number: type: string maxLength: 23 example: "517" description: Número de tarjeta enmascarado. brand: $ref: "#/components/schemas/brand" expiration_month: type: string minLength: 2 maxLength: 2 example: "09" description: Mes de caducidad de la tarjeta. expiration_year: type: string example: "30" minLength: 2 maxLength: 2 description: Año de caducidad de la tarjeta cardholder_name: type: string example: Roland Deschain maxLength: 26 description: |- El nombre del portador está impreso en la tarjeta. Campo obligatorio para usar la lucha contra el fraude required: - payment_method - amount - transaction_type - number_installments - card seller_id: title: id_vendedor type: string example: 9406df6c-3100-49ba-b4df-d81c1ad8a62b minLength: 36 maxLength: 36 format: uuid description: Código de identificación de comercio electrónico request_id: title: id_de solicitud type: string example: daac03dc-73db-453f-9bea-b1391669d5d3 minLength: 36 maxLength: 36 format: uuid description: Identificador de solicitud. Único para cada solicitud payment_id: title: id_de pago type: string description: Identificador de pago example: 2c341d28-491b-4cf8-aec7-eeb60136b7a5 format: uuid minLength: 36 maxLength: 36 order_id: title: id_pedido type: string example: ORDER-10187383 description: Código de identificación de compra utilizado por el comercio electrónico (código o número de pedido). amount: type: number title: cantidad description: Valor de compra en centavos example: 8900 currency: title: divisa type: string example: BRL description: Identificación de la moneda (consulte el código en esta sección). received_at: title: recibido_en type: string example: 2020-06-30T18:32:51.222Z description: Fecha de la transacción transaction_id: title: id_de transacción type: string example: "3729756321501820" description: Identificador de transacción generado por la plataforma de comercio electrónico authorized_at: title: autorizado_en type: string example: 2020-06-30T18:32:51.815Z description: Fecha de autorización de la transacción acquirer: title: comprador type: string example: GETNET description: Adquirente. default: GETNET soft_descriptor: title: descriptor_suave type: string example: MEUECOMM*ORDER10187383 description: Texto que aparece en la factura de la tarjeta del comprador. Este campo es opcional, si no se introduce nada, se considerará el nombre comercial registrado en el establecimiento. En este campo solo se permiten datos alfanuméricos y los siguientes caracteres especiales:% $,./& () + = < > - * Los espacios se sustituirán por el carácter '*'. La transacción no se rechazará si se envían caracteres no permitidos. No se tendrá en cuenta ninguna información que supere el tamaño máximo. brand: title: marca type: string example: VISA enum: - MASTERCARD - VISA - AMEX - ELO - HIPERCARD maxLength: 50 description: >- Un caminante barbudo. La API lo rellena automáticamente si no se le informa. Campo obligatorio para usar la lucha contra el fraude authorization_code: title: código_de autorización type: string example: "017060" minLength: 6 maxLength: 6 description: Código de autorización generado por el emisor cuando la transacción se realiza correctamente acquirer_transaction_id: title: id_de_transacción del adquirente type: string example: "000152147981" description: NSU de la transacción de GetNet (adquirente) eci: title: eci type: string description: >- Código que indica si la transacción se procesó con Bearer Authentication. 00, 01 y 02 para Mastercard y 05, 06 y 07 para Visa y otras marcas example: "07" minLength: 2 maxLength: 2 total_installment_amount: title: importe total de la cuota example: 8900 type: number description: En el caso de las transacciones a plazos, contiene el importe total a pagar (importe más intereses, impuestos, tasas, etc.). first_installment_amount: title: primer importe de la cuota example: 1485 type: number description: Para las transacciones en cuotas, contiene el valor de la primera cuota que se va a pagar. other_installment_amount: title: otro importe de la cuota type: number example: 1483 description: Para las transacciones en cuotas, contiene el valor de las cuotas restantes por pagar. payment_method: title: método_pago type: string example: CREDIT enum: - CREDIT - DEBIT - CREDIT_AUTHORIZATION - CREDIT_PRE_AUTHORIZATION description: Método de pago, debe ser igual a la autorización status: type: string example: APPROVED description: Estado de la transacción enum: - APPROVED - DENIED - ERROR - ACCEPTED idempotency_key: type: string title: idempotency_key format: (a-Z | 0-9 | .-_) example: 63c7f8ee-51a6-470d-bb76-ef762b62bfb7 minLength: 1 maxLength: 64 description: La clave de idempotencia, utilizada para controlar las solicitudes, debe ser única por solicitud, ya que si se repite, siempre se devolverán los mismos datos. reason_code: title: código_motivo type: string minLength: 2 maxLength: 2 example: "00" description: Código de devolución del remitente o del sistema de captura getnet. reason_message: title: razón_mensaje type: string example: TRANSACTION EXECUTED SUCCESSFULLY description: Devuelve el mensaje del remitente o del sistema de captura getnet. custom_key: title: clave_personalizada type: string minLength: 3 maxLength: 32 example: 20200630-8900 description: Clave de cliente utilizada para identificar una solicitud de cancelación. (La clave debe ser única por transacción). customer_id: type: string description: Identificador de comprador utilizado en el comercio electrónico. Tenga en cuenta que se incluirá en la notificación de pago de PIX. maxLength: 36 plan_id: description: Identificador del plan de recurrencia. type: string minLength: 36 maxLength: 36 format: uuidv4 example: 51995e24-b1ae-4826-8e15-2a568a87abdd md: type: string description: ID definido por el vendedor para identificar la respuesta de inscripción example: NmQyZTQzODAtZDhhMy00Y2NiLTkxMzgtYzI4OTE4MjgxOGE0 tx_id: type: integer description: ID de transacción utilizado por el proveedor de 3DS example: 9349151 xid: type: string description: >- ID de transacción devuelto por el emisor de la tarjeta. El valor es de 28 bytes (un valor único de 20 bytes codificado en Base64). example: VDdnR0kyU1g4ZXlxMkhWTlp0VnA= status3DS: $ref: "#/components/schemas/StatusTransaction" protocol: type: string description: Protocolo 3DS utilizado durante el procesamiento example: 3DS2.2.0 operation: type: string description: Tipo de operación de tarjeta example: CREDIT enum: - CREDIT - DEBIT default: CREDIT cavv: type: string description: >- Token único devuelto por el emisor de la tarjeta que indica que la transacción se ha autenticado. El valor es el valor de verificación de la autenticación del titular de la tarjeta (CAVV) para las tarjetas Visa y el valor de autenticación de la cuenta (AAV) para las tarjetas Mastercard. example: "2" ds_trans_id: description: ID de transacción del servidor de directorios único. Solo se aplica cuando el valor del «protocolo» es «3DS2.2.0» y la marca de la tarjeta es Mastercard. type: string format: uuid example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 redirect_html_template: type: string description: Plantilla HTML para redirigir al cliente al flujo de autenticación del emisor de la tarjeta example: | 3D Secure Processing

3D Secure Processing

requestPayment: type: object title: Solicitar pago properties: idempotency_key: $ref: "#/components/schemas/idempotency_key" request_id: $ref: "#/components/schemas/request_id" order_id: $ref: "#/components/schemas/order_id" data: type: object description: Conjunto de datos que se va a cifrar required: - payment properties: amount: $ref: "#/components/schemas/amount" currency: $ref: "#/components/schemas/currency" customer_id: type: string maxLength: 100 description: Identificador del comprador example: 6df370e7-8f97-4e7a-a36e-16ad2db6c5fc payment: $ref: "#/components/schemas/payment" sub_merchant: $ref: "#/components/schemas/SubMerchantDTO" additional_data: type: object required: - idempotency_key - order_id - data requestCapture: type: object properties: idempotency_key: $ref: "#/components/schemas/idempotency_key" payment_id: $ref: "#/components/schemas/payment_id" amount: type: number example: 8900 description: Valor igual o inferior a la transacción original en centavos required: - payment_id - payment_method - idempotency_key title: Captura de solicitudes requestCancel: type: object properties: idempotency_key: $ref: "#/components/schemas/idempotency_key" request_id: $ref: "#/components/schemas/request_id" payment_id: $ref: "#/components/schemas/payment_id" payment_method: $ref: "#/components/schemas/payment_method" amount: type: number example: 8900 description: Valor igual o inferior al de la transacción original. Úselo únicamente en caso de cancelaciones parciales en D+N. Si no se informa, se tendrá en cuenta el valor de la transacción original. custom_key: $ref: "#/components/schemas/custom_key" required: - payment_id - payment_method - custom_key - idempotency_key title: Solicitar cancelación paymentAuthorizationResponse: title: Respuesta de autorización de pago type: object description: Conjunto de datos de respuesta a la autorización de properties: idempotency_key: $ref: "#/components/schemas/idempotency_key" seller_id: $ref: "#/components/schemas/seller_id" request_id: $ref: "#/components/schemas/request_id" payment_id: $ref: "#/components/schemas/payment_id" order_id: $ref: "#/components/schemas/order_id" amount: $ref: "#/components/schemas/amount" currency: $ref: "#/components/schemas/currency" status: type: string example: AUTHORIZED description: Estado de la transacción payment_method: type: string example: CREDIT_AUTHORIZATION description: Método de pago enum: - CREDIT_AUTHORIZATION received_at: $ref: "#/components/schemas/received_at" transaction_id: $ref: "#/components/schemas/transaction_id" original_transaction_id: type: string example: "-1" description: Identificador de transacción original authorized_at: $ref: "#/components/schemas/authorized_at" reason_code: $ref: "#/components/schemas/reason_code" reason_message: $ref: "#/components/schemas/reason_message" acquirer: $ref: "#/components/schemas/acquirer" soft_descriptor: $ref: "#/components/schemas/soft_descriptor" brand: $ref: "#/components/schemas/brand" authorization_code: $ref: "#/components/schemas/authorization_code" acquirer_transaction_id: $ref: "#/components/schemas/acquirer_transaction_id" eci: $ref: "#/components/schemas/eci" total_installment_amount: $ref: "#/components/schemas/total_installment_amount" first_installment_amount: $ref: "#/components/schemas/first_installment_amount" other_installment_amount: $ref: "#/components/schemas/other_installment_amount" record: title: Objeto de registro type: object description: "" properties: rel: $ref: "#/components/schemas/rel" registered_at: $ref: "#/components/schemas/registered_at" idempotency_key: $ref: "#/components/schemas/idempotency_key" href: type: string format: uri description: URI para consultar un componente relacionado con el artículo. requestQRCode: title: Solicitar datos de código QR type: object description: Conjunto de datos de solicitud de código QR properties: idempotency_key: $ref: "#/components/schemas/idempotency_key" request_id: $ref: "#/components/schemas/request_id" order_id: $ref: "#/components/schemas/order_id" amount: $ref: "#/components/schemas/amount" currency: $ref: "#/components/schemas/currency" transaction_type: type: string description: Tipo de transacción. Pago completo, en cuotas sin intereses, pagado en cuotas con intereses. (para Uruguay solo se acepta el pago COMPLETO) example: NO_INTEREST enum: - NO_INTEREST - WITH_INTEREST payment_method: type: string example: PURCHASE description: Método de pago enum: - PURCHASE - INVOICE - COLLECTION serial_number: type: string example: CL00027L description: Número de serie de la transacción payment_id: $ref: "#/components/schemas/payment_id" additional_data: type: object description: Datos adicionales de código QR properties: fee: type: object properties: range_acquirer: type: string example: "0101" range_issuer: type: string example: "0101" responseQRCode: title: Datos de código QR de respuesta type: object description: Conjunto de datos de respuesta de código QR properties: idempotency_key: $ref: "#/components/schemas/idempotency_key" seller_id: $ref: "#/components/schemas/request_id" request_id: $ref: "#/components/schemas/request_id" payment_id: $ref: "#/components/schemas/payment_id" order_id: $ref: "#/components/schemas/order_id" amount: $ref: "#/components/schemas/amount" currency: $ref: "#/components/schemas/currency" status: $ref: "#/components/schemas/status" reason_code: $ref: "#/components/schemas/reason_code" reason_message: $ref: "#/components/schemas/reason_message" additional_data: type: object description: Datos adicionales de código QR properties: transaction_id: $ref: "#/components/schemas/transaction_id" creation_date_qrcode: title: Código QR de fecha y hora type: string format: date-time example: 2011-10-05T14:48:00.000Z description: Fecha y hora de registro. expiration_date_qrcode: title: Fecha y hora de caducidad type: string format: date-time example: 2011-10-05T14:48:00.000Z description: Fecha y hora de registro. third_party_qr_code_id: type: string example: 61260970G description: El qr_code_id generado y utilizado por el proveedor externo third_party_order_id: type: string example: 61260970G description: El order_id generado y utilizado por el proveedor externo qr_code_emv_type: type: string example: dynamic description: El tipo de qr_code creado puede ser estático o dinámico enum: - static - dynamic qr_code: type: string example: 00020101021241260009cl.getnet980976059703152040000530315254061287005802CL5909UNDEFINED6009UNDEFINED99200016ZEUAJJGK612609706304785E description: La cadena emv del código qr generada paymentCancelResponse: title: Respuesta de cancelación de pago type: object properties: idempotency_key: $ref: "#/components/schemas/idempotency_key" seller_id: $ref: "#/components/schemas/seller_id" request_id: $ref: "#/components/schemas/request_id" payment_id: $ref: "#/components/schemas/payment_id" order_id: $ref: "#/components/schemas/order_id" amount: $ref: "#/components/schemas/amount" currency: $ref: "#/components/schemas/currency" status: type: string example: CANCELED description: Estado de la transacción canceled_at: type: string example: 2020-07-01T02:15:03.603Z description: Fecha de cancelación reason_code: $ref: "#/components/schemas/reason_code" reason_message: $ref: "#/components/schemas/reason_message" custom_key: $ref: "#/components/schemas/custom_key" protocol: $ref: "#/components/schemas/protocol" x-examples: {} paymentCaptureResponse: title: Respuesta de captura de pagos type: object properties: idempotency_key: $ref: "#/components/schemas/idempotency_key" seller_id: $ref: "#/components/schemas/seller_id" payment_id: $ref: "#/components/schemas/payment_id" order_id: $ref: "#/components/schemas/order_id" amount: $ref: "#/components/schemas/amount" currency: $ref: "#/components/schemas/currency" status: type: string example: CAPTURED description: Estado de la transacción reason_code: $ref: "#/components/schemas/reason_code" reason_message: $ref: "#/components/schemas/reason_message" captured_at: type: string example: 2020-06-30T22:33:41.172 description: Fecha de captura. paymentPurchaseResponse: title: Respuesta de pago y compra type: object description: Conjunto de datos de respuestas de crédito y débito. x-examples: {} properties: idempotency_key: $ref: "#/components/schemas/idempotency_key" seller_id: $ref: "#/components/schemas/seller_id" request_id: $ref: "#/components/schemas/request_id" payment_id: $ref: "#/components/schemas/payment_id" order_id: $ref: "#/components/schemas/order_id" amount: $ref: "#/components/schemas/amount" currency: $ref: "#/components/schemas/currency" status: type: string example: APPROVED description: Estado de la transacción enum: - APPROVED - AUTHORIZED - DENIED payment_method: type: string example: CREDIT description: Método de pago enum: - CREDIT - DEBIT - CREDIT_AUTHORIZATION received_at: $ref: "#/components/schemas/received_at" transaction_id: $ref: "#/components/schemas/transaction_id" original_transaction_id: type: string example: "6534812321501821" description: Identificador de transacción original authorized_at: $ref: "#/components/schemas/authorized_at" reason_code: $ref: "#/components/schemas/reason_code" reason_message: $ref: "#/components/schemas/reason_message" acquirer: $ref: "#/components/schemas/acquirer" soft_descriptor: $ref: "#/components/schemas/soft_descriptor" brand: $ref: "#/components/schemas/brand" authorization_code: $ref: "#/components/schemas/authorization_code" acquirer_transaction_id: $ref: "#/components/schemas/acquirer_transaction_id" eci: $ref: "#/components/schemas/eci" total_installment_amount: $ref: "#/components/schemas/total_installment_amount" first_installment_amount: $ref: "#/components/schemas/first_installment_amount" other_installment_amount: $ref: "#/components/schemas/other_installment_amount" cancelResult: title: Cancelar resultado type: object properties: payment_id: $ref: "#/components/schemas/payment_id" protocol: $ref: "#/components/schemas/protocol" authorization_code: $ref: "#/components/schemas/authorization_code" acquirer_transaction_id: $ref: "#/components/schemas/acquirer_transaction_id" currency: $ref: "#/components/schemas/currency" amount: $ref: "#/components/schemas/amount" status_processing_cancel_code: type: string description: Código de estado de la solicitud de cancelación. status_processing_cancel_message: type: string description: Mensaje de estado de la solicitud de cancelación. protocol3DS: title: protocolo type: string example: "202006302344230001" description: Protocolo de cancelación registered_at: title: registrado_en type: string format: date-time example: 2011-10-05T14:48:00.000Z description: Fecha y hora de registro. rel: title: relé type: string example: AUTHORIZATION enum: - AUTHORIZATION - CANCEL - CAPTURE - PURCHASE description: Relación del artículo con el pago. notFound: title: No se ha encontrado type: object properties: message: type: string example: Not Found description: Mensaje de error name: type: string example: GatewayTokenizationServiceError description: Módulo o servicio que devolvió el error status_code: type: number example: 404 description: Código de estado HTTP details: type: array description: Detalles del error items: type: object properties: status: type: string example: DENIED description: Estado error_code: type: string example: TOKENIZATION-404 description: Código de error payment_id: title: id_de pago type: string description: Identificador de pago example: 2c341d28-491b-4cf8-aec7-eeb60136b7a5 format: uuid minLength: 36 maxLength: 36 description: type: string example: Not Found description: Descripción breve del error description_detail: type: string description: Descripción detallada del error example: Not found number_token, verify or renew your number_token or seller_id. badRequest: title: Solicitud incorrecta type: object properties: message: type: string example: Bad Request description: Mensaje de error name: type: string example: GatewayPaymentServiceError description: Módulo o servicio que devolvió el error status_code: type: number example: 400 description: Código de estado HTTP details: type: array description: Detalles del error items: type: object properties: status: type: string example: DENIED description: Estado error_code: type: string example: GENERIC-400 description: Código de error payment_id: title: id_de pago type: string description: Identificador de pago example: 2c341d28-491b-4cf8-aec7-eeb60136b7a5 format: uuid minLength: 36 maxLength: 36 description: type: string example: payment_method is invalid description: Descripción breve del error description_detail: type: string example: The payment_method attribute is required. Please check your request and try again description: Descripción detallada del error internalServerError: title: Error interno del servidor type: object properties: message: type: string example: Internal Server Error description: Mensaje de error name: type: string example: GatewayRouterHTTPServicesError description: Módulo o servicio que devolvió el error status_code: type: number example: 500 description: Código de estado HTTP details: type: array description: Detalles del error items: type: object properties: status: type: string example: ERROR description: Estado error_code: type: string example: GENERIC-500 description: Código de error description: type: string example: Internal Server Error description: Descripción breve del error description_detail: type: string description: Descripción detallada del error example: The server encountered an unexpected error CreditCancel: type: object properties: canceled_at: type: string description: Cancelado en. message: type: string description: mensaje. description: cancelar_crédito. DefaultErrorHttpResponse: type: object properties: message: maxLength: 250 type: string description: Mensaje de error detallado. name: maxLength: 250 type: string description: Nombre del módulo o sistema en el que se produjo el error. status_code: type: integer description: Código de estado HTTP del error. format: int32 details: type: array description: Detalles del error. items: $ref: "#/components/schemas/ErrorDetail" payments: type: array description: Detalles del error. items: $ref: "#/components/schemas/ErrorDetail" combined_id: type: string description: ID combinado. order_id: type: string description: ID del pedido. seller_id: type: string description: ID de vendedor. ErrorDetail: type: object properties: status: type: string description: Situación de error. error_code: type: string description: Código de error. description: type: string description: Descripción del error. description_detail: type: string description: Descripción detallada del error. brand: type: string description: Marca. payment_id: type: string description: id_de pago. seller_id: type: string description: id_vendedor. amount: type: string description: cantidad. currency: type: string description: moneda. order_id: type: string description: id_pedido. credit_cancel: $ref: "#/components/schemas/CreditCancel" payment_tag: type: string description: etiqueta de pago. status_code: type: string description: Código de estado. message: type: string description: mensaje. name: type: string description: nombre. acquirer_transaction_id: type: string description: id_de_transacción del adquirente. authorization_code: type: string description: código_de autorización. transaction_id: type: string description: id_de transacción. reason_code: type: string description: código_motivo. reason_message: type: string description: razón_mensaje. merchant_advice_code: type: string description: código_de_consejería para comerciantes. description: Los detalles del error. OrderItemReleaseDTO: type: object properties: id: type: string amount: type: integer format: int32 ReleaseDTO: type: object properties: release_payment_date: type: string subseller_id: type: string order_item_release: $ref: "#/components/schemas/OrderItemReleaseDTO" AddressDTO: type: object properties: street: type: string number: type: string complement: type: string district: type: string city: type: string state: type: string country: type: string postal_code: type: string CardDTO: type: object required: - expiration_month - expiration_year - cardholder_name properties: number: type: string description: Para **Tarjeta no presente**, envía el número de la tarjeta (solo se envía cuando no se envía el campo `number_token`).

Para **Tarjeta presente**, envía el número de la tarjeta.
Este elemento es obligatorio si el valor de `entry_mode` es `manual` o `manual_with_pass`.
Puedes encontrar las tarjetas de prueba aquí. maxLength: 36 example: "4013790001234569" expiration_month: type: string description: Mes de caducidad de la tarjeta de dos dígitos. maxLength: 2 example: 9 expiration_year: type: string description: Año de caducidad de la tarjeta de dos dígitos. maxLength: 2 example: 30 cardholder_name: type: string description: Nombre del comprador impreso en la tarjeta.
Campo obligatorio para Antifraude maxLength: 26 example: Roland Deschain security_code: type: string description: Código de seguridad. CVV o CVC
. Campo obligatorio para Antifraude minLength: 3 maxLength: 4 example: 517 brand: type: string description: Bandera de cartas. La API lo rellena automáticamente si no se le informa.
Campo obligatorio para Antifraude enum: - MASTERCARD - VISA - AMEX - ELO - HIPERCARD maxLength: 50 example: Visa number_token: type: string description: Número de tarjeta tokenizado (se envía solo cuando no se envía el campo numérico). maxLength: 128 minLength: 128 example: e71084449bc70e344f77d4c382704ea2868b5e9775dced7ffcd40b3f66b167f51e352a2f289b518a11180c81478dfbdbeffd8a41f0b34564f2f0e41be8a88e11 entry_mode: type: string description: "Para el modo ***Card Present*** de entrada con tarjeta.\r \r Los valores `card_on_file` y `recurring` se aplican únicamente cuando el valor de `transaction_channel_type` es `recurrent`." seq_number: type: string description: Para ***Tarjeta de presentación*** pin_block: type: string description: "Para ***Card Present***: bloque de PIN. Un bloque de PIN consiste en el PIN introducido por el titular de la tarjeta, que ha sido cifrado mediante un teclado PIN.\r \r Este elemento es obligatorio en los países en los que la validación del PIN en línea es obligatoria para los pagos con tarjeta. El valor se almacena en el módulo de seguridad de hardware (HSM)." example: A0B6BA8D53C8D3C3 pin_key_id: type: string description: Para ***Tarjeta de presentación*** ksn: type: string description: "Para ***Tarjeta de presentación***: KSN (número de serie clave). El valor es la clave de proceso DUKPT (clave única derivada por transacción) concatenada con el contador de transacciones.\r \r Este elemento es obligatorio en los países en los que la validación del PIN en línea es obligatoria para los pagos con tarjeta.\r \r El valor debe estar en formato ASCII con 20 dígitos hexadecimales alineados a la izquierda con los espacios finales." example: BC756011020000400001 emv: type: string description: "Para ***Card Present***: datos de etiquetas EMV recopilados de la ICC (tarjeta de circuito integrado). Este elemento es obligatorio si el valor de `entry_mode` es `chip` o `chip_contactless`.\r \r Los datos deben estar en formato TLV.\r \r Para obtener una lista de todas las etiquetas EMV y si son obligatorias, consulte el documento «etiquetas EMV»." example: 6F1A840E315041592E5359532E4444463031A5088801025F2D02656E aid: maxLength: 255 type: string description: Para ***Tarjeta de presentación*** cardholder_verification_method: type: string description: Para ***Tarjeta de presentación*** enum: - offline_pin - online_pin - signature - no_cvm - fail_cvm_processing aggregator: type: string description: Para ***Tarjeta de presentación*** enum: - siscard service_code: $ref: "#/components/schemas/ServiceCodeDTO" track_1: type: string description: "Para ***Card Present***: datos de Track 1, tal como se define en la norma ISO 7813.\r \r Este elemento es obligatorio cuando se omite `track_2` y el valor de `entry_mode` no es `manual` o `manual_with_pass`.\r \r El sistema ignora este elemento si el valor de `transaction_channel_type` es `digital`, `mail_order` o `telephone_order`." example: "%B1234567890123445^PADILLA/L. ^99011X100000*000000000XXX000000?*" track_2: type: string description: "Para ***Card Present***: datos de Track 2, tal como se definen en la norma ISO 7813.\r \r Este elemento es obligatorio cuando se omite `track_1` y el valor de `entry_mode` no es `manual` o `manual_with_pass`.\r \r El sistema ignora este elemento si el valor de `transaction_channel_type` es `digital`, `mail_order` o `telephone_order`." example: 4013790001234569=301220111379456001 description: Conjunto de datos de la tarjeta. ServiceCodeDTO: type: object properties: interchange: type: string enum: - international - national_only - not_available chip: type: boolean authorization_process: type: string enum: - normal_rules - by_issuer_online pin_required: type: string enum: - required - not_required - when_feasible range_of_services: type: string enum: - no_restrictions - goods_services - atm - cash description: Para ***Tarjeta de presentación*** CustomerDTOSubs: type: object description: Conjunto de datos del comprador. required: - seller_id - first_name - last_name - document_type - document_number properties: seller_id: $ref: "#/components/schemas/seller_id" customer_id: $ref: "#/components/schemas/customer_id" first_name: description: Nombre del comprador. type: string maxLength: 40 example: John last_name: description: Apellido del comprador. type: string maxLength: 80 example: da Silva document_type: description: Tipo de documento del comprador. type: string enum: - CPF - CNPJ - DNI_AR - CUIL - CUIT - RUT - CI_CL - MX_CURP - MX_RFC x-enumDescriptions: CPF: Cadastro de Pessoa Física (BR) CNPJ: Cadastro Nacional de Pessoa Jurídica (BR) DNI_AR: Documento Nacional de Identidad (AR) CUIL: Código Único de Identificación Laboral (AR) CUIT: Código Único de Identificación Tributaria (AR) RUT: Rol Único Tributário (CL) CI_CL: Cédula de Identidad (CL) MX_CURP: Clave Única de Registro de Población (MX) MX_RFC: Registro Federal de Contribuyentes (MX) example: CPF document_number: description: Número de documento del comprador. (sin máscara) type: string minLength: 11 maxLength: 15 example: "12345678912" birth_date: description: Fecha de nacimiento del comprador. type: string format: YYYY-MM-DD example: 1976-02-21 minLength: 10 maxLength: 10 phone_number: description: Número de teléfono del comprador. (sin máscara) type: string maxLength: 15 example: "5551999887766" cellphone_number: description: Número de teléfono móvil del comprador. (sin máscara) type: string example: "5551999887766" maxLength: 15 email: description: Correo electrónico del comprador. type: string format: email example: customer@email.com.br observation: description: Notas. type: string example: The customer is interested in plan x. address: $ref: "#/components/schemas/Address" CustomerDTO: description: Conjunto de datos referentes al comprador. properties: first_name: type: string description: Nombre del comprador.
Campo obligatorio para la lucha contra el fraude maxLength: 40 example: John last_name: type: string description: Apellido del comprador.
Campo obligatorio para la lucha contra el fraude maxLength: 80 example: da Silva name: maxLength: 40 type: string description: Nombre completo del comprador. Necesario para el billete. example: João da Silva document_type: type: string description: Tipo de documento de identificación del comprador. Obligatorio para el boleto.

Aquí puedes encontrar los tipos de documentos iniciales.

Campo obligatorio para la lucha contra el fraude maxLength: 26 example: CPF enum: - CPF - CNPJ document_number: type: string description: Número de documento del comprador sin signos de puntuación.
(sin máscara) Campo obligatorio para la lucha contra el fraude minLength: 11 maxLength: 15 example: "12345678912" email: type: string description: Correo electrónico del comprador.
Campo obligatorio para la lucha contra el fraude format: email example: customer@email.com.br phone_number: type: string description: Teléfono del comprador. (sin máscara)
Campo obligatorio para la lucha contra el fraude maxLength: 15 example: "5551999887766" billing_address: $ref: "#/components/schemas/Address" InternalDTO: type: object properties: parameters: type: object additionalProperties: type: object card_brand: type: string recurring: $ref: "#/components/schemas/RecurringDTO" OrderPaymentDTO: type: object properties: items: type: array items: type: object properties: name: type: string description: "" example: Product name quantity: type: string description: "" example: 1 sku: type: string description: "" example: Product identifier price: type: string description: "" example: 412 OrderDTO: required: - order_id type: object properties: order_id: maxLength: 36 type: string description: Código de identificación de compra utilizado por el comercio electrónico example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 sales_tax: type: number description: Valor impositivo en porcentaje. example: 12 product_type: type: string description: Identificador del tipo de producto vendido entre las opciones example: service enum: - cash_carry - digital_content - digital_goods - digital_physical - gift_card - physical_goods - renew_subs - shareware - service description: Conjunto de datos para identificar la compra InstallmentCuotesDTO: description: Consulte la documentación para ver las cuotas. type: object required: - schema properties: quote_id: description: ID de cotización que se utilizará en la consulta.
Necesario para AR y CL example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e type: string schema: type: string description: Código que agrupa los créditos por categoría. example: plan_ahora type: type: string description: Identificador que representa el tipo de crédito. Obligatorio para UY example: "00" code: type: string description: Código único asociado al crédito específico.
Obligatorio para UY example: "00" number: type: number description: Número de cuotas disponibles para el crédito. Obligatorio para UY example: 2 RecurringDTO: type: object properties: payments_identification: type: string sequence: type: string billing_period: type: string transaction_identifier: type: string SubMerchantDTO: type: object description: Para que Getnet cumpla con las reglas de las Banderas y Acuerdos, las Leyes Federales y las determinaciones del BACEN (Banco Central de Brasil) para la identificación de las entidades finales (subcomercios) que realizan las transacciones financieras, los Facilitadores de Pagos deben enviar los datos de identificación de sus clientes con cada transacción enviada a Getnet. required: - identification_code - document_type - document_number - address - city - state - postal_code - business_name properties: business_name: type: string description: Nombre del destinatario o nombre de la empresa de la subempresa. example: Company Ltd foreign_type: type: string maxLength: 1 description: "Hay 3 tipos de subcomerciantes, que se describen a continuación:
**F: Totalmente extranjero: ** Todos los subcomerciantes son internacionales.
**P: Parcialmente extranjero: ** Carrito mixto con subvendedores nacionales e internacionales.
**D: Totalmente nacional: ** Todos los subcomerciantes son nacionales." example: F, P or D identification_code: type: string description: ID de subcomercio maxLength: 15 example: 9058345 document_type: type: string description: "Documento secundario: CNPJ, RUT, CUIT, RFC" example: CNPJ document_number: type: string description: Número de documento legal de subcomercio. example: 77415914000148 address: type: string description: Dirección de subcomercio. (No se permiten comas) example: Dark Tower, 207 city: type: string description: Ciudad del subcomercio. example: Sao Paulo state: type: string description: Estado de subcomercio. example: SP postal_code: type: string description: Código postal de subcomercio (sin máscara). example: 90520000 TokenizationDTO: type: object required: - type - cryptogram properties: type: type: string description: tipo de tokenización example: TAVV enum: - UCAF - TAVV cryptogram: type: string description: Valor del criptograma generado por el TSP (Token Service Provider) example: "0006010865799300000620111679930000000000" eci: type: string description: Indicador ECI (indicador de comercio electrónico) example: "00" requestor_id: type: string description: Indica el identificador del solicitante del token. example: 1234567 description: "Tipo de criptograma utilizado por el TSP (Token Service Provider). Los valores pueden ser: TAVV para tarjetas Visa y ELO; - UCAF para tarjetas de la marca Mastercard." ReceiverDTO: type: object properties: account_number: type: string account_type: type: string first_name: type: string middle_name: type: string last_name: type: string addr_street: type: string addr_city: type: string addr_state: type: string addr_country: type: string addr_postal_code: type: string nationality: type: string phone: type: string date_of_birth: type: string id_type: type: string id_num: type: string FundTransferDTO: type: object properties: pay_action: type: string receiver: $ref: "#/components/schemas/ReceiverDTO" WalletCreditDTO: type: object description: >-

Campos para el cumplimiento de las normas de monedero digital del acuerdo SDWO (operador de monedero digital por etapas). El modelo se basa en monederos digitales (monederos) que acreditan a los comerciantes para que acepten sus medios de pago, de forma similar al modelo de facilitadores de pagos. En cuanto a la liquidación, los importes de los pagos efectuados a través de los monederos se envían al monedero de la CE y, en segundo lugar, los transfiere a sus suboperaciones finales. En la actualidad, el modelo está estructurado para Visa, Mastercard y Elo. Las transacciones de una billetera digital escalada (SDWO) tienen básicamente dos modelos: entrada de

efectivo: transacción marcada que no está vinculada a una compra: recarga de los fondos de la billetera con una
tarjeta. Por ejemplo

: recargar

Transferir al saldo de otra persona mediante una tarjeta

Compra (también conocida como «forma consecutiva»):
se paga con el código QR impreso o con la tarjeta del propietario del monedero. Ej.

Pago en línea a través del área de inicio de sesión del monedero con una tarjeta Para las transacciones en efectivo, además de rellenar las etiquetas de los subgrupos de monederos

, también es necesario enviar los campos dynamic_mcc y soft_descriptor presentes en los subgrupos de pagos que aparecen en la pestaña «pagos» de esta documentación. Para las transacciones consecutivas, además de rellenar las etiquetas del subgrupo del monedero, dynamic_mcc, con el número que mejor describa la actividad del subcomerciante que llevó a cabo la transacción y soft_descriptor, también es necesario rellenar el subgrupo sub_merchant e informar los datos respectivos del subcomerciante que llevó a cabo la transacción.

Para cada tipo de caso de uso, es necesario completar algunos datos disponibles en la lista siguiente, en los que es posible verificar sus respectivas normas y obligaciones.

En el caso de la marca Elo, a partir del lanzamiento de octubre de 2023, ya no está permitido enviar transacciones con dinero en efectivo y crédito a plazos. Solo se pueden enviar transacciones en efectivo a las tarjetas Elo en los modos de débito y prepago. Además, ahora es obligatorio enviar el CPF/CNPJ del destinatario de la transferencia, un descriptor simplificado al que se añada el nombre del titular de la cuenta receptora, así como el envío del MCC 6051 para las transacciones en efectivo. Si se envía de forma incorrecta o se canjea por modalidades no permitidas o si falta la información obligatoria, la marca o

el emisor rechazarán la transacción.

Para las **transacciones con código QR**, envía los campos capture_type, ticket_number, capture_channel, identification, plans y sub_plan

properties: type: type: string description: Tipo de monedero:

01: Monedero MasterPass
02: Visa Checkout
10: Monedero tokenizado genérico 55: Monedero
local de Brasil (SDWO)

maxLength: 2 enum: - "01" - "02" - "10" - "55" example: "55" id: type: string description: "Identificación de billetera.

- MasterPass:
101 = Wallet Remote
102 = Wallet Remote NFC Payment
- Monedero genérico tokenizado
000 = Sin especificar
101 = Wallet Remote
102 = Wallet Remote NFC Payment
103 = Apple Pay
216 = Android Pay
217 = Samsung Pay
327 = MDES para comercios (M4M)
" example: "000" default: "101" maxLength: 5 enum: - "000" - "101" - "102" - "103" - "216" - "217" - "327" merchant_id: type: string description: Número de identificación de la billetera digital registrada con las banderas.
Visa = MVV (Merchant Value Verification) con 6 posiciones
Mastercard = WID (ID de billetera) con 3 posiciones
Elo = WID (ID de billetera) con 11 posiciones
example: "327" maxLength: 12 fund_transfer: type: object description: Datos para transacciones de matrices SDWO (Staged Digital Wallet Operator) properties: pay_action: type: string description: "Tipo de financiación.

Transferencia de fondos de FT: debe estar marcada en las transacciones de financiación. En todos los casos, se canjea en SDWO.

Financiación y compra de FP: deben marcarse en las transacciones de SDWO consecutivas para todas las marcas.

BP Billpay: marca el pago de facturas en el programa Visa CBPS." enum: - FT - FP - BP example: FT maxLength: 2 receiver: type: object description: Cuenta de destinatario de datos properties: account_number: type: string description: "El número de cuenta del destinatario, que se puede rellenar con uno de los siguientes valores» #NA» o «⇒ 99999995». Es necesario. La gestión logística solo es para la marca Mastercard, para las transacciones SDWO con entrada en efectivo y para otras marcas, o el relleno es opcional." example: "9999999999999995" maxLength: 20 account_type: type: string description: Tipo de cuenta que debe rellenarse con 00.

- 00 - Otro (predeterminado, actualmente el único valor permitido)
- 01 — RTN + Cuenta bancaria
- 02 — IBAN
- 03 — Cuenta de tarjeta (para getnet el único tipo disponible actualmente)
- 04 — Correo electrónico
- 05 — Número de teléfono
- 06 — Número de cuenta bancaria (BAN) + Código de
identificación bancaria (BIC)
- 07 — ID de billetera
- 08 —
Completar el ID de red social solo es necesario para la marca Mastercard para transacciones SDWO en efectivo, para otras marcas, rellenar es opcional enum: - "00" - "01" - "02" - "03" - "04" - "05" - "06" - "07" - "08" example: "00" maxLength: 2 first_name: type: string description: >- Nombre del destinatario, que debe completarse con el nombre del destinatario de la primera transferencia. Por ejemplo, Jane. Es necesario el relleno solo para la marca Mastercard para transacciones de Cash-in SDWO, para los demás el llenado de banderas es opcional example: Jane maxLength: 35 middle_name: type: string description: "Segundo nombre del destinatario que debe completarse con la abreviatura del segundo nombre del destinatario de la transferencia. Por ejemplo: T. El relleno es opcional para todas las banderas. Longitud mínima: 1 Longitud máxima: 1" example: T last_name: type: string description: "Apellido del destinatario que debe completarse con el apellido (apellido) del destinatario de la transferencia. Por ejemplo: Smith. En el caso de las transacciones SDWO con entrada de efectivo únicamente con la marca Mastercard, el llenado es opcional en el caso de otras marcas" example: Smith maxLength: 35 addr_street: type: string description: "Dirección del destinatario: calle, que debe rellenarse con la dirección del destinatario de la transferencia (calle y número). Por ejemplo: 1 Main ST. El relleno es opcional para todas las banderas." example: 1 Main ST maxLength: 50 addr_city: type: string description: "La dirección del destinatario debe completarse con la ciudad del destinatario de la transferencia. Por ejemplo: SAO PAULO. Rellenarlo es opcional para todas las banderas." example: SAO PAULO maxLength: 25 addr_state: type: string description: "Dirección del destinatario: estado que debe rellenarse con el estado del destinatario de la transferencia. Por ejemplo: SP. El llenado es opcional para todas las banderas." example: SP maxLength: 3 addr_country: type: string description: "Dirección del destinatario: el país debe completarse con el país del destinatario de la transferencia. De acuerdo con la norma ISO 3166-1 alpha 3, la gestión logística es únicamente para la marca Mastercard para las transacciones con entrada de efectivo (SDWO), para otras marcas o el relleno es opcional" example: BRA maxLength: 3 addr_postal_code: type: string description: "Dirección del destinatario: código postal que debe rellenarse con el código postal (código postal) del destinatario de la transferencia. Por ejemplo: 01408000. El llenado es opcional para todas las banderas." example: "1408000" maxLength: 10 nationality: type: string description: Nacionalidad del receptor, que debe completarse con la nacionalidad del destinatario de la transferencia. Siguiendo la norma ISO 3166-1 alpha 3, el acolchado es opcional para todas las banderas. example: BRA maxLength: 3 phone: type: string description: "Teléfono del destinatario, que debe completarse con el número de teléfono del destinatario de la transferencia, incluido el código del país. Ej.: 5511977778888. La finalización es opcional para todas las banderas." example: "5511977778888" maxLength: 20 date_of_birth: type: string description: >- Fecha de nacimiento del destinatario, que debe completarse con la fecha de nacimiento de destinatario de la transferencia con el Formato YYYMMDD. Ex 19901230. El llenado es opcional para todos banderas. example: "19901230" maxLength: 8 id_type: type: string description: >- Tipo de identificador del destinatario que debe rellenarse con el tipo de documento utilizado por el destinatario de la transferencia (CPF) o CNPJ). En este caso, rellene 03. El rellenando las marcas Mastercard, Visa y Elo para Transacciones SDWO en efectivo, para otras marcas rellenarlo es opcional.
- 00 = Pasaporte
- 01 = Tarjeta de identificación nacional
- 02 = Licencia de conducir
- 03 = Expedida por el gobierno
- 04 = Otros
enum: - "00" - "01" - "02" - "03" - "04" example: "03" maxLength: 2 id_num: type: string description: >- Número de identificación del destinatario que debe completarse con el número CPF o CNPJ del destinatario de la transferencia. Ex 12345678900000. Es obligatorio cumplimentarlo para las marcas Mastercard, Visa y Elo para las transacciones SDWO con entrada de efectivo, para otras marcas el llenado es opcional. example: "12345678900000" maxLength: 25 capture_type: type: string description: "Campo numérico de longitud fija con 1 posición.

Indica el tipo de captura y debe enviarse en todas las transacciones de venta, cancelación/reembolso:
0 - POS
1 - TEF
2 - Comercio electrónico
3 - Pago recurrente 4 - POS móvil" example: "0" enum: - "0" - "1" - "2" - "3" - "4" ticket_number: type: string description: "**Solo transacciones de códigos QR**
Campo numérico de longitud fija con 10 dígitos justificados a la derecha y completado con ceros. En caso de que el billete sea válido como factura, se introduce el número de billete, que en algunos países se indica en las terminales." example: "0" capture_channel: type: string description: "**Solo transacciones de códigos QR**
Campo numérico de longitud fija con 2 dígitos justificados a la derecha y completado con ceros. Indicador de tipo de captura de canal" example: pos identification: type: string description: "**Solo transacciones de código QR**
" example: Santander plans: type: string description: "**Solo transacciones con código QR**
Tipo de plan de ventas Cadena obligatoria Campo numérico de longitud fija con 2 posiciones: 01 o 02" example: "02" enum: - "01" - "02" sub_plan: type: string description: "**Solo transacciones de código QR**
Subtipo de plan de ventas Cadena obligatoria Campo numérico de longitud fija con 2 posiciones: 01 o 02" example: "02" enum: - "01" - "02" CreditResponseDTO: type: object properties: delayed: type: boolean authorization_code: type: string authorized_at: type: string reason_code: type: string reason_message: type: string acquirer: type: string soft_descriptor: type: string brand: type: string terminal_nsu: type: string acquirer_transaction_id: type: string transaction_id: type: string first_installment_amount: type: string other_installment_amount: type: string total_installment_amount: type: string DetailsResponseDTO: type: object properties: status: type: string description: type: string brand: type: string error_code: type: string description_detail: type: string payment_id: type: string authorization_code: type: string terminal_nsu: type: string acquirer_transaction_id: type: string PaymentResponseDTO: type: object properties: seller_id: type: string amount: type: integer format: int32 currency: type: string order_id: type: string status: type: string received_at: type: string message: type: string name: type: string payment_id: type: string status_code: type: integer format: int32 credit: $ref: "#/components/schemas/CreditResponseDTO" debit: $ref: "#/components/schemas/CreditResponseDTO" details: type: array items: $ref: "#/components/schemas/DetailsResponseDTO" BoletoDTO: description: Datos para generar la palanquilla type: object properties: our_number: maxLength: 12 minLength: 12 type: string description: "Denominado por los bancos como «Nuestro número». Es el billete de identificación que solo está en el sistema de facturación y no tiene máscara. Está compuesto por reglas que varían según el banco y el servicio de cobro. Por ejemplo, en el caso de Santander hay dos formas de numeración: 1) Si el cliente informa el número, el cliente se encarga de informar el dv (dígito de control); 2) Si el cliente omite el número, el banco se encarga de generar una secuela, sin DV." example: "1946598.0" document_number: maxLength: 15 minLength: 15 type: string description: Tu número. Número controlado por el cliente, normalmente es administrado por el sistema que genera el ticket. (sin máscara) example: "170500000019763" expiration_date: type: string description: Fecha de caducidad del billete. Si no se informa, se considerará el número estándar de días de caducidad de la preinscripción. format: mm/dd/yyyy example: 11/16/2030 instructions: maxLength: 1000 type: string description: 'Las instrucciones deben imprimirse en el billete. El salto de línea se puede realizar de dos maneras. 1) Ajuste de línea automático: se realizará un salto de línea de hasta 100 caracteres sin que las palabras se trunquen; 2) Salto de línea manual: salto de línea con el carácter de
escape "». Ejemplo: «Se trata de una línea de prueba de salto.
La segunda línea se imprimirá ahora.
Y por último, la tercera línea. «;' example: Do not receive after expiration provider: maxLength: 40 type: string description: Banco proveedor. example: santander default: santander enum: - santander guarantor_name: type: string description: Nombre del garante. example: Ze small default: Ze small guarantor_document_type: type: string description: Tipo de documento del garante. example: CPF guarantor_document_number: type: string description: Número del documento del garante. example: "78009200021" default: "78009200021" DataDTO: type: object required: - amount - order - payment properties: amount: type: integer format: int32 description: Importe de la compra en centavos. Vea más aquí. example: 118708 currency: type: string description: Identificación de la moneda (consulte el código en esta sección).
Campo obligatorio para la lucha contra el fraude example: BRL enum: - BRL - ARS - CLP - USD - UYU - EUR - MXN customer_id: type: string description: Identificador del comprador. Información definida por la aplicación que consume la API de la plataforma digital.
Campo obligatorio para la lucha contra el fraude example: test payment: $ref: "#/components/schemas/PaymentDataDTO" sub_merchant: $ref: "#/components/schemas/SubMerchantDTO" additional_data: type: object description: Datos de autorización adicionales. Campo obligatorio para la división de pagos. required: - billing_address - shippings - customer properties: split: $ref: "#/components/schemas/split_data" device: $ref: "#/components/schemas/DeviceDTO" customer: $ref: "#/components/schemas/CustomerDTOAddData" order: $ref: "#/components/schemas/OrderPaymentDTO" installment: $ref: "#/components/schemas/InstallmentCuotesDTO" airline: $ref: "#/components/schemas/Airlines" rates: $ref: "#/components/schemas/rates" dynamic_currency_conversion: $ref: "#/components/schemas/dccDTO" regional_regulation_code: type: string description: (Uruguay únicamente). Permite enviar un código legal vinculado a beneficios fiscales o condiciones especiales. Por ejemplo, «17934» se refiere a una ley en vigor que permite un trato preferencial. Si no se reconoce el código, se ignora y no se aplica ningún descuento. example: "17934" cross_border_data: $ref: "#/components/schemas/crossBorderDTO" is_pre_paid: type: boolean network_token: type: string description: El token de la tarjeta que se utilizará para generar el criptograma. example: 1b110aaa71934ae492bff48baab9af81 DataAdjustmentDTO: type: object required: - amount - payment properties: amount: type: integer format: int32 description: Importe de la compra en centavos example: 118708 payment: $ref: "#/components/schemas/PaymentDataAdjustmentDTO" additional_data: type: object description: Datos de autorización adicionales. Campo obligatorio para la división de pagos. properties: installment: $ref: "#/components/schemas/InstallmentCuotesDTO" DataBoletoDTO: type: object required: - amount - order - payment properties: amount: type: integer format: int32 description: Importe de la compra en centavos example: 118708 currency: type: string description: Identificación de la moneda (consulte el código en esta sección).
Campo obligatorio para la lucha contra el fraude example: BRL enum: - BRL - USD - MXN - CLP - ARS customer_id: type: string description: Identificador del comprador. Información definida por la aplicación que consume la API de la plataforma digital.
Campo obligatorio para la lucha contra el fraude example: test payment: $ref: "#/components/schemas/PaymentBoletoDataDTO" boleto: $ref: "#/components/schemas/BoletoDataDTO" customer: $ref: "#/components/schemas/CustomerDTO" order: $ref: "#/components/schemas/OrderDTO" additional_data: type: object description: Datos de autorización adicionales. Campo obligatorio para la división de pagos. required: - billing_address - shippings - customer properties: split: $ref: "#/components/schemas/split_data" device: $ref: "#/components/schemas/DeviceDTO" customer: $ref: "#/components/schemas/CustomerDTOAddData" order: $ref: "#/components/schemas/OrderDTO" installment: $ref: "#/components/schemas/InstallmentCuotesDTO" is_pre_paid: type: boolean network_token: type: string description: El token de la tarjeta que se utilizará para generar el criptograma. example: 1b110aaa71934ae492bff48baab9af81 PaymentDataDTO: type: object description: Conjunto de datos que contiene los artículos del pedido. required: - payment_id - payment_method - transaction_type - number_installments - card properties: payment_id: type: string description: Código de identificación de pago. maxLength: 36 example: 173f9e8d-4e0b-4503-8016-5cdafba89bee payment_method: type: string description: "Tipo de transacción.

**Métodos de tarjeta no presentada: **
- CRÉDITO -
DÉBITO - CREDIT_AUTHORIZATION - CREDIT_PRE_AUTHORIZATION

**Métodos de presentación de tarjeta: ** - DIRECT_CREDIT - DIRECT_CREDIT_AUTHORIZATION - DIRECT_CREDIT_PRE_AUTHORIZATION - DIRECT_DEBIT - QRCODE" example: CREDIT enum: - CREDIT - DEBIT - CREDIT_AUTHORIZATION - CREDIT_PRE_AUTHORIZATION - DIRECT_CREDIT - DIRECT_CREDIT_AUTHORIZATION - DIRECT_CREDIT_PRE_AUTHORIZATION - DIRECT_DEBIT save_card_data: type: boolean description: Identifica si la tarjeta debe guardarse para compras futuras. example: false transaction_type: type: string description: Tipo de transacción. Pago completo, en cuotas sin intereses, pagado en cuotas con intereses. (para Uruguay solo se acepta el pago COMPLETO) example: FULL enum: - FULL - INSTALL_NO_INTEREST - INSTALL_WITH_INTEREST number_installments: type: integer description: Número de cuotas de una transacción de crédito en cuotas. example: 1 soft_descriptor: type: string maxLength: 22 description: >-

Texto que aparece en la factura de la tarjeta del comprador, este campo es opcional, si no se informa nada, se tendrá en cuenta el nombre comercial registrado en el establecimiento. Solo los datos alfanuméricos y los siguientes caracteres especiales:% $,./& () + = < > - * Los espacios se sustituirán por el carácter «*». La transacción no se rechazará si se envían caracteres no permitidos. No se tendrá en cuenta ninguna información que supere el tamaño máximo

Obligatorio para los facilitadores de pagos y SDWO.

Además de lo anterior, se deben seguir las siguientes reglas adicionales de las banderas:

Identificación del facilitador de pagos, con 3, 7 o 12 caracteres

separadores «*» (asterisco)

Identificación de subcomercio

Ejemplo 1: FAC*SUCOMERCIO Ejemplo 2: FACILIT*SUBCOMERCIO

Ejemplo 3: FACILITADOR1*SUBCOMERC

Ejemplo 4: para SDWO de forma consecutiva: Carteira*Subcomercio

Ejemplo 5: para SDWO solo rellena

la cartera

nombre: Digital Wallet

example: LOJA*TESTE*COMPRA-123 dynamic_mcc: type: number maxLength: 4 minLength: 4 description: Campo utilizado para indicar la transacción con otro código de categoría de comerciante (código de categoría de comerciante) diferente del registrado. Si se envía un MCC no válido, se utilizará el predeterminado. Envía solo datos numéricos.

Obligatorio para los facilitadores de pagos y SDWO.

Para las transacciones con ingreso de efectivo mediante el método SDWO, usa el MCC 6051 para las marcas Visa, Mastercard y Elo. example: 1799 card: $ref: "#/components/schemas/CardDTO" tokenization: $ref: "#/components/schemas/TokenizationDTO" wallet: $ref: "#/components/schemas/WalletCreditDTO" xid: type: string description: Campo disponible a partir de la versión 2.0. Identificador MPI para cada transacción autenticada. El contenido del campo puede ser un valor HEXA o Base64, según el MPI utilizado. maxLength: 40 example: test ucaf: type: string description: Campo disponible a partir de la versión 2.0. Código de autenticación cifrado por la bandera. El contenido del campo puede ser un valor HEXA o Base64, según el MPI utilizado. maxLength: 40 example: string eci: type: string description: Campo disponible a partir de la versión 2.0. Código ECI de la transacción autenticada con 3D Secure. Generado por un MPI externo. maxLength: 2 example: "00" tdsdsxid: type: string description: Identificador de transacciones de la versión 2 del servidor 3DS. example: string tdsver: type: string description: Indica la versión 3DS utilizada en la autenticación, example: 2.1.0 terminal: $ref: "#/components/schemas/TerminalPaymentDTO" TerminalPaymentDTO: required: - terminal_number type: object properties: terminal_number: type: string description: La identificación del número de terminal **es un campo obligatorio para presentar la tarjeta**. description: El conjunto de datos del terminal **es un objeto obligatorio para Card Present**. PaymentDataAdjustmentDTO: type: object description: Conjunto de datos que contiene los artículos del pedido. required: - payment_id - payment_method properties: payment_id: type: string description: Código de identificación de pago. maxLength: 36 example: 173f9e8d-4e0b-4503-8016-5cdafba89bee payment_method: type: string description: Tipo de transacción. example: CREDIT_PRE_AUTHORIZATION enum: - CREDIT_PRE_AUTHORIZATION PaymentBoletoDataDTO: type: object description: Conjunto de datos que contiene los artículos del pedido. required: - payment_id - payment_method - transaction_type - number_installments - card properties: payment_id: type: string description: Código de identificación de pago. maxLength: 36 example: 173f9e8d-4e0b-4503-8016-5cdafba89bee payment_method: type: string description: Tipo de transacción. example: BOLETO enum: - BOLETO BoletoDataDTO: description: Datos para generar la factura type: object properties: our_number: maxLength: 12 minLength: 12 type: string description: "Los bancos lo denominan «Nuestro número». Es la identificación única de la factura en el sistema de facturación y no tiene máscara. Consiste en reglas que varían según el banco y el servicio de facturación. Por ejemplo, en el caso de Santander hay dos formas de numerar: 1) Si el cliente informa el número, el cliente es responsable de informar el dv (dígito de verificación); 2) Si el cliente omite el número, el banco es responsable de generar un número secuencial, sin DV." example: "1946598.0" document_number: maxLength: 15 minLength: 15 type: string description: Tu número. Número controlado por el cliente, normalmente gestionado por el sistema que genera la factura. (sin máscara) example: "170500000019763" expiration_date: type: string description: Fecha de vencimiento de la factura. Si no se proporciona, se tendrá en cuenta el número predeterminado de días preinscritos para la fecha de vencimiento. format: dd/mm/yyyy example: 16/11/2030 instructions: maxLength: 1000 type: string description: 'Las instrucciones deben imprimirse en la factura.
Los saltos de línea se pueden hacer de dos maneras. 1) Salto de línea automático: se formará un salto de línea de hasta 100 caracteres sin que las palabras se trunquen; 2) Salto de línea manual: un salto de línea con el carácter de escape "». Ejemplo: «Esta es una prueba de salto de línea.
Ahora se imprimirá la segunda línea.
Y por último, la tercera línea. «;' example: Not receiving after due date provider: maxLength: 40 type: string description: Banco proveedor. example: santander default: santander enum: - santander guarantor_name: type: string description: Nombre del garante. example: João da Silva default: João da Silva guarantor_document_type: type: string description: Tipo de documento del garante. example: CPF guarantor_document_number: type: string description: Número de documento del garante. example: "78009200021" default: "78009200021" CancelRequestDTO: type: object properties: marketplace_subseller_payments: type: array items: $ref: "#/components/schemas/MarketplaceSubsellerPayment" payment_id: type: string amount: type: integer format: int32 cancel_amount: type: integer format: int32 combined_id: type: string is_combined: type: boolean internal: $ref: "#/components/schemas/InternalDTO" cancel_custom_key: type: string MarketplaceSubsellerPayment: type: object properties: subseller_sales_amount: type: integer format: int32 subseller_id: type: string order_items: type: array items: $ref: "#/components/schemas/OrderItem" OrderItem: type: object properties: amount: type: integer format: int32 currency: type: string id: type: string description: type: string tax_percent: type: number format: double tax_amount: type: integer format: int32 CancelDTO: type: object required: - idempotency_key - payment_id - payment_method properties: idempotency_key: $ref: "#/components/schemas/idempotency_key" request_id: $ref: "#/components/schemas/request_id" payment_id: $ref: "#/components/schemas/payment_id" additional_data: type: object description: Datos de cancelación adicionales. properties: split: $ref: "#/components/schemas/split_data" card: type: object description: Solo para regalo con tarjeta properties: track1: description: Campo de pista 1 type: string track2: description: Campo Track 2 type: string number: type: string maxLength: 23 example: "1231231231231232" description: Número de tarjeta. expiration_month: maxLength: 2 type: integer description: Mes de caducidad de la tarjeta de dos dígitos. format: int32 example: 12 expiration_year: maxLength: 2 type: integer description: Año de caducidad de la tarjeta de dos dígitos. format: int32 example: 28 currency: description: Solo para regalo con tarjeta $ref: "#/components/schemas/currency" amount: type: integer format: int32 description: Valor (inferior o igual) de la compra en centavos. La cancelación parcial (de menor valor) solo se permite a partir del día siguiente a la transacción (D+N) example: 118708 payment_method: title: Tipo de transacción. type: string example: CREDIT enum: - DIRECT_CREDIT - DIRECT_CREDIT_AUTHORIZATION - DIRECT_CREDIT_PRE_AUTHORIZATION - DIRECT_DEBIT custom_key: $ref: "#/components/schemas/custom_key" CaptureResponseDTO: type: object properties: idempotency_key: $ref: "#/components/schemas/idempotency_key" seller_id: $ref: "#/components/schemas/seller_id" request_id: $ref: "#/components/schemas/request_id" payment_id: $ref: "#/components/schemas/payment_id" order_id: $ref: "#/components/schemas/order_id" amount: $ref: "#/components/schemas/amount" currency: $ref: "#/components/schemas/currency" status: type: string reason_code: $ref: "#/components/schemas/reason_code" reason_message: $ref: "#/components/schemas/reason_message" captured_at: type: string CancelResponseDTO: type: object properties: idempotency_key: $ref: "#/components/schemas/idempotency_key" seller_id: $ref: "#/components/schemas/seller_id" request_id: $ref: "#/components/schemas/request_id" payment_id: $ref: "#/components/schemas/payment_id" order_id: $ref: "#/components/schemas/order_id" amount: $ref: "#/components/schemas/amount" currency: $ref: "#/components/schemas/currency" status: type: string reason_code: $ref: "#/components/schemas/reason_code" reason_message: $ref: "#/components/schemas/reason_message" canceled_at: type: string example: 2020-07-01T02:15:03.603Z description: Fecha de cancelación custom_key: $ref: "#/components/schemas/custom_key" PaymentDTO: type: object properties: idempotency_key: $ref: "#/components/schemas/idempotency_key" request_id: $ref: "#/components/schemas/request_id" order_id: $ref: "#/components/schemas/order_id" data: $ref: "#/components/schemas/DataDTO" description: Datos para llevar a cabo una autorización. AdjustmentDTO: type: object properties: idempotency_key: $ref: "#/components/schemas/idempotency_key" request_id: $ref: "#/components/schemas/request_id" data: $ref: "#/components/schemas/DataAdjustmentDTO" PaymentBoletoDTO: type: object required: - idempotency_key - request_id properties: idempotency_key: $ref: "#/components/schemas/idempotency_key" request_id: $ref: "#/components/schemas/request_id" order_id: $ref: "#/components/schemas/order_id" data: $ref: "#/components/schemas/DataBoletoDTO" description: Datos para llevar a cabo una autorización. AutorizationResponseDTO: type: object properties: idempotency_key: type: string seller_id: type: string request_id: type: string payment_id: type: string order_id: type: string amount: type: string currency: type: string status: type: string payment_method: type: string received_at: type: string transaction_id: type: string original_transaction_id: type: string authorized_at: type: string reason_code: type: string reason_message: type: string acquirer: type: string soft_descriptor: type: string brand: type: string authorization_code: type: string acquirer_transaction_id: type: string eci: type: string payment_received_timestamp: type: string card_id: type: string boleto: $ref: "#/components/schemas/BoletoResponseDTO" merchant_advice_code: type: string additional_data: type: object additionalProperties: type: object BolepixDTO: type: object properties: cod_qrcode: type: string cod_url_qrcode: type: string BoletoResponseDTO: type: object properties: boleto_id: type: string bank: type: string status_code: type: string status_label: type: string typeful_line: type: string bar_code: type: string issue_date: type: string expiration_date: type: string our_number: type: string document_number: type: string pix: $ref: "#/components/schemas/BolepixDTO" _links: type: array items: $ref: "#/components/schemas/LinkBoletoDTO" LinkBoletoDTO: type: object properties: href: type: string rel: type: string type: type: string InstallmentQuotesRequestDTO: type: object properties: amount: $ref: "#/components/schemas/amount" bin: type: string description: Los primeros nueve números de la tarjeta. minLength: 9 maxLength: 9 example: "123412" installment_type_filter: type: string description: Define si la cuota tiene o no intereses, los valores posibles, `no_interest` o `with_interest`. example: no_interest number_token: maxLength: 128 type: string description: Símbolo de la tarjeta que se utilizará en las transacciones. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c IncreaseRateDTO: type: object properties: value: type: integer format: int32 rate: type: number format: double InstallmentQuotesResponseDTO: type: object properties: amount: type: integer format: int32 options: type: array items: $ref: "#/components/schemas/OptionResponseDTO" CrossborderQuoteResponseDTO: type: array items: type: object properties: last_update: type: string request_id: type: string currency_code: type: string prices: type: array items: $ref: "#/components/schemas/PricesDTO" PricesDTO: type: object properties: date: type: string cardholder_amount: type: number format: double seller_code: type: string card_currency: type: string seller_currency: type: string fx_rate_id: type: string seller_amount: type: number format: double exchange_rate: type: number format: double acquirer_code: type: string markup_seller_amount: type: number format: double markup_cardholder_amount: type: number format: double markup_percentage: type: number format: double InterestRateDTO: type: object properties: type: type: string value: type: integer format: int32 rate: type: number format: double InterestTaxRateDTO: type: object properties: type: type: string value: type: integer format: int32 rate: type: number format: double OptionResponseDTO: type: object required: - quote_id properties: quote_id: $ref: "#/components/schemas/quote_id" schema: type: string type: type: string number: type: integer format: int32 installment_amount: type: integer format: int32 total_amount: type: integer format: int32 increase_rate: $ref: "#/components/schemas/IncreaseRateDTO" interest_rate: $ref: "#/components/schemas/InterestRateDTO" interest_tax_rate: $ref: "#/components/schemas/InterestTaxRateDTO" promo_id: type: string Data: type: object properties: additional_data: type: object additionalProperties: type: object ConfirmRequestDTO: type: object properties: marketplace_subseller_payments: type: array items: $ref: "#/components/schemas/MarketplaceSubsellerPayment" amount: type: integer format: int32 internal: $ref: "#/components/schemas/InternalDTO" ConfirmResponseDTO: type: object properties: seller_id: type: string amount: type: integer format: int32 currency: type: string order_id: type: string status: type: string payment_id: type: string credit_confirm: $ref: "#/components/schemas/CreditConfirmDTO" CreditConfirmDTO: type: object properties: confirm_date: type: string message: type: string CancelCustomKeyResponseDTO: type: object properties: seller_id: type: string payment_id: type: string cancel_request_at: type: string cancel_request_id: type: string cancel_custom_key: type: string terminal_nsu: type: string acquirer_transaction_id: type: string transaction_date: type: string currency: type: string transaction_type: type: string number_installments: type: integer format: int32 amount: type: integer format: int32 cancel_amount: type: integer format: int32 status_processing_cancel_code: type: string status_processing_cancel_message: type: string TokensCardRequest: required: - card_number type: object properties: card_number: maxLength: 19 minLength: 13 type: string description: Número de tarjeta.
Vea las tarjetas de prueba aquí. example: "5155901222280001" customer_id: maxLength: 100 type: string description: Identificador del comprador. Información definida por la aplicación que consume la API de la plataforma digital. example: customer_21081826 TokensCardResponse: required: - number_token type: object properties: number_token: maxLength: 128 type: string description: Símbolo de la tarjeta que se utilizará en las transacciones. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c CardDataResponse: type: object properties: card_id: maxLength: 36 type: string description: El identificador de la tarjeta guardado en la caja fuerte se puede usar para recuperar un number_token válido para compras futuras, así como para eliminar las tarjetas guardadas. example: e8ad2ae4-9e3e-4532-998f-1a5a11e56e58 last_four_digits: maxLength: 4 type: string description: Últimos cuatro dígitos de la tarjeta. example: "1212" bin: maxLength: 4 type: string description: Los primeros seis dígitos de la tarjeta. example: "121212" expiration_month: maxLength: 2 type: integer description: Mes de caducidad de la tarjeta de dos dígitos. format: int32 example: 12 expiration_year: maxLength: 2 type: integer description: Año de caducidad de la tarjeta de dos dígitos. format: int32 example: 28 brand: maxLength: 50 type: string description: Banner de tarjetas. example: Mastercard enum: - Mastercard - Visa - Amex - Elo - Hipercard cardholder_name: maxLength: 26 type: string description: El nombre del comprador está impreso en la tarjeta. example: JOAO DA SILVA customer_id: maxLength: 100 type: string description: Identificador del comprador. example: customer_21081826 number_token: maxLength: 128 type: string description: El token de la tarjeta que se utilizará en las transacciones. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c used_at: maxLength: 24 type: string description: Fecha del último uso. example: 2017-04-19T16:30:30Z created_at: maxLength: 24 type: string description: Fecha de creación. example: 2017-04-19T16:30:30Z updated_at: maxLength: 24 type: string description: Fecha de actualización. example: 2017-04-19T16:30:30Z status: maxLength: 20 type: string description: Estado de la tarjeta en la caja fuerte. example: active enum: - active - blocked - canceled - renewed transaction_id: maxLength: 32 type: string description: ID de transacción de verificación de tarjeta example: "123456" ListCardDataResponse: type: object properties: cards: type: array items: $ref: "#/components/schemas/CardDataResponse" SaveCardDataRequest: required: - customer_id - expiration_month - expiration_year - number_token type: object properties: number_token: maxLength: 2147483647 minLength: 10 type: string description: Número de tarjeta tokenizado. Generado a través del punto final /v1/tokens/card. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c brand: maxLength: 50 type: string description: Marca de tarjeta. example: Mastercard enum: - Mastercard - Visa - Amex - Elo - Hipercard cardholder_name: maxLength: 26 minLength: 0 type: string description: El nombre del comprador está impreso en la tarjeta. example: JOAO DA SILVA expiration_month: maxLength: 2 minLength: 2 pattern: 0[1-9]|1[0-2] type: string description: Mes de caducidad de la tarjeta de dos dígitos. example: "12" expiration_year: maxLength: 2 minLength: 2 type: string description: Año de caducidad de la tarjeta de dos dígitos. example: "28" customer_id: maxLength: 100 minLength: 0 type: string description: Identificador del comprador. example: customer_21081826 cardholder_identification: type: string description: Identificación del comprador, como CPF o ID. (sin máscara). example: "12345678912" verify_card: type: boolean description: Realiza una transacción que verifica que la tarjeta ingresada no esté cancelada, bloqueada o restringida. example: false enum: - true - false security_code: maxLength: 4 minLength: 3 type: string description: Código de seguridad. CVV o CVC. example: "123" transaction_id: type: string description: Número de la primera transacción de la tarjeta. example: "3123131241412" SaveCardDataResponse: type: object properties: card_id: maxLength: 36 type: string description: El identificador de la tarjeta guardado en la caja fuerte se puede usar para recuperar un number_token válido para compras futuras, así como para eliminar las tarjetas guardadas. example: e8ad2ae4-9e3e-4532-998f-1a5a11e56e58 number_token: maxLength: 128 type: string description: El token de la tarjeta que se utilizará en las transacciones. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c VerificationCardRequest: required: - expiration_month - expiration_year - number_token type: object properties: number_token: maxLength: 2147483647 minLength: 10 type: string description: Número de tarjeta tokenizado. Generado a través del punto final /v1/tokens/card. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c brand: maxLength: 50 type: string description: Marca de tarjeta. example: Mastercard enum: - Mastercard - Visa - Amex - Elo - Hipercard cardholder_name: maxLength: 26 type: string description: El nombre del comprador está impreso en la tarjeta. example: JOAO DA SILVA expiration_month: maxLength: 2 minLength: 2 pattern: 0[1-9]|1[0-2] type: string description: Mes de caducidad de la tarjeta de dos dígitos. example: "12" expiration_year: maxLength: 2 minLength: 2 type: string description: Año de caducidad de la tarjeta de dos dígitos. example: "28" security_code: maxLength: 4 minLength: 3 type: string description: Código de seguridad. CVV o CVC. example: "123" VerificationCardResponse: type: object properties: status: maxLength: 20 type: string description: Estado de verificación de la tarjeta, donde VERIFICADO es el indicativo de que la tarjeta se ha validado correctamente. example: VERIFIED enum: - '"VERIFIED","NOT VERIFIED","DENIED","ERROR"' verification_id: maxLength: 36 type: string description: Identificación de la solicitud de verificación en la plataforma digital. example: ae267804-503c-4163-b1b1-f5da5120b74e authorization_code: maxLength: 18 type: string description: Número de autorización generado por la tarjeta del sistema de verificación. example: "6964722471672911" transaction_id: maxLength: 20 type: string description: Número de transacción generado por el sistema de verificación de la tarjeta. example: "1002217281190421" CustomerResponse: type: object properties: customer_id: maxLength: 100 minLength: 0 type: string first_name: maxLength: 40 minLength: 0 type: string last_name: maxLength: 80 minLength: 0 type: string document_type: type: string enum: - CPF - CNPJ - PASSPORT_BR - DNI_AR - CUIL - CUIT - PASSPORT_AR - RUT - CI_CL document_type_name: type: string document_number: maxLength: 30 minLength: 3 pattern: (^$|.{3,30}) type: string document_country: type: string phone_number: type: string celphone_number: type: string email: type: string status: type: string enum: - active - inactive ListCustomersResponse: required: - limit - page - total type: object properties: customers: type: array items: $ref: "#/components/schemas/CustomerResponse" page: type: integer format: int32 limit: type: integer format: int32 total: type: integer format: int32 Address: description: Conjunto de datos relativos a la dirección del comprador properties: street: type: string description: Patio trasero. maxLength: 60 example: Av. Brazil number: type: string description: Número de calle. maxLength: 10 example: "1000" complement: type: string description: Complemento de dirección. maxLength: 60 example: Sala 1 district: type: string description: Barrio. maxLength: 40 example: Sao Geraldo city: type: string description: Ciudad. maxLength: 40 example: Porto Alegre state: type: string description: Estado (UF). maxLength: 20 example: RS country: type: string description: País. maxLength: 20 example: Brazil postal_code: type: string description: Código postal, CEP en Brasil o ZIP en los Estados Unidos. (sin máscara) maxLength: 8 example: "90230060" FloatingDataPlan: required: - amount - installment type: object properties: installment: minimum: 1 type: integer format: int32 amount: minimum: 0 type: integer format: int32 Period: required: - billing_cycle - type type: object properties: type: maxLength: 15 type: string description: Tipo de periodicidad. example: monthly enum: - yearly - monthly - bimonthly - quarterly - semesterly - specific billing_cycle: maximum: 9999 minimum: 0 type: integer description: La duración del plan se basa en el tipo de frecuencia. Por ejemplo, para un plan de 12 meses, en el que la facturación se realizará mensualmente (tipo = mensual), el valor que se asignará es 12. example: 12 specific_cycle_in_days: maximum: 30 minimum: 1 type: number description: Ciclo de facturación específico en días. Cuando el tipo de periodicidad es específico (tipo = específico) se debe asignar el número de días en los que se realizará el ciclo de facturación. Por ejemplo, si la duración del plan es de 12 (billing_cycle = 12) e o ciclo específico de 10 (specific_cycle_in_days = 10), esto significa que el cargo se realizará cada 10 días en total 12 cargos. description: Período del plan. PlanRequest: required: - seller_id - amount - currency - name - payment_types - period type: object properties: seller_id: $ref: "#/components/schemas/seller_id" name: description: Nombre del plan. type: string example: flex plan description: description: Descripción del plan. type: string example: flex plan amount: $ref: "#/components/schemas/amount" currency: $ref: "#/components/schemas/currency" sales_tax: description: Importe del impuesto. type: integer default: 0 product_type: type: string enum: - cash_carry - digital_content - digital_goods - gift_card - physical_goods - renew_subs - shareware - service payment_types: type: array items: type: string enum: - credit_card - debit_card period: $ref: "#/components/schemas/Period" floating_data: maxItems: 2147483647 minItems: 1 type: array items: $ref: "#/components/schemas/FloatingDataPlan" description: Solicitud que contiene datos para registrar un nuevo plan. Plan: required: - amount - currency - name - payment_types - period - seller_id type: object properties: seller_id: type: string format: uuid plan_id: type: string format: uuid name: type: string description: type: string amount: type: integer format: int32 currency: maxLength: 3 minLength: 0 type: string sales_tax: type: integer format: int32 product_type: type: string enum: - cash_carry - digital_content - digital_goods - gift_card - physical_goods - renew_subs - shareware - service payment_types: type: array items: type: string enum: - credit_card - debit_card status: type: string enum: - active - inactive create_date: type: string format: date-time period: $ref: "#/components/schemas/Period" floating_data: maxItems: 2147483647 minItems: 1 type: array items: $ref: "#/components/schemas/FloatingDataPlan" PlanData: required: - amount - currency - description - from - name - payment_types - period - plan_id - seller_id - to type: object properties: from: type: string format: uuid to: type: string format: uuid subscriptions: maxItems: 2147483647 minItems: 1 type: array items: type: string format: uuid id: type: string plan_id: type: string amount: type: integer format: int32 create_date: type: string currency: maxLength: 3 minLength: 0 type: string description: type: string name: type: string payment_types: type: array items: type: string enum: - credit_card - debit_card period: $ref: "#/components/schemas/Period" product_type: type: string enum: - cash_carry - digital_content - digital_goods - gift_card - physical_goods - renew_subs - shareware - service sales_tax: type: integer format: int32 seller_id: type: string status: type: string enum: - active - inactive floating_data: type: array items: $ref: "#/components/schemas/FloatingDataPlan" tenant_data: $ref: "#/components/schemas/TenantData" TenantData: type: object properties: country: type: string tenant: type: string PlanDataWrapper: type: object properties: limit: type: integer format: int32 page: type: integer format: int32 plans: type: array items: $ref: "#/components/schemas/PlanData" total: type: integer format: int64 UpdatePlan: required: - amount - currency - name - payment_types - period - status type: object properties: name: description: Nombre del plan. type: string example: flex plan description: description: Descripción del plan. type: string example: flex plan amount: $ref: "#/components/schemas/amount" currency: $ref: "#/components/schemas/currency" payment_types: type: array items: type: string enum: - credit_card - debit_card sales_tax: description: Importe del impuesto. type: integer default: 0 product_type: description: Identificador del tipo de producto vendido entre las opciones. type: string enum: - cash_carry - digital_content - digital_goods - gift_card - physical_goods - renew_subs - shareware - service period: $ref: "#/components/schemas/Period" status: type: string enum: - active - inactive floating_data: maxItems: 2147483647 minItems: 1 type: array items: $ref: "#/components/schemas/FloatingDataPlan" description: Se cambiarán los detalles del plan. PlanPartialUpdateRequest: required: - description - name type: object properties: name: description: Nombre del plan. type: string example: flex plan description: description: Descripción del plan. type: string example: flex plan amount: $ref: "#/components/schemas/amount" floating_data: maxItems: 2147483647 minItems: 1 type: array items: $ref: "#/components/schemas/FloatingDataPlan" description: Conjunto de datos del plan que se actualizará. SubscriptionPlanMigration: required: - from - to type: object properties: from: type: string format: uuid description: Identificador del plan original, es decir, el plan_id original de la suscripción. to: type: string format: uuid description: Identificador del plan objetivo, es decir, el plan_id al que desea migrar la suscripción. subscriptions: maxItems: 2147483647 minItems: 1 type: array description: Lista de identificadores de suscripción que se migrarán al plan de destino (al campo). Si no se incluye esta lista, el servicio migrará todas las suscripciones del plan de origen (del campo) al plan de destino (al campo). items: type: string format: uuid description: Conjunto de datos para solicitar un cambio de plan. FilteredResponse: required: - limit - page - total type: object properties: subscriptions: type: array items: $ref: "#/components/schemas/SubscriptionResponse" page: type: integer format: int32 limit: type: integer format: int32 total: type: integer format: int32 SubscriptionResponse: required: - create_date - order_id - payment_date - seller_id - status type: object properties: seller_id: type: string format: uuid order_id: maxLength: 36 minLength: 0 type: string installment_start_date: type: string format: date create_date: type: string format: date-time end_date: type: string format: date-time payment_date: maximum: 31 minimum: 1 type: integer format: int32 next_scheduled_date: type: string format: date-time subscription: $ref: "#/components/schemas/SubscriptionDetailResponse" customer: $ref: "#/components/schemas/CustomerResponse" plan: $ref: "#/components/schemas/PlanResponse" device: $ref: "#/components/schemas/Device" floating_data: type: array items: $ref: "#/components/schemas/FloatingData" status: type: string enum: - processing - success - expired - canceled - delayed - failed - suspended - created status_details: maxLength: 500 minLength: 0 type: string payment: $ref: "#/components/schemas/PaymentResponse" Device: type: object properties: ip_address: type: string device_id: type: string SubscriptionDetailResponse: required: - subscription_id type: object properties: subscription_id: type: string format: uuid payment_type: $ref: "#/components/schemas/PaymentTypeResponse" shippings: type: array items: $ref: "#/components/schemas/Shipping" PaymentResponse: type: object properties: seller_id: type: string format: uuid order_id: type: string payment_id: type: string format: uuid amount: type: integer format: int32 currency: type: string status: type: string enum: - pending - canceled - approved - denied - authorized - confirmed - expired - unprocessed payment_received_timestamp: type: string format: date-time credit: $ref: "#/components/schemas/PaymentDataResponse" debit: $ref: "#/components/schemas/PaymentDataResponse" error: $ref: "#/components/schemas/PaymentError" PaymentTypeResponse: type: object properties: credit: $ref: "#/components/schemas/CreditResponse" debit: $ref: "#/components/schemas/PaymentResponse" PlanResponse: type: object properties: seller_id: maxLength: 36 minLength: 36 type: string description: Código de identificación de comercio electrónico. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 plan_id: maxLength: 36 minLength: 36 type: string description: Identificador del plan. format: uuidv4 example: 51995e24-b1ae-4826-8e15-2a568a87abdd name: type: string description: Nombre del plan. example: Plano flex description: type: string description: Descripción del plan. example: Flex plan amount: type: integer description: Valor del plan. example: 19990 currency: maxLength: 3 minLength: 3 type: string description: Identificación de la moneda (consulte el código en esta sección). example: BRL payment_types: type: string description: Tipos de pagos aceptados. example: "" enum: - credit_card - debit_card sales_tax: type: integer description: Valor fiscal. product_type: type: string description: Identificador del tipo de producto vendido entre las opciones. example: service enum: - cash_carry - digital_content - digital_goods - gift_card - physical_goods - renew_subs - shareware - service create_date: maxLength: 24 type: string description: Fecha de creación del plan. format: YYYY-MM-DDTHH:MM:SSZ example: 2017-04-19T16:30:30Z status: maxLength: 20 type: string description: Estado del plan. example: active enum: - active - inactive period: $ref: "#/components/schemas/Period" floating_data: type: array description: Lista preconfigurada de cuotas que tendrán un valor diferente cuando se cree la suscripción. Esta funcionalidad se puede usar para crear cuotas de degustación con un valor cero, un valor de entrada o cuotas con descuento. El uso de esta funcionalidad y su finalidad prevista dependerán de la habilitación de un producto específico en Getnet. items: $ref: "#/components/schemas/FloatingDataWithDetails" CreditResponse: type: object properties: number_installments: type: integer format: int32 billing_address: $ref: "#/components/schemas/Address" soft_descriptor: type: string transaction_type: type: string enum: - FULL - INSTALL_WITH_INTEREST - INSTALL_NO_INTEREST tokenization: $ref: "#/components/schemas/Tokenization" card: $ref: "#/components/schemas/CreditCardResponse" wallet: $ref: "#/components/schemas/Wallet" PeriodResponse: required: - billing_cycle - type type: object properties: type: type: string enum: - yearly - monthly - bimonthly - quarterly - semesterly - specific billing_cycle: minimum: 0 type: integer format: int32 specific_cycle_in_days: type: integer format: int32 FloatingData: required: - installment type: object properties: installment: type: integer format: int32 example: 2 description: Número de la cuota a la que se aplicará el cambio. minimum: 1 new_amount: type: integer example: 19990 description: Nuevo importe de cargo. minimum: 0 new_scheduled_date: type: string format: YYYY-MM-DD description: Nueva fecha de facturación example: 2020-06-10 maxLength: 12 original_scheduled_date: type: string format: YYYY-MM-DD description: Fecha en la que se programó originalmente la facturación, antes de cambiarla, según el plan asociado a la suscripción. example: 2020-06-10 maxLength: 12 original_amount: type: integer example: 19990 description: Importe de facturación original, antes de cambiarlo, según el plan asociado a la suscripción. minimum: 0 Tokenization: required: - type type: object properties: type: type: string enum: - UCAF - TAVV - ELO cryptogram: type: string eci: type: string requestor_id: type: string Wallet: required: - id - type type: object properties: type: type: string id: type: string CreditCardResponse: required: - bin - cardholder_name - expiration_month - expiration_year type: object properties: brand: type: string enum: - Mastercard - Visa - Amex - Elo - Hipercard - Maestro bin: maxLength: 9 minLength: 6 type: string expiration_month: maxLength: 2 minLength: 2 type: string expiration_year: maxLength: 2 minLength: 2 type: string cardholder_name: maxLength: 100 minLength: 0 type: string card_id: maxLength: 36 minLength: 0 type: string PaymentDataResponse: required: - acquirer_transaction_id - authorization_code - reason_code - reason_message - transaction_id type: object properties: delayed: type: boolean authorization_code: type: string authorization_timestamp: type: string format: date-time reason_code: type: string reason_message: type: string acquirer: type: string soft_descriptor: type: string brand: type: string enum: - Mastercard - Visa - Amex - Elo - Hipercard - Maestro terminal_nsu: type: string acquirer_transaction_id: type: string transaction_id: type: string PaymentError: type: object properties: status_code: type: integer format: int32 name: type: string message: type: string details: type: array items: $ref: "#/components/schemas/PaymentErrorDetail" PaymentErrorDetail: type: object properties: acquirer_transaction_id: type: string description: type: string description_detail: type: string error_code: type: string payment_id: type: string status: type: string terminal_nsu: type: string Shipping: type: object properties: first_name: maxLength: 40 minLength: 0 type: string last_name: maxLength: 40 minLength: 0 type: string email: type: string phone_number: maxLength: 15 minLength: 0 type: string shipping_amount: type: integer format: int32 address: $ref: "#/components/schemas/Address" CreditCardCreation: required: - number_token type: object properties: brand: type: string enum: - Mastercard - Visa - Amex - Elo - Hipercard - Maestro number_token: type: string bin: maxLength: 9 minLength: 6 type: string expiration_month: maxLength: 2 minLength: 2 type: string expiration_year: maxLength: 2 minLength: 2 type: string cardholder_name: maxLength: 100 minLength: 0 type: string card_id: maxLength: 36 minLength: 0 type: string security_code: pattern: (^$|.{3,4}) type: string last_four_digits: maxLength: 4 minLength: 0 type: string CreditCreation: required: - card - number_installments - transaction_type type: object properties: transaction_type: type: string enum: - FULL - INSTALL_WITH_INTEREST - INSTALL_NO_INTEREST billing_address: $ref: "#/components/schemas/Address" soft_descriptor: maxLength: 22 minLength: 0 type: string card: $ref: "#/components/schemas/CreditCardCreation" wallet: $ref: "#/components/schemas/Wallet" tokenization: $ref: "#/components/schemas/Tokenization" number_installments: type: integer format: int32 PaymentCreation: required: - card - transaction_type type: object properties: transaction_type: type: string enum: - FULL - INSTALL_WITH_INTEREST - INSTALL_NO_INTEREST billing_address: $ref: "#/components/schemas/Address" soft_descriptor: maxLength: 22 minLength: 0 type: string card: $ref: "#/components/schemas/CreditCardCreation" wallet: $ref: "#/components/schemas/Wallet" tokenization: $ref: "#/components/schemas/Tokenization" PaymentTypeCreation: type: object properties: credit: $ref: "#/components/schemas/CreditCreation" debit: $ref: "#/components/schemas/PaymentCreation" SubscriptionCreation: required: - customer_id - plan_id - seller_id type: object properties: seller_id: $ref: "#/components/schemas/seller_id" customer_id: $ref: "#/components/schemas/customer_id" plan_id: $ref: "#/components/schemas/plan_id" order_id: $ref: "#/components/schemas/order_id" installment_start_date: description: Fecha de inicio de facturación de la suscripción. Hasta esa fecha, la suscripción permanecerá programada, es decir, con el estado creado. El uso de este campo y su finalidad prevista dependerán de la activación de un producto específico en Getnet. type: string format: YYYY-MM-DD example: 2020-09-14 maxLength: 10 subscription: $ref: "#/components/schemas/SubscriptionDetailCreation" device: $ref: "#/components/schemas/Device" description: Solicitud que contiene datos para registrar una nueva suscripción. SubscriptionDetailCreation: type: object properties: payment_type: $ref: "#/components/schemas/PaymentTypeCreation" shippings: type: array items: $ref: "#/components/schemas/Shipping" PaymentDate: required: - day type: object properties: day: description: Fecha de pago del nuevo cargo. type: integer minimum: 1 maximum: 31 example: 25 description: Conjunto de datos para actualizar la fecha de pago. SubscriptionCancel: required: - seller_id - status_details type: object properties: seller_id: $ref: "#/components/schemas/seller_id" status_details: description: Detalles del estado de la suscripción recurrente. type: string example: Subscription Plan flex successfully created maxLength: 500 FloatingDataProjection: type: object properties: new_date: type: string format: date new_amount: type: integer format: int32 Projection: required: - amount - date type: object properties: installment: type: integer format: int32 date: type: string format: date amount: type: integer format: int32 floating_data: $ref: "#/components/schemas/FloatingDataProjection" AmountProjection: required: - amount type: object properties: amount: type: integer format: int32 projection: type: array items: $ref: "#/components/schemas/Projection" ConfirmPayment: required: - charge_id - seller_id - status_details type: object properties: seller_id: $ref: "#/components/schemas/seller_id" status_details: description: Detalles del estado de la suscripción recurrente. type: string example: Subscription Plan flex successfully created maxLength: 500 charge_id: description: Identificador del cargo. type: string minLength: 36 maxLength: 36 format: uuidv4v4 example: 52bc81b2-f079-4f7b-b63a-f653ff29d794 description: Solicitud que contiene datos para confirmar el pago de un cargo de suscripción. ReplaceCreditCard: required: - number_token type: object properties: number_token: type: string description: Número de tarjeta tokenizado. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 cardholder_name: type: string description: Nombre del comprador impreso en la tarjeta. Obligatorio si los detalles de la tarjeta no se almacenaron permanentemente con el token. maxLength: 26 example: JOAO DA SILVA brand: type: string description: Bandera. (También se usa en la lucha contra el fraude). Obligatorio si los detalles de la tarjeta no se almacenaron permanentemente con el token. example: mastercard enum: - Mastercard - Visa - Amex - link - Hipercard maxLength: 50 expiration_month: type: string description: Mes de caducidad de la tarjeta de dos dígitos. Obligatorio si los detalles de la tarjeta no se almacenaron permanentemente con el token. minLength: 2 maxLength: 2 example: "12" expiration_year: type: string description: Año de caducidad de la tarjeta de dos dígitos. Obligatorio si los detalles de la tarjeta no se almacenaron permanentemente con el token. minLength: 2 maxLength: 2 example: "28" bin: type: string description: Los seis primeros números de la tarjeta. minLength: 6 maxLength: 9 example: "123412" wallet: $ref: "#/components/schemas/Wallet" tokenization: $ref: "#/components/schemas/Tokenization" description: Conjunto de datos para actualizar los datos de pago de la suscripción. FloatingDataResponse: required: - subscription_id type: object properties: subscription_id: type: string format: uuid floating_data: type: array items: $ref: "#/components/schemas/FloatingData" FloatingDataRemoveResponse: type: object properties: subscription_id: type: string format: uuid description: Identificador de firma de recurrencia. minLength: 36 maxLength: 36 example: 9aca75f2-bb03-42d7-aa09-7e46409ded26 floating_data: type: array description: Lista de cargos con cambios de fecha o importe items: $ref: "#/components/schemas/FloatingDataWithDetails" FloatingDataWithDetails: required: - installment type: object properties: installment: minimum: 1 type: integer description: Número de la cuota a la que se aplicará el cambio. format: int32 example: 2 amount: minimum: 0 type: integer description: Nuevo importe de cargo para una parte determinada del plan. Cuando se cree una suscripción con este plan, tendrá este carácter estático; por ejemplo, para la segunda cuota, aplique la cantidad de 10,00 reales. Ese valor puede ser cero, superior o inferior al valor original del Plan. example: 19990 FloatingDataUpdate: type: object properties: new_amount: type: integer example: 19990 description: Nuevo importe de cargo. minimum: 0 new_scheduled_date: type: string format: YYYY-MM-DD description: Nueva fecha de facturación example: 2020-06-10 maxLength: 12 description: Solicitud que contiene datos para registrar una nueva suscripción. PlanMigrationRequest: required: - from - to type: object properties: from: type: string format: uuid description: Identificador del plan original, es decir, el plan_id original de la suscripción. to: type: string format: uuid description: Identificador del plan objetivo, es decir, el plan_id al que desea migrar la suscripción. description: Datos de migración de planes de suscripción. Order: required: - order_id type: object properties: order_id: type: string sales_tax: type: integer format: int32 product_type: type: string enum: - cash_carry - digital_content - digital_goods - gift_card - physical_goods - renew_subs - shareware - service Card: required: - bin - cardholder_name - expiration_month - expiration_year - number_token type: object properties: card_id: type: string bin: type: string number_token: type: string cardholder_name: type: string security_code: type: string brand: type: string enum: - Mastercard - Visa - Amex - Elo - Hipercard - Maestro expiration_month: type: string expiration_year: type: string PaymentResponseCharge: required: - amount - charge_id - customer_id - seller_id - subscription_id type: object properties: seller_id: type: string charge_id: type: string subscription_id: type: string customer_id: type: string amount: type: integer format: int32 order: $ref: "#/components/schemas/Order" plan: $ref: "#/components/schemas/PlanCharge" credit: $ref: "#/components/schemas/Card" payment: $ref: "#/components/schemas/PaymentDataResponse" charge_status: type: string enum: - processing - paid - canceled - undo_failed - scheduled - payment_pending - denied - suspended - free PlanCharge: required: - period - plan_id type: object properties: plan_id: type: string amount: type: integer format: int32 name: type: string floating_data: type: array items: $ref: "#/components/schemas/FloatingDataPlan" period: $ref: "#/components/schemas/Period" consultaBinResponse: title: Consulta a Bin Response type: object properties: results: type: array items: $ref: "#/components/schemas/results" status: type: string description: Mensaje de devolución del estado de BIN. xml: name: consultaBinResponse attribute: false wrapped: false results: title: resultados type: object properties: bin: type: integer description: BIN de la consulta. brand: type: string description: Nombre de la bandera. brand_code: type: integer description: Código de bandera. brazilian_issued: type: string description: Indica si el emisor es de Brasil. country: type: string description: Nombre del país. country_code: type: string description: Código numérico de país. country_code_iso: type: string description: Código de país ISO_3166-1. issuer: type: string description: Nombre del emisor. product: type: string description: Producto vinculado a BIN. type: type: string description: Tipo de BIN (crédito, débito, prepago). enum: - credit - debit - prepaid description: Lista de información de BIN. xml: name: results attribute: false wrapped: false split_data: type: object required: - subseller_list_payment properties: subseller_list_payment: type: array description: Lista de tiendas y sus montos de pago adeudados. items: type: object required: - subseller_id - document_number - subseller_sale_amount - items properties: subseller_id: maxLength: 25 minLength: 0 type: string description: ID de subvendedor registrado en la plataforma de mercado (MGM). example: "700104158" document_type: maxLength: 4 minLength: 3 type: string description: Tipo de documento de subcomercio. example: CNPJ enum: - CPF - CNPJ document_number: maxLength: 15 minLength: 11 type: string description: Número de documento de subcontratación sin signos de puntuación. (sin máscara) example: "12345678912" subseller_sale_amount: type: integer description: Parte del valor de tienda en relación con el pedido (en centavos). example: 118708 items: type: array description: Lista de artículos de subtrade. items: type: object required: - id - description - amount properties: id: maxLength: 25 minLength: 1 type: string description: Identificador de artículo/producto. example: MR1 description: type: string description: Descripción del artículo/producto. example: Product MR1. amount: type: integer description: Valor del artículo/producto (en centavos). example: 118708 transaction_rate_percent: type: number description: "La tarifa que se cobrará por el artículo en porcentaje si no se envía, la tarifa se establecerá igual a la del registro.
Si se informa a transaction_rate_percent, no se debe enviar el importe de la transacción.
Nota: Si se envían transaction_rate_percent y transaction_rate_amount para el mismo artículo, los valores se sumarán." example: 1.2 transaction_rate_amount: type: integer description: "La tarifa que se cobrará por el valor del artículo (en centavos) si no envías la tarifa se fijará igual que la de registro.
Si se informa a transaction_rate_amount, no se debe enviar el transaction_rate_percent.
Nota: Si transaction_rate_percent y transaction_rate_amount se envían al mismo artículo, se añadirán los valores." example: 235 payment_plan: type: integer description: Plan de pago para subvendedores. example: 3 description: Datos para el pago fraccionado. Campo obligatorio para fraccionar el pago. rates: type: array description: Lista de tarifas. items: type: object required: - key - value properties: key: type: string description: Identificador de tarifas. example: iva value: type: number description: Valor en porcentaje. example: 8 DeviceDTO: type: object description: Conjunto de datos relativos al dispositivo utilizado por el comprador.
Campos obligatorios para la lucha contra el fraude required: - ip_address - device_id - finger_print properties: ip_address: type: string description: cadena de dirección IP (IPv4) del dispositivo del comprador. La aplicación debe capturar este atributo desde el dispositivo del comprador (dispositivo móvil, navegador, etc.) y enviarlo como carga útil para enriquecer nuestros análisis preventivos. example: 10.0.0.1 device_id: type: string description: ID único del dispositivo. example: ae44e06c-3e85-44af-8542-bcaccd54ef2e finger_print: type: string description: Hash de identificación (huella digital del dispositivo) del dispositivo. example: aGVsbG8td29ybGQtZGV2aWNlLWlkCg== CustomerDTOAddData: type: object properties: document_type: type: string example: CPF description: Tipo de documento de identificación del comprador. Obligatorio para el billete.

Valores sugeridos CPF, CNPJ, RNE, RG, CNAE, UYCI, PASAPORTE o documento de acuerdo con la legislación vigente en el país de origen. Consulta aquí todos los tipos aceptados.

Campo obligatorio para Antifraude document_number: type: string example: 2441356709 description: Número de documento del comprador sin signos de puntuación.
(sin máscara) Campo obligatorio para la lucha contra el fraude email: type: string example: aceiti@getnet.com.br description: Correo electrónico del comprador
. Campo obligatorio para la lucha contra el fraude name: type: string example: Jose da Silva description: Nombre del comprador
. Campo obligatorio para la lucha contra el fraude phone_number: type: string example: 11999999999 description: Número de teléfono del comprador
. Campo obligatorio para la lucha contra el fraude billing_address: $ref: "#/components/schemas/BillingAddressDTO" shippings: $ref: "#/components/schemas/ShippingsDTO" BillingAddressDTO: type: object properties: street: type: string description: calle.
Campo obligatorio para Antifraude number: type: string description: Número de calle.
Campo obligatorio para la lucha contra el fraude district: type: string description: Distrito.
Campo obligatorio para la lucha contra el fraude city: type: string description: Ciudad.
Campo obligatorio para la lucha contra el fraude state: type: string description: Estado (UF).
Campo obligatorio para la lucha contra el fraude country: type: string description: País.

Informe en la norma ISO 3166-1 alpha-3, por ejemplo, «BRA», «USA» y «ARG», campo obligatorio para la lucha contra el fraude postal_code: type: string description: Código postal, CEP en Brasil o ZIP en los Estados Unidos.
(sin máscara) Campo obligatorio para la lucha contra el fraude complement: type: string description: Complemento de dirección.
Campo obligatorio para la lucha contra el fraude type: type: string enum: - RESIDENCIAL - INSTALACAO - CORRESPONDENCIA - FISCAL - COBRANCA ShippingsDTO: type: object properties: address: type: string description: Conjunto de datos relativos a la dirección del comprador street: type: string number: type: string district: type: string city: type: string country: type: string postal_code: type: string complement: type: string type: type: string PixDTO: required: - amount - currency - idempotency_key type: object properties: amount: $ref: "#/components/schemas/amount" currency: $ref: "#/components/schemas/currency" order_id: $ref: "#/components/schemas/order_id" customer_id: type: string description: > Identificador de comprador utilizado en el comercio electrónico. Tenga en cuenta que se incluirá en la notificación de pago de PIX. maxLength: 36 idempotency_key: maxLength: 64 minLength: 1 type: string description: La clave de idempotencia, utilizada para controlar las solicitudes, debe ser única por solicitud, ya que si se repite, siempre se devolverán los mismos datos. example: 1eb2412c-165a-41cd-b1d9-76c575d30a21 Payment: type: object properties: payment_id: type: string description: Identificador de pago. maxLength: 36 minLength: 36 format: uuidv4 example: cd966c8a-cda4-4ea6-8d20-bfdd1c3da312 status: type: string description: Estado de la transacción. Para obtener más información sobre el estado de la devolución, consulte Notificaciones 1.1 maxLength: 8 example: WAITING enum: - PENDING - WAITING - EXPIRED - ERROR - APPROVED - DENIED description: type: string description: | Texto con un mensaje que describa el resultado de la solicitud. example: The QR Code was successfully generated and awaiting payment. additional_data: type: object description: > Grupo de información adicional sobre el resultado de la solicitud de una transacción con código QR o PIX. properties: transaction_id: type: string description: > Identificador de la transacción iniciada tras la generación del código QR PIX con la institución. example: 9000TRXIDdnmnefxzmvfckki qr_code: type: string description: > Carga útil del código QR PIX generado. Con este texto será posible presentarlo en modo gráfico o el cliente podrá pagarlo mediante la función «Copiar y pegar» de PIX. example: 00020101021226740014br.gov.bcb.pix210812345678 22041234230812345678242000112233445566778899520400005303986540690005802BR5913JOHN DOE6008SAO PAULO62190515RP12345678-201980720014br.gov.bcb.pix2550bx.com.br/spi/U0VHUkVET1RPVEFMTUVOVEVBTEVBVE9SSU8=630434D1 creation_date_qrcode: type: string description: Fecha de creación del código QR generado. format: YYYY-MM-DDTHH:MM:SSZ example: 2022-06-08T10:55:07.890 expiration_date_qrcode: type: string description: Fecha de caducidad del código QR generado. format: YYYY-MM-DDTHH:MM:SSZ example: 2022-06-08T10:56:07.890 psp_code: type: string description: > Código PSP del destinatario. PSP (proveedor de servicios de pago), que es la institución financiera responsable del pago o la recepción de los valores en Pix. example: 45454 idempotency_key: maxLength: 64 minLength: 1 type: string description: La clave de idempotencia, utilizada para controlar las solicitudes, debe ser única por solicitud, ya que si se repite, siempre se devolverán los mismos datos. example: 1eb2412c-165a-41cd-b1d9-76c575d30a21 quote_id: type: string description: ID de cotización que se utilizará en la consulta format: uuidv4 example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e" CombinedPaymentDTO: type: object properties: request_id: title: id_de solicitud type: string example: daac03dc-73db-453f-9bea-b1391669d5d3 minLength: 36 maxLength: 36 format: uuid description: Identificador de solicitud. Único para cada solicitud order_id: $ref: "#/components/schemas/order_id" data: $ref: "#/components/schemas/CombinedDataDTO" additional_data: type: object additionalProperties: type: object CombinedDataDTO: required: - payments description: Conjunto de datos que se va a cifrar type: object properties: amount: $ref: "#/components/schemas/amount" currency: $ref: "#/components/schemas/currency" customer_id: $ref: "#/components/schemas/customer_id" payments: type: array items: $ref: "#/components/schemas/CombinedPaymentDataDTO" sub_merchant: $ref: "#/components/schemas/SubMerchantDTO" additional_data: type: object additionalProperties: type: object CombinedPaymentDataDTO: type: object properties: idempotency_key: $ref: "#/components/schemas/idempotency_key" payment_id: $ref: "#/components/schemas/payment_id" amount: $ref: "#/components/schemas/amount" payment_method: $ref: "#/components/schemas/payment_method" save_card_data: type: boolean example: false default: false description: Determina si la tarjeta debe guardarse para compras futuras. Solo para clientes que utilizan la bóveda de GetNet. transaction_type: type: string description: Tipo de transacción. Pago en efectivo o en cuotas al minorista o en cuotas al emisor. example: FULL enum: - FULL - INSTALL_NO_INTEREST - INSTALL_WITH_INTEREST number_installments: type: number example: 1 description: Número de cuotas. soft_descriptor: $ref: "#/components/schemas/soft_descriptor" dynamic_mcc: type: number example: 1234 description: Campo utilizado para indicar la transacción con otro código de categoría de comerciante (código de categoría de establecimiento) diferente del registrado. Si se envía un MCC no válido, se utilizará el predeterminado. Envía solo datos numéricos. card: $ref: "#/components/schemas/CardDTO" tokenization: $ref: "#/components/schemas/TokenizationDTO" wallet: $ref: "#/components/schemas/WalletCreditDTO" xid: type: string description: Campo disponible a partir de la versión 2.0. Identificador MPI para cada transacción autenticada. El contenido del campo puede ser un valor HEXA o Base64, según el MPI utilizado. maxLength: 40 example: test ucaf: type: string description: Campo disponible a partir de la versión 2.0. Código de autenticación cifrado por la bandera. El contenido del campo puede ser un valor HEXA o Base64, según el MPI utilizado. maxLength: 40 example: string eci: type: string description: Campo disponible a partir de la versión 2.0. Código ECI de la transacción autenticada con 3D Secure. Generado por un MPI externo. maxLength: 2 example: "00" tdsdsxid: type: string description: Identificador de transacciones de la versión 2 del servidor 3DS. example: string tdsver: type: string description: Indica la versión 3DS utilizada en la autenticación, example: 2.1.0 is_pre_paid: type: boolean network_token: type: string description: El token de la tarjeta que se utilizará para generar el criptograma. example: 1b110aaa71934ae492bff48baab9af81 payment_tag: type: string description: Necesario para dividir billing_address: $ref: "#/components/schemas/BillingAddressDTO" installment: $ref: "#/components/schemas/InstallmentCuotesDTO" cross_border_data: $ref: "#/components/schemas/CrossBorderDataDTO" CrossBorderDataDTO: type: object properties: first_name: description: Nombre del comprador. type: string maxLength: 40 example: John last_name: description: Apellido del comprador. type: string maxLength: 80 example: da Silva type: type: string description: Campo que informa el tipo de comprador, siendo «INDIVIDUAL» para una persona física y «EMPRESA\» para una persona jurídica. enum: - INDIVIDUAL - COMPANY document_number: type: string email: type: string description: Necesario para el mercado de divisas (transfronterizo) CombinedResponseDTOCombinedAutorizationResponseDataDTO: type: object properties: seller_id: $ref: "#/components/schemas/seller_id" request_id: $ref: "#/components/schemas/request_id" order_id: $ref: "#/components/schemas/order_id" amount: $ref: "#/components/schemas/amount" combined_id: type: string description: Código de identificación de pago combinado. example: 66f36211-3a61-41fa-8747-052c451e89ad payments: type: array items: $ref: "#/components/schemas/CombinedAutorizationResponseDataDTO" CombinedAutorizationResponseDataDTO: type: object properties: idempotency_key: $ref: "#/components/schemas/idempotency_key" payment_id: $ref: "#/components/schemas/payment_id" status: type: string payment_method: $ref: "#/components/schemas/payment_method" received_at: $ref: "#/components/schemas/received_at" transaction_id: $ref: "#/components/schemas/transaction_id" original_transaction_id: type: string example: "6534812321501821" description: Identificador de transacción original authorized_at: $ref: "#/components/schemas/authorized_at" reason_code: $ref: "#/components/schemas/reason_code" reason_message: $ref: "#/components/schemas/reason_message" acquirer: $ref: "#/components/schemas/acquirer" soft_descriptor: $ref: "#/components/schemas/soft_descriptor" brand: $ref: "#/components/schemas/brand" authorization_code: $ref: "#/components/schemas/authorization_code" acquirer_transaction_id: $ref: "#/components/schemas/acquirer_transaction_id" eci: $ref: "#/components/schemas/eci" payment_received_timestamp: type: string format: date-time card_id: maxLength: 36 type: string description: El identificador de la tarjeta guardado en la caja fuerte se puede usar para recuperar un number_token válido para compras futuras, así como para eliminar las tarjetas guardadas. example: e8ad2ae4-9e3e-4532-998f-1a5a11e56e58 merchant_advice_code: type: string description: código_de_consejería para comerciantes. amount: $ref: "#/components/schemas/amount" currency: $ref: "#/components/schemas/currency" CombinedOperationsRequestDTOCombinedCapturetDataDTO: type: object properties: request_id: $ref: "#/components/schemas/request_id" payments: type: array items: $ref: "#/components/schemas/CombinedCapturetDataDTO" additional_data: type: object additionalProperties: type: object CombinedCapturetDataDTO: type: object properties: idempotency_key: $ref: "#/components/schemas/idempotency_key" payment_id: $ref: "#/components/schemas/payment_id" amount: $ref: "#/components/schemas/amount" payment_method: $ref: "#/components/schemas/payment_method" CombinedResponseDTOCaptureResponseDTO: type: object properties: seller_id: $ref: "#/components/schemas/seller_id" request_id: $ref: "#/components/schemas/request_id" order_id: $ref: "#/components/schemas/order_id" amount: $ref: "#/components/schemas/amount" combined_id: type: string description: Código de identificación de pago combinado. example: 66f36211-3a61-41fa-8747-052c451e89ad payments: type: array items: $ref: "#/components/schemas/CaptureResponseDTO" CombinedOperationsRequestDTOCombinedCancelDataDTO: type: object properties: request_id: $ref: "#/components/schemas/request_id" payments: type: array items: $ref: "#/components/schemas/CombinedCancelDataDTO" additional_data: type: object additionalProperties: type: object CombinedCancelDataDTO: type: object properties: idempotency_key: $ref: "#/components/schemas/request_id" payment_id: $ref: "#/components/schemas/payment_id" amount: $ref: "#/components/schemas/amount" payment_method: $ref: "#/components/schemas/payment_method" custom_key: $ref: "#/components/schemas/custom_key" payment_tag: type: string description: Necesario para dividir CombinedResponseDTOCancelResponseDTO: type: object properties: seller_id: $ref: "#/components/schemas/seller_id" request_id: $ref: "#/components/schemas/request_id" order_id: $ref: "#/components/schemas/order_id" amount: $ref: "#/components/schemas/amount" combined_id: type: string description: Código de identificación de pago combinado. example: 66f36211-3a61-41fa-8747-052c451e89ad payments: type: array items: $ref: "#/components/schemas/CancelResponseDTO" CombinedReleaseDTO: type: object properties: release_payment_date: type: string previous_release_payment_date: type: string subseller_id: maxLength: 25 minLength: 0 type: string description: ID de subvendedor registrado en la plataforma de mercado (MGM). example: "700104158" order_item_release: type: array items: $ref: "#/components/schemas/OrderItemReleaseDTO" combined_id: type: string MgmReleaseSubSellerPaymentResponse: type: object properties: success: type: boolean errors: type: array items: $ref: "#/components/schemas/Errors" item_id: type: string Errors: type: object properties: cod_error: type: integer format: int32 message: type: string ValidationsDTO: type: object properties: token: type: string EnrolmentsInitialDTO: type: object properties: currency: type: string md: $ref: "#/components/schemas/md" term_url: type: string amount: type: integer format: int32 payment_method: $ref: "#/components/schemas/PaymentMethod" description: type: string operation: type: string extra_fields: $ref: "#/components/schemas/ExtraFields" PaymentMethod: required: - expiration_month - expiration_year - number_token - security_code type: object properties: number_token: type: string security_code: type: string expiration_month: type: string expiration_year: type: string ExtraFields: type: object properties: billing_address: type: object description: Estructura de datos que contiene detalles de la dirección de envío required: - street - number - country - postal_code properties: street: type: string description: Nombre de una calle o vía maxLength: 60 example: Av. Brasil number: type: string description: Número que identifica la posición de un edificio en una calle maxLength: 10 example: "1000" complement: type: string description: Información de dirección adicional maxLength: 60 example: Sala 1 district: type: string description: Nombre de un distrito, por ejemplo, una parte de una ciudad o región maxLength: 40 example: São Geraldo city: type: string description: >- Nombre de un área urbanizada con límites definidos y un gobierno local. El valor se basa en la norma ISO 3166-2, según el país definido en los detalles de la dirección. maxLength: 40 example: Porto Alegre state: type: string description: >- Nombre de una comunidad política organizada o área que forma parte de una federación. El valor se basa en la norma ISO 3166-2, según el país definido en los detalles de la dirección. maxLength: 20 example: RS country: type: string description: >- Código de país. El valor se basa en la norma ISO 3166-1 alpha-2 (https://www.iso.org/obp/ui/#search/code/). maxLength: 2 example: BR postal_code: type: string description: >- Código postal o postal. El valor consiste en un grupo de letras o números que se agrega a una dirección postal para facilitar la clasificación del correo. maxLength: 8 example: "90230060" reference: type: string description: Detalles del punto de referencia que se pueden usar para ayudar a localizar la dirección maxLength: 80 example: Near the hospital shipping_address: type: object description: Estructura de datos que contiene detalles de la dirección de envío required: - street - number - country - postal_code properties: street: type: string description: Nombre de una calle o vía maxLength: 60 example: Av. Brasil number: type: string description: Número que identifica la posición de un edificio en una calle maxLength: 10 example: "1000" complement: type: string description: Información de dirección adicional maxLength: 60 example: Sala 1 district: type: string description: Nombre de un distrito, por ejemplo, una parte de una ciudad o región maxLength: 40 example: São Geraldo city: type: string description: >- Nombre de un área urbanizada con límites definidos y un gobierno local. El valor se basa en la norma ISO 3166-2, según el país definido en los detalles de la dirección. maxLength: 40 example: Porto Alegre state: type: string description: >- Nombre de una comunidad política organizada o área que forma parte de una federación. El valor se basa en la norma ISO 3166-2, según el país definido en los detalles de la dirección. maxLength: 20 example: RS country: type: string description: >- Código de país. El valor se basa en la norma ISO 3166-1 alpha-2 (https://www.iso.org/obp/ui/#search/code/). maxLength: 2 example: BR postal_code: type: string description: >- Código postal o postal. El valor consiste en un grupo de letras o números que se agrega a una dirección postal para facilitar la clasificación del correo. maxLength: 8 example: "90230060" reference: type: string description: Detalles del punto de referencia que se pueden usar para ayudar a localizar la dirección maxLength: 80 example: Near the hospital InitialResponseDTO: type: object properties: transaction_id: type: string md: $ref: "#/components/schemas/md" tx_id: type: integer format: int32 xid: type: string description: >- ID de transacción devuelto por el emisor de la tarjeta. El valor es de 28 bytes (un valor único de 20 bytes codificado en Base64). example: VDdnR0kyU1g4ZXlxMkhWTlp0VnA= protocol: type: string description: Protocolo 3DS utilizado durante el procesamiento example: 3DS2.2.0 status: $ref: "#/components/schemas/StatusTransaction" operation: type: string description: Tipo de operación de tarjeta example: CREDIT enum: - CREDIT - DEBIT default: CREDIT tds_method_content: type: string description: Fragmento HTML completo que debe renderizarse en el navegador del cliente example: redirect_html_template: type: string description: Plantilla HTML para redirigir al cliente al flujo de autenticación del emisor de la tarjeta example: | 3D Secure Processing

3D Secure Processing

extra_fields: $ref: "#/components/schemas/ExtraFields" StatusTransaction: type: string description: Estado de las transacciones generadas por el proceso de inscripción example: Pending enum: - Authenticated - Denied - Pending - Pending Challenge - Pending Enrolment Continue ValidationsResponseDTO: type: object properties: transaction_id: $ref: "#/components/schemas/transaction_id" md: $ref: "#/components/schemas/md" tx_id: $ref: "#/components/schemas/tx_id" xid: $ref: "#/components/schemas/xid" status: $ref: "#/components/schemas/status3DS" protocol: $ref: "#/components/schemas/protocol3DS" operation: $ref: "#/components/schemas/operation" eci: $ref: "#/components/schemas/eci" cavv: $ref: "#/components/schemas/cavv" ds_trans_id: $ref: "#/components/schemas/ds_trans_id" EnrolmentsContinueDTO: type: object properties: transaction_id: $ref: "#/components/schemas/transaction_id" xid: $ref: "#/components/schemas/xid" ContinueResponseDTO: type: object properties: transaction_id: $ref: "#/components/schemas/transaction_id" md: $ref: "#/components/schemas/md" tx_id: $ref: "#/components/schemas/tx_id" xid: $ref: "#/components/schemas/xid" status: $ref: "#/components/schemas/status3DS" protocol: $ref: "#/components/schemas/protocol3DS" operation: $ref: "#/components/schemas/operation" redirect_html_template: $ref: "#/components/schemas/redirect_html_template" ds_trans_id: $ref: "#/components/schemas/ds_trans_id" eci: $ref: "#/components/schemas/eci" cavv: $ref: "#/components/schemas/cavv" Airlines: type: object required: - agency_invoice_number description: Estructura de datos que contiene detalles de la aerolínea. Se aplica solo a las transacciones aéreas. properties: passenger_code: type: string description: >- Clave de archivo del registro de nombres de pasajeros (PNR). Este campo es obligatorio para las transacciones con una tarjeta UATP AirPlus. maxLength: 255 example: "1234567890" company_id: type: string description: "" maxLength: 255 example: "1220" airline_code: type: string description: Código IATA (Asociación de Transporte Aéreo Internacional) de 3 dígitos utilizado para identificar a la compañía minLength: 3 maxLength: 3 example: "022" travel_agency_code: type: string description: Número IATA o número ARC (Airlines Reporting Corporation) de la agencia de viajes que emitió el billete minLength: 1 maxLength: 8 example: s517 ticket_number: type: array items: type: string description: |- Número de billete único. El número de billete se utiliza para todos los tramos del viaje. minLength: 1 maxLength: 13 example: - "125769" dccDTO: type: object description: Estructura de datos que contiene detalles de conversión dinámica de divisas. properties: currency: type: string amount: type: number format: double conversion_rate: type: number format: double date: type: string markup: type: number format: double source: type: object properties: id: type: string description: Se recibió el campo fx_rate_id en el recurso CrossBorder name: type: string default: tradefx crossBorderDTO: type: object required: - consumer_data description: Estructura de datos que contiene datos sobre transacciones transfronterizas (FX). properties: consumer_data: type: object required: - email - first_name - last_name - legal_name - document_number - type description: Datos de clientes properties: email: type: string description: Dirección de correo electrónico que se utilizará para enviar el recibo de la transacción transfronteriza example: customer@email.com first_name: type: string description: Nombre del cliente. Obligatorio cuando el tipo = INDIVIDUAL. example: John last_name: type: string description: Apellido del cliente. Obligatorio cuando el tipo = INDIVIDUAL. example: Doe legal_name: type: string description: Nombre de la empresa. Obligatorio cuando el tipo = EMPRESA. example: ABC Corporation document_number: type: string description: Número de documento del cliente. example: "80026928027" type: type: string description: Tipo de cliente. example: INDIVIDUAL enum: - INDIVIDUAL - COMPANY ValidateCustomerDTO: type: object properties: first_name: type: string description: Nombre del cliente. Obligatorio cuando el tipo = INDIVIDUAL. example: John last_name: type: string description: Apellido del cliente. Obligatorio cuando el tipo = INDIVIDUAL. example: Doe legal_name: type: string description: Nombre de la empresa. Obligatorio cuando el tipo = EMPRESA. example: ABC Corporation document_number: type: string description: Número de documento del cliente. example: "80026928027" type: type: string description: Tipo de cliente. example: INDIVIDUAL enum: - INDIVIDUAL - COMPANY ValidateCustomerResponseDTO: type: object properties: id: type: string description: Identificador de cliente único first_name: type: string description: Nombre del cliente. Solo se devuelve cuando el tipo = INDIVIDUAL. example: John last_name: type: string description: Apellido del cliente. Solo se devuelve cuando el tipo = INDIVIDUAL. example: Doe legal_name: type: string description: Nombre de la empresa. Solo se devuelve cuando el tipo = EMPRESA. example: ABC Corporation document_number: type: string description: Número de documento del cliente. example: "80026928027" type: type: string description: Tipo de cliente. example: INDIVIDUAL enum: - INDIVIDUAL - COMPANY status: type: string description: Estado de validación del cliente. El estado PENDIENTE significa que la revisión del cliente aún no se ha completado. El estado RECHAZADO significa que el cliente no ha podido realizar la revisión y, por lo tanto, no puede completar la compra. El estado APROBADO significa que el cliente está al día y puede continuar. example: APPROVED enum: - PENDING - APPROVED - REJECTED