Configure the payment link

This guide shows you how to add product images and configure installments by country and card brand. You can do both before or while you create a payment link.

How it works

The two settings are independent of each other. Keep the following in mind:

  • Product images — upload an image first to get an image_id, then reference that image_id in the products array when creating or updating the link. You can optionally retrieve an image's binary content by its identifier. Accepted formats are PNG and JPEG, up to 250 MB.
  • Business configurations — you can enable or disable specific payment methods (credit, debit, Boleto, Pix, and others). Your choice determines which methods the buyer sees at checkout.
  • Installments (credit only) — installments are configured per credit card brand, inside payment.credit.brands[].supported_installments. If supported_installments is null or absent, the buyer pays in full in a single installment. Card-based methods (credit, debit) use a brands[] array to configure each brand, while other methods use only the { "enabled": true } toggle.
  • How the installment fields relate — installments lists the valid counts, installments_with_interest marks which of those carry interest, and installments_with_increase assigns a percentage rate to groups of installments.
  • Region-specific schemas — the schema determines the installment rules and varies by country (for example, plan_ahora / plan_emisor_accelerated / plan_getnet_integral / plan_n in Argentina, plan_lojista / plan_emissor in Brazil, plan_emisor / cuota_comercio in Chile and plan_prosa in Mexico).

The product image configuration follows a short sequence:

Before you begin

Product images

To display an image on a payment link product, upload the image first. Then pass the returned image_id in the image_id field of each item in the products array when you create or update the link.

Step 1 — Upload the image

Endpoint
POST /payment-links/products/images

Request requirements

  • Content-Type: multipart/form-data
  • Accepted formats: image/png, image/jpeg
  • Maximum size: 250 MB
Required fields
AttributeTypeDescriptionExample
filebinaryImage file (PNG or JPEG, max 250 MB)product-photo.png

Example request

JSON
curl https://api-sbx.pre.globalgetnet.com/dpy/payment-link/v1/payment-links/products/images \ --request POST \ --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...' \ --header 'Content-Type: multipart/form-data' \ --form 'file='

Example response

JSON
{ "image_id": "6697e354-ab4a-11eb-bcbc-0242ac130002", "original_name": "product-photo.png", "mime_type": "image/png", "upload_at": "2026-06-10T14:30:00.000Z" }

Step 2 — Reference the image in a product

When you create or update a link, add the returned image_id to the product in the products array:
JSON
"products": [ { "product_type": "physical_goods", "title": "Camiseta Oficial Getnet", "amount": 9990, "quantity": 1, "image_id": "6697e354-ab4a-11eb-bcbc-0242ac130002" } ]

Step 3 (optional) — Retrieve the image

Use this endpoint to retrieve the binary content of an image by its identifier.

Endpoint
GET /payment-links/products/images/{image_id}
FieldTypeDescriptionExample
image_idstringUnique identifier of the image3fa85f64-5717-4562-b3fc-2c963f66afa6

Example request

JSON
curl https://api-sbx.pre.globalgetnet.com/dpy/payment-link/v1/payment-links/products/images/3fa85f64-5717-4562-b3fc-2c963f66afa6 \ --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...'
The 200 OK response returns the binary content with the corresponding Content-Type (image/png or image/jpeg).

Example response

JSON
{ "type": "string", "contentMediaType": "application/octet-stream" }

Business configurations

You can configure your payment link by enabling or disabling specific payment methods. These settings determine which methods the buyer sees at checkout, such as credit cards, debit cards, Boleto (bank slip), Pix (instant payment), or Click to Pay (Argentina only).

Installments

Installments are configured within each credit card brand, in payment.credit.brands[].supported_installments. Each entry is an InstallmentPlan object representing an installment schema offered by the acquirer or issuer.
Card-based methods (credit, debit) have a brands[] array for per-brand configuration. Other methods use only the { "enabled": true } toggle. Installments apply only to credit card payments. If supported_installments is null or absent, the buyer pays in full in a single installment.
information icon

For each country's installment rules, see Installment rules and availability.

Endpoint
POST /payment-links/business-configurations
Required fields
FieldTypeDescriptionExample
enabledbooleanEnables or disables this brandtrue or false
brandstringCard brandVISA, MASTERCARD, AMEX, ELO, CABAL
schemastringSchema identifier. Determines the installment rules and varies by regionplan_lojista
Optional fields
FieldTypeDescriptionExample
currenciesstringCurrency codes (default: the currency of the seller's country)ARS, BRL, CLP or MXN
threedsbooleanRequires 3D Secure authentication for this brandtrue or false
supported_installmentsobjectInstallment plans (credit only). Null or absent = single payment---
schema_namestringHuman-readable plan namePlan Lojista
installmentsinteger[]Available installment counts[2,3,6,12]
installments_with_interestinteger[]Subset of installments that carry interest. If empty, all installments are interest-free[6,9,12]
installments_with_increaseobjectGroups of installments with an applied surcharge rate---

Example request

JSON
curl https://api-sbx.pre.globalgetnet.com/dpy/payment-link/v1/payment-links/business-configurations \ --request POST \ --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...' \ --header 'Content-Type: application/json' \ --data '{ "expiration": "2026-12-31T23:59:59", "max_orders": 100, "request_delivery_address": false, "payment": { "credit": { "enabled": true, "brands": [ { "enabled": true, "brand": "VISA", "currencies": [ "BRL" ], "threeds": true, "supported_installments": [ { "schema": "plan_lojista", "schema_name": "Plan Lojista", "installments": [2,3,4,5,6,7,8,9,10,11,12], "installments_with_interest": [6,9,12] } ] } ] }, "debit": { "enabled": true, "brands": [ { "enabled": true, "brand": "VISA", "currencies": [ "BRL" ], "threeds": true } ] }, "bankslip": { "enabled": true }, "instant_payment": { "enabled": true }, "google_pay": { "enabled": false }, "apple_pay": { "enabled": false }, "currency": "BRL" }'

How the fields relate

  • installments lists the valid installment counts. For example, [2, 3, 6, 12] allows the buyer to pay in 2, 3, 6, or 12 installments.
  • installments_with_interest indicates which of those installments carry interest. If installments = [2,3,6,12] and installments_with_interest = [6,12], then payments in 2 or 3 installments are interest-free, while payments in 6 or 12 installments carry interest.
  • installments_with_increase provides rate-based pricing: each entry groups installments and assigns a percentage rate.
InstallmentsWithIncrease object
FieldTypeRequiredDescription
installmentsinteger[]YesInstallment counts to which this rate applies
ratenumberYesSurcharge rate as a percentage (e.g., 1.5 = 1.5%)

Example:

JSON
"installments_with_increase": [ { "installments": [3, 6], "rate": 1.5 }, { "installments": [9, 12], "rate": 2.99 } ]

In this example, payments in 3 or 6 installments carry a 1.5% surcharge, and payments in 9 or 12 installments carry a 2.99% surcharge.

Regional schemas

CountrySchema(s)CurrencyTypical brands
Argentina (AR)plan_ahora, plan_emisor_accelerated, plan_getnet_integral, plan_nARSVISA, MASTERCARD, AMEX, CABAL
Brazil (BR)plan_lojista, plan_emissorBRLVISA, MASTERCARD, AMEX, ELO, HIPERCARD
Chile (CL)plan_emisor, cuota_comercioCLPVISA, MASTERCARD, AMEX
Mexico (MX)plan_prosaMXNVISA, MASTERCARD, AMEX, CARNET
information icon
Pending confirmation (Argentina): the source also lists plan_getnet_simples in one table. Confirm whether it is a valid schema.

Examples by country

Argentina — plan_ahora + plan_emisor_accelerated
JSON
{ "enabled": true, "brand": "VISA", "currencies": ["ARS"], "threeds": true, "supported_installments": [ { "schema": "plan_ahora", "schema_name": "Plan Ahora", "installments": [3, 6, 12, 18], "installments_with_interest": [] }, { "schema": "plan_emisor_accelerated", "schema_name": "Plan Emisor Accelerated", "installments": [2, 3, 4, 5, 6], "installments_with_interest": [4, 5, 6] } ] }
Brazil — plan_lojista + plan_emissor
JSON
{ "enabled": true, "brand": "VISA", "currencies": ["BRL"], "threeds": true, "supported_installments": [ { "schema": "plan_lojista", "schema_name": "Plan Lojista", "installments": [2,3,4,5,6,7,8,9,10,11,12], "installments_with_interest": [6,9,12] }, { "schema": "plan_emissor", "schema_name": "Plan Emissor", "installments": [2,3,4,5,6], "installments_with_interest": [] } ] }
Chile — plan_emisor + cuota_comercio
JSON
{ "enabled": true, "brand": "VISA", "currencies": ["CLP"], "threeds": true, "supported_installments": [ { "schema": "plan_emisor", "schema_name": "Plan Emisor", "installments": [2, 3, 4, 5, 6], "installments_with_interest": [4, 5, 6] }, { "schema": "cuota_comercio", "schema_name": "Cuota Comercio", "installments": [2, 3, 6, 9, 12], "installments_with_interest": [6, 9, 12] } ] }
Mexico — plan_prosa
JSON
{ "enabled": true, "brand": "VISA", "currencies": ["MXN"], "threeds": true, "supported_installments": [ { "schema": "plan_prosa", "schema_name": "Plan Prosa", "installments": [3,6,9,12], "installments_with_interest": [3,6,9,12] } ] }
Example with installments_with_increase
JSON
{ "enabled": true, "brand": "MASTERCARD", "currencies": ["BRL"], "threeds": true, "supported_installments": [ { "schema": "plan_lojista", "schema_name": "Plan Lojista", "installments": [2,3,4,5,6,7,8,9,10,11,12], "installments_with_interest": [6,9,12], "installments_with_increase": [ { "installments": [2,3,4,5,6], "rate": 1.5 }, { "installments": [7,8,9,10,11,12], "rate": 2.99 } ], "single_increase_rate": false } ] }

Next steps

On this page

Configure the payment link