Configuración vía API
Este documento se aplica a los siguientes países:
| Argentina | Brasil | Chile | México | Portugal | España | Uruguay |
|---|
Para otros países, consulte el documento Configuración vía Portal.
Para configurar Web Checkout vía API, debe seguir los tres pasos.
Paso 1: Obtener los datos de registro del vendedor
Este paso solo es obligatorio si es la primera vez que el vendedor configura Web Checkout.
Para enviar esta solicitud, debe proporcionar un seller ID en el path de la solicitud.
| Campo | Tipo | Descripción | Ejemplo | Requerido |
|---|---|---|---|---|
sellerID | String | Seller ID que se utilizará en la consulta. | 672c0dd1-28b1-4136-b230-de68c1b92ae0 | ✅ |
Request
Ejemplo de solicitud:
curl https://api.globalgetnet.com/dpy/web-checkout/v1/sellers \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'200 Response
Ejemplo de respuesta:
{
"type": "object",
"description": "Response to an BR seller request",
"properties": {
"seller_id": {
"type": "string",
"writeOnly": true,
"format": "uuid",
"example": "a9c99f03-025c-4251-a9f5-de73ef593523"
},
"merchant_id": {
"type": "string",
"writeOnly": true,
"format": "uuid",
"example": "ecd1c020-dd5f-4511-8006-88ad6b3459db"
},
"seller_code": {
"type": "string",
"writeOnly": true,
"example": "0000012345"
},
"trade_name": {
"type": "string",
"writeOnly": true,
"example": "Smart Shop"
},
"email": {
"type": "string",
"writeOnly": true,
"format": "email",
"example": "[email protected]"
},
"country": {
"type": "string",
"writeOnly": true,
"example": "BR"
},
"currencies": {
"type": "array",
"writeOnly": true,
"items": {
"type": "string"
},
"example": [
"BRL"
]
},
"payments": {
"type": "object",
"writeOnly": true,
"properties": {
"instant_payment": {
"type": "object",
"properties": {
"enable": {
"type": "boolean"
}
}
},
"bankslip": {
"type": "object",
"properties": {
"enable": {
"type": "boolean"
}
}
},
"credit": {
"type": "object",
"properties": {
"enable": {
"type": "boolean"
},
"brands": {
"type": "array",
"items": {
"type": "object",
"properties": {
"enable": {
"type": "boolean"
},
"brand": {
"type": "string",
"example": "VISA"
},
"currencies": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"BRL"
]
},
"threeds": {
"type": "boolean"
},
"suported_installments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"schema": {
"type": "string",
"example": "with_interest"
},
"schema_name": {
"type": "string",
"example": "Issuer Plan",
"nullable": true
},
"installments": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
1,
2,
3,
4
]
},
"installments_with_interest": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
3,
4
]
}
}
},
"nullable": true
}
}
}
}
}
},
"debit": {
"type": "object",
"properties": {
"enable": {
"type": "boolean"
},
"brands": {
"type": "array",
"items": {
"type": "object",
"properties": {
"enable": {
"type": "boolean"
},
"brand": {
"type": "string",
"example": "VISA"
},
"currencies": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"BRL"
]
},
"threeds": {
"type": "boolean"
},
"suported_installments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"schema": {
"type": "string",
"example": "no_interest"
},
"schema_name": {
"type": "string",
"example": "Merchant Installment",
"nullable": true
},
"installments": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
1,
2,
3,
4
]
},
"installments_with_interest": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
3,
4
]
}
}
},
"nullable": true
}
}
}
}
}
}
}
}
}
}Con la información de la respuesta, puede continuar con la configuración de Web Checkout vía API.
Paso 2: Enviar la configuración técnica
En el paso de configuración técnica, los comercios pueden personalizar la apariencia de la interfaz de Web Checkout que ven los clientes. Esto permite alinear la experiencia de checkout con la identidad de marca del sitio de comercio electrónico del comercio.
Las opciones de personalización disponibles incluyen color de marca, color de acento y tipografía. Además, el vendedor configurará las URLs de redirección. Estas URLs envían a los clientes a endpoints predefinidos cuando una transacción se aprueba o se rechaza durante el proceso de checkout.
Se deben proporcionar dos URLs:
- Success: para transacciones aprobadas.
- Error: para transacciones rechazadas.
Ambas URLs son obligatorias para completar correctamente la integración.
Se debe proporcionar una notificación webhook, junto con un usuario y una contraseña.
La siguiente tabla enumera los campos que se deben enviar.
| Campo | Tipo | Descripción | Ejemplo | Requerido |
|---|---|---|---|---|
success_url | String | URL de redirección en caso de checkout exitoso. | https://www.google.com/success | ✅ |
error_url | String | URL de redirección en caso de error durante el checkout. | https://www.google.com/error | ✅ |
url | String | URL del webhook para recibir notificaciones de pago. | https://webhook/bce0b3b3-49b6-4680-88d7-4e23131d91b2 | ✅ |
user | String | Usuario para la autenticación del webhook. | 1cb9c739-8452-4436-816b-a833960b7680 | ✅ |
password | String | Contraseña para la autenticación del webhook. | 78ce12f6-665b-4354-8eaf-f0384413aaa8 | ✅ |
hide_getnet_logo | Boolean | Oculta el logo de Getnet en el checkout cuando se establece en true. | true o false | — |
Request
Ejemplo de solicitud:
curl https://api.globalgetnet.com/dpy/web-checkout/v1/technical-configurations/672c0dd1-28b1-4136-b230-de68c1b92ae0 \
--request PUT \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"layout_customization": {
"color": {
"primary": "#de3131",
"accent": "#257FA4"
},
"type_face": "Open Sans",
"hide_getnet_logo": "false"
},
"success_url": "https://www.google.com/success",
"error_url": "https://www.google.com/error",
"notification": {
"url": "https://webhook/bce0b3b3-49b6-4680-88d7-4e23131d91b2",
"authentication_type": "user_credentials",
"user_credentials": {
"user": "1cb9c739-8452-4436-816b-a833960b7680",
"password": "78ce12f6-665b-4354-8eaf-f0384413aaa8"
}
}
}'200 Response
Ejemplo de respuesta:
{
"layout_customization": {
"color": {
"primary": "#de3131",
"accent": "#257FA4"
},
"type_face": "Open Sans",
"hide_getnet_logo": "false"
},
"success_url": "https://www.google.com/success",
"error_url": "https://www.google.com/error",
"notification": {
"url": "https://webhook/bce0b3b3-49b6-4680-88d7-4e23131d91b2",
"authentication_type": "user_credentials",
"user_credentials": {
"user": "1cb9c739-8452-4436-816b-a833960b7680"
}
}
}Paso 3: Enviar la configuración de negocio
Los comercios pueden configurar opcionalmente su experiencia de checkout habilitando o deshabilitando operaciones de pago específicas. Estas configuraciones determinan qué métodos de pago, como Tarjetas de Crédito, Tarjetas de Débito, Boleto (boleta bancaria), Pix (pago instantáneo) o Código QR, se muestran durante el proceso de checkout.
También es posible configurar las opciones de cuotas disponibles para los clientes, lo que permite definir aspectos clave de la experiencia de cuotas. Estas configuraciones incluyen los planes de cuotas que se ofrecerán, el número de cuotas disponibles y la parte responsable de asumir los intereses, que puede ser asumida por el titular de la tarjeta o por el comercio.
La siguiente tabla enumera los campos que se deben enviar.
Para cada campo de tipo objeto descrito en la tabla, el parámetro enable debe completarse con true o false.
| Campo | Tipo | Descripción | Ejemplo | Requerido |
|---|---|---|---|---|
instant_payment | Object | Método de pago. | — | ✅ |
bankslip | Object | Método de pago. | — | ✅ |
credit | Object | Método de pago. | — | ✅ |
debit | Object | Método de pago. | — | ✅ |
enable | Boolean | Indica si el método de pago será aceptado. | true | ✅ |
qr_code_checkout | Object | (Solo Argentina). Muestra el Código QR como opción de pago en la pantalla de Web Checkout. | — | ✅ |
⚠️ Importante: El Código QR está disponible solo para Argentina y usa el parámetro
enable, completado contrueofalse. Cuando habilitaqr_code_checkout, el Código QR comienza a mostrarse como opción de pago en la pantalla de Web Checkout, sin cambios en su integración.
Request
Ejemplo de solicitud:
curl https://api.globalgetnet.com/dpy/web-checkout/v1/business-configurations/672c0dd1-28b1-4136-b230-de68c1b92ae0 \
--request PUT \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"instant_payment": {
"enable": true
},
"bankslip": {
"enable": true
},
"qr_code_checkout": {
"enabled": true
},
"mbway": {
"enabled": true
},
"multibanco": {
"enabled": true
},
"credit": {
"enable": true,
"brands": [
{
"enable": true,
"brand": "VISA",
"currencies": [
"BRL"
],
"threeds": true,
"suported_installments": [
{
"schema_name": "with_interest",
"installments": [
1,
2,
3
],
"installments_with_interest": [
2,
3
]
}
]
}
]
},
"debit": {
"enable": true,
"brands": [
{
"enable": true,
"brand": "VISA",
"currencies": [
"BRL"
],
"threeds": true
},
{
"enable": true,
"brand": "MASTER",
"currencies": [
"BRL"
],
"threeds": true
}
]
}
}'200 Response
Ejemplo de respuesta:
{
"instant_payment": {
"enable": true
},
"bankslip": {
"enable": true
},
"qr_code_checkout": {
"enable": true
},
"mbway": {
"enabled": true
},
"multibanco": {
"enabled": true
},
"credit": {
"enable": true,
"brands": [
{
"enable": true,
"brand": "VISA",
"currencies": [
"BRL"
],
"threeds": true,
"suported_installments": [
{
"schema_name": "plan_emisor",
"installments": [
1,
2,
3
],
"installments_with_interest": [
2,
3
]
}
]
}
]
},
"debit": {
"enable": true,
"brands": [
{
"enable": true,
"brand": "VISA",
"currencies": [
"BRL"
],
"threeds": true
},
{
"enable": true,
"brand": "MASTER",
"currencies": [
"BRL"
],
"threeds": true
}
]
}
}¡La configuración está completa!
Siguiente paso
- Después, puede crear una intención de pago. Consulte Guía Rápida: Crear un Pago
- Obtenga más información sobre Pago con Código QR - Argentina