Configure Web Checkout by API

This document applies to the following countries:

ArgentinaBrazilColombiaChileMexicoEuropeUruguay
information icon

For other countries, see the Configuration via Portal document.

To configure Web Checkout by API, follow these three steps.

Step 1: Get seller registration data

information icon
Important: This step is only required if this is the seller’s first time setting up Web Checkout.
To send this request, provide a seller ID in the request path.
FieldTypeDescriptionExampleRequired
sellerIDStringSeller ID to use in the query.672c0dd1-28b1-4136-b230-de68c1b92ae0✅

Request

Example of request:

JSON
curl https://api.globalgetnet.com/dpy/web-checkout/v1/sellers \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200 response

Example of response:

JSON
{ "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": "smartshop@mail.com" }, "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 } } } } } } } } } }

Use the information from the response to configure Web Checkout by API.

Step 2: Set the technical configuration

In this step, you can customize the appearance of the Web Checkout interface that customers see. This aligns the checkout experience with the branding of your e-commerce site.

Available customization options include brand color, accent color, and font. You also configure the redirect URLs. These URLs send customers to predefined endpoints when a transaction is approved or declined during checkout.

You must provide two URLs:

  • Success: for approved transactions.
  • Error: for declined transactions.

You need both URLs to complete the integration.

You must also provide a webhook notification, along with a username and password.

The table below lists the fields you must send.

FieldTypeDescriptionExampleRequired
success_urlStringRedirect URL in case of successful checkout.https://www.google.com/success✅
error_urlStringRedirect URL in case of an error during checkout.https://www.google.com/error✅
urlStringWebhook URL to receive payment notifications.https://webhook/bce0b3b3-49b6-4680-88d7-4e23131d91b2✅
userStringUsername for webhook authentication.1cb9c739-8452-4436-816b-a833960b7680✅
passwordStringPassword for webhook authentication.78ce12f6-665b-4354-8eaf-f0384413aaa8✅
hide_getnet_logoBooleanHides the Getnet logo at checkout when set to true.true or false--

Request

Example of request:

JSON
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

Example of response:

JSON
{ "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" } } }

Step 3: Set the business configuration

You can optionally configure your checkout experience by enabling or disabling specific payment operations. These settings determine which payment methods appear during checkout. Examples include credit cards, debit cards, Boleto (bank slip), Pix (instant payment), and QR Code.

You can also configure the installment options available to your customers. This lets you define key aspects of the installment experience. These settings include the installment plans to offer, the number of installments available, and the party responsible for absorbing interest fees. Either the cardholder or the merchant can absorb these fees.

The table below lists the fields you must send.

information icon
Important: For each object-type attribute in the table, set the enable parameter to true or false.
FieldTypeDescriptionExampleRequired
instant_paymentObjectPayment method.--✅
bankslipObjectPayment method.--✅
creditObjectPayment method.--✅
debitObjectPayment method.--✅
enableBooleanWhether the payment method is accepted.true✅
qr_code_checkoutObject(Argentina only) Displays the QR Code as a payment option on the Web Checkout screen.--✅
information icon
Important: The QR Code is available only for Argentina. It uses the enable parameter, set to true or false. When you enable qr_code_checkout, the QR Code appears as a payment option on the Web Checkout screen. You don't need to change your integration.

Request

Example of request:

JSON
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 }, "daviplata": { "enabled": true }, "efecty": { "enabled": true }, "pse": { "enabled": true }, "nequi": { "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

Example of response:

JSON
{ "instant_payment": { "enable": true }, "bankslip": { "enable": true }, "qr_code_checkout": { "enable": true }, "mbway": { "enabled": true }, "multibanco": { "enabled": true }, "daviplata": { "enabled": true }, "efecty": { "enabled": true }, "pse": { "enabled": true }, "nequi": { "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 } ] } }

Your configuration is complete.

Next steps

On this page

Configure Web Checkout by API