Configure the payment link

This guide covers two configurations performed before or during the creation of a payment link: uploading images for products and configuring installments by country and card brand.

Before you begin

Obtain an access token. See Authentication.

Product images

To display an image on a payment link product, upload the image first. Use the image_id returned in the image_id field of the products object when creating or updating the link.

Step 1 - Upload the image

text

POST /payment-links/products/images

text

POST /payment-links/products/images

Content-Type: multipart/form-data
Accepted formats: image/png, image/jpeg
Maximum size: 250 MB

Field	Type	Required	Description
`file`	binary	Yes	Image file (PNG or JPEG, max 250 MB)

Request example

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='

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='

Response example

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

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

Use the image_id returned when building the products array in the creation or update of the link:

json

"products": [
   {
      "product_type": "physical_goods",
      "title": "Camiseta Oficial Getnet",
      "amount": 9990,
      "quantity": 1,
      "image_id": "6697e354-ab4a-11eb-bcbc-0242ac130002"
   }
]

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.

text

GET /payment-links/products/images/{image_id}

text

GET /payment-links/products/images/{image_id}

Parameter	Type	Required	Description
`image_id`	string (UUID)	Yes	Unique identifier of the image

Request example

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...'

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).

Response example

json

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

json

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

Bussiness configurations

Merchants can optionally configure their Payment Link by enabling or disabling specific payment operations. These settings determine which payment methods, such as Credit Cards, Debit Cards, Boleto (bank slip) or PIX (instant payment), are displayed during the checkout process.

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 toggle { "enabled": true }. Installments apply only to credit; null or absent means a single payment.

To understand the rules for installments for each country access Installments rules and availability

Field	Type	Required	Description
`enabled`	boolean	Yes	Enables or disables this brand
`brand`	string	Yes	Card brand: VISA, MASTERCARD, AMEX, ELO, HIPERCARD, CABAL, CARNET, etc.
`currencies`	string[]	No	Currency codes (default: seller's country currency)
`threeds`	boolean	No	Requires 3D Secure authentication for this brand
`supported_installments`	InstallmentPlan[]	No	Installment plans (credit only). Null or absent = single payment
`schema`	string	Yes	Schema identifier — determines the installment rules. Region-specific
`schema_name`	string	No	Human-readable plan name (e.g., "Plan Lojista", "Plan Prosa")
`installments`	integer[]	No	Available installment counts (e.g., `[2,3,6,12]`)
`installments_with_interest`	integer[]	No	Subset of `installments` that carry interest. Empty = all without interest
`installments_with_increase`	object[]	No	Groups of installments with an applied increase rate

Request example

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": true
    },
    "apple_pay": {
      "enabled": true
    },
    "c2p_master": {
      "enabled": false
    }
  },
  "currency": "BRL"
}'

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": true
    },
    "apple_pay": {
      "enabled": true
    },
    "c2p_master": {
      "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 2 and 3 installments are interest-free, while 6 and 12 carry interest.
installments_with_increase provides rate-based pricing: each entry groups installments and assigns a percentage rate.

InstallmentsWithIncrease object

Field	Type	Required	Description
`installments`	integer[]	Yes	Installment counts to which this rate applies
`rate`	number	Yes	Increase 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 }
]

json

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

In this case, 3 and 6 installments have a 1.5% increase, and 9 and 12 installments have a 2.99% increase.

Regional schemas

Country	Schema(s)	Currency	Typical brands
Brazil (BR)	plan_lojista, plan_emissor	BRL	VISA, MASTERCARD, AMEX, ELO, HIPERCARD
Mexico (MX)	plan_prosa	MXN	VISA, MASTERCARD, AMEX, CARNET

Examples by country

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": []
       }
    ]
}

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": []
       }
    ]
}

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] }
    ]
}

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
       }
    ]
}

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

How to create a payment link

On this page

Configure the payment link

First Steps

Payment Guides

Configure the payment link

Before you begin

Product images

Step 1 - Upload the image

Step 2 — Reference the image in a product

Step 3 (optional) — Retrieve the image

Bussiness configurations

Installments

Regional schemas

Examples by country

Next steps