Offerings API — Offerings Showcase

1. Overview

The Offerings API is the service responsible for presenting to your customer the offerings of products and services available for contracting with Getnet. Think of it as a digital showcase: you query the up-to-date catalog of payment solutions — card machines, e-commerce platforms, digital services and their respective commercial conditions — and display this information in a personalized way for each customer.

The service solves a central problem in the accreditation process: how do you know which products and which fees a specific customer can contract, in a dynamic and always up-to-date way? The Offerings API answers this question in real time, considering the customer's profile, the sales channel and the current commercial conditions.

2. Context and Use Cases

When to use this service?

Use the Offerings API whenever you need to:

Display a catalog of available solutions before starting a contracting process.
Present the personalized acquiring fees (MDR) by brand and payment method.
Check the delivery methods available for a piece of equipment before finalizing an order.
Recalculate the price of an offering based on a specific commercial profile.

Real Business Scenarios

Scenario	Description
New customer accreditation	A consultant accesses the portal and displays to the merchant the offerings available for the selected channel and country, with price and condition information.
Fee comparison	The customer views the showcase and, upon clicking a specific offering, the system fetches the detailed fees by brand (Visa, Master, Elo) and method (single-payment credit, installments, debit).
Online contracting (self-service)	A digital platform loads the entire showcase with fees in a single call to display the full catalog without additional user interaction.
Shipping check before contracting	Before confirming an order with a physical machine, the system queries the delivery methods available for the customer's postal code and displays the options (standard, express, scheduled).
Dynamic pricing by profile	A customer with high monthly revenue receives differentiated fees; the API recalculates the offering based on the `monthly_card_income` and the line of business (`merchant_category_code`).

3. Main Flow

The Offerings API has three main operations, each with a distinct purpose. They are not necessarily chained: the channel chooses the flow most appropriate to its context.

Operation 1 — Offerings Showcase

This operation consists of fetching the offerings available for the channel. There are two possible flows — choose one of them:

Flow 1 — Showcase in two calls (loads the list first and, after the customer's choice, fetches the fees of the selected offering)

text

Consumer  ──600;">GET /offerings?country=BR&channel={channel}──►  Offerings API
            ◄── List of offerings (without acquiring fees) ──

text

Consumer  ──600;">GET /offerings?country=BR&channel={channel}──►  Offerings API
            ◄── List of offerings (without acquiring fees) ──

text

Consumer  ──600;">GET /offerings?priced_offering_id={id}──►  Offerings API
            ◄── Single object with detailed fees by brand ──

text

Consumer  ──600;">GET /offerings?priced_offering_id={id}──►  Offerings API
            ◄── Single object with detailed fees by brand ──

Flow 2 — Showcase in a single call (loads list and fees together; requires header Accept-Encoding: gzip)

text

Consumer  ──600;">GET /offerings?country=BR&channel={channel}&show_acquirers=true──►  Offerings API
            ◄── List of offerings with fees already included ──

text

Consumer  ──600;">GET /offerings?country=BR&channel={channel}&show_acquirers=true──►  Offerings API
            ◄── List of offerings with fees already included ──

Operation 2 — Delivery Methods (when the offering contains physical equipment)

Used when the customer needs to know which shipping options are available for the products in the order, considering the informed delivery postal code.

text

Consumer  ──600;">GET /offerings/delivery-data?legal_document_number={doc}&postal_code={postal_code}──►  Offerings API
            ◄── Available delivery 600;">options (standard, express, scheduled) ──

text

Consumer  ──600;">GET /offerings/delivery-data?legal_document_number={doc}&postal_code={postal_code}──►  Offerings API
            ◄── Available delivery 600;">options (standard, express, scheduled) ──

Operation 3 — Direct Pricing (when the channel already knows the offering identifier)

Ideal for channels that already know in advance which offering will be available for their customers and, therefore, do not need to browse the showcase. With the offering_id in hand, the channel directly queries the prices calculated for the customer's profile.

text

Consumer  ──600;">GET /offerings/{offering_id}/pricing?monthly_card_income={value}──►  Offerings API
            ◄── Offering with prices calculated for the customer&#039;s profile ──

text

Consumer  ──600;">GET /offerings/{offering_id}/pricing?monthly_card_income={value}──►  Offerings API
            ◄── Offering with prices calculated for the customer&#039;s profile ──

Endpoint Summary

Endpoint	Purpose
`GET /offerings`	List the offerings showcase or query an individual offering with fees
`GET /offerings/delivery-data`	Query shipping methods and values available for the customer's postal code
`GET /offerings/{offering_id}/pricing`	Obtain prices of a known offering directly, without browsing the showcase

4. Prerequisites

Authentication

All endpoints require a valid access token. The token must be obtained beforehand through the POST /token endpoint and sent in the header of each request:

text

Authorization: {token}

text

Authorization: {token}

⚠️ Attention: The token is sent directly, without the Bearer prefix.

Dependencies

Authentication Service: The JWT token must be obtained before any call.
Valid postal code: Required only for querying delivery methods (/delivery-data).
priced_offering_id: Generated in the first call to the showcase; required to fetch an individual offering with fees.

Available Environments

Environment	Base URL
Sandbox	`https://api-homologacao.getnet.com.br:443/v1`
Production	`https://api-backoffice.getnet.com.br:443/v1`

5. Quick Integration Guide

This guide presents the most common path: display the showcase and, after the customer's choice, fetch the fees of the selected offering.

Step 1 — List the Showcase

Make the call informing the country and the sales channel:

http

600;">GET /v1/offerings?country=BR&channel=my_channel
Authorization: {token}

http

600;">GET /v1/offerings?country=BR&channel=my_channel
Authorization: {token}

What you receive: A list (array) with all the offerings available for that channel. Each offering contains name, description, price and the included products (terminals, services, etc.). The acquiring fees are not returned in this step.

Important fields in the response:

Field	What it is for
`offering_id`	Permanent identifier of the offering
`priced_offering_id`	Use this ID to fetch the fees in the next call
`price`	Total value of the offering in cents (e.g.: `14999` = R$149.99)
`items`	List of products included in the offering

Step 2 — Fetch Fees of the Selected Offering

After the customer chooses an offering, use the priced_offering_id received in the previous step:

http

600;">GET /v1/offerings?priced_offering_id=abc-123-def-456
Authorization: {token}

http

600;">GET /v1/offerings?priced_offering_id=abc-123-def-456
Authorization: {token}

What you receive: A single object (not a list) with the complete offering, including the acquiring fees by brand, method and settlement period.

Example of a returned fee:

json

{
  "name": "VISA|CREDITO A VISTA|FISICO",
  "brand": "visa",
  "acquirer_product_type": "credit",
  "pricing_model": {
    "pricing_type": "mdr",
    "percentage_default": 199,
    "percentage_min": 149,
    "percentage_max": 199,
    "settlement_period": "installments_31"
  }
}

json

{
  "name": "VISA|CREDITO A VISTA|FISICO",
  "brand": "visa",
  "acquirer_product_type": "credit",
  "pricing_model": {
    "pricing_type": "mdr",
    "percentage_default": 199,
    "percentage_min": 149,
    "percentage_max": 199,
    "settlement_period": "installments_31"
  }
}

The value 199 represents 1.99% (two fixed decimals).

Alternative — Everything in a Single Call

If you prefer to load the showcase and fees at the same time, add show_acquirers=true and the compression header:

http

600;">GET /v1/offerings?country=BR&channel=my_channel&show_acquirers=true
Authorization: {token}
Accept-Encoding: gzip

http

600;">GET /v1/offerings?country=BR&channel=my_channel&show_acquirers=true
Authorization: {token}
Accept-Encoding: gzip

⚠️ The Accept-Encoding: gzip header is mandatory when show_acquirers=true.

6. Business Rules

Operation Modes of `GET /offerings`

The parameters must not be mixed between the modes:

Mode	Required Parameters	Return
Showcase	`country` + `channel`	Array of offerings
Showcase with fees	`country` + `channel` + `show_acquirers=true`	Array of offerings with MDR
Individual offering	only `priced_offering_id`	Single object with fees

❌ Do not combine country/channel with priced_offering_id in the same request.

Monetary Value Formats

All monetary values are expressed in whole cents.
- 14999 → R$149.99
- 1000000 → R$10,000.00 (for monthly_card_income)
MDR percentages use two fixed decimals:
- 199 → 1.99%
- 378 → 3.78%

Required Fields by Product

Product Type	Required Fields
`acquirer`	`brand`, `transaction_currency`, `transaction_channel_type`
`terminal`	`transaction_channel_type`
`device`	`transaction_channel_type`
`service`	`service_type`
`voucher`	`product_type`

Available Filters in the Showcase

You can refine the showcase results using optional filters:

Filter	Description
`fiscal_type`	Type of person: `natural_person` (CPF) or `company` (CNPJ)
`settlement_period`	Desired receipt period (e.g.: `installments_31`, `receive_now_0`)
`offering_type`	Type of the offering: `default`, `promotion`, `affiliate`, `external`, `product_change`, `purchase`
`anticipation`	`true` to display only offerings with receivables anticipation
`product_type`	Filters by product type: `terminal`, `service`, `acquirer`, `composite`, etc.
`modalities`	Contracting modality: `rent` (rental), `sale` (sale), `affiliation_fee` (affiliation fee)
`monthly_card_income`	Expected monthly revenue in cents (influences dynamic pricing)

Mandatory Opt-ins

Some offerings require explicit acceptance of terms. Check the additional_information.shared_data.opt_ins field in the response to identify whether there are pending acceptances (e.g.: lgpd, terms_and_conditions, saas_account_terms_acceptance).

7. Error Handling

All errors follow the standard structure:

json

{
  "status_code": 400,
  "message": "Description of the problem",
  "details": []
}

json

{
  "status_code": 400,
  "message": "Description of the problem",
  "details": []
}

Response Codes

Code	Meaning	What to do
`200`	Success	Process the returned array or object normally.
`400`	Invalid request	Review the parameters sent. Check that you are not mixing incompatible modes (e.g.: `country` + `priced_offering_id`). Confirm that `Accept-Encoding: gzip` was sent when `show_acquirers=true`.
`401`	Invalid or expired token	Obtain a new token via `POST /token` and try again.
`404`	Offering not found	Check that the `offering_id` or `priced_offering_id` is correct. The offering may have expired.
`422`	Business rule error	Read the `message` field of the response to understand which rule was violated (common in the delivery-data endpoint when the postal code is invalid).
`500`	Internal server error	Try again after a few moments. If it persists, contact Getnet support.

Common Error Situations

400 when using show_acquirers=true without gzip: Add the Accept-Encoding: gzip header.
404 when fetching priced_offering_id: The ID has limited validity. Return to the showcase to generate a new one.
422 in delivery-data: Invalid postal code or no coverage for the requested product type.

8. Glossary

Term	Definition
Offering	Commercial package that groups one or more products (terminal, service, acquiring) with their price conditions. It is what the customer effectively contracts.
Offering ID	Permanent identifier of an offering in the catalog.
Priced Offering ID	Identifier generated by the pricing engine for a specific instance of an already calculated offering. Has limited validity.
MDR (Merchant Discount Rate)	Percentage fee charged on each payment transaction, varying by brand, method (credit/debit), number of installments and channel.
Settlement Period	Period to receive the sales amounts after the transaction. E.g.: `installments_31` = 31 days after each installment; `receive_now_0` = immediate receipt (Pix/anticipation).
Composite	Product type that groups other products of the same type. E.g.: an acquiring `composite` groups all the fees by brand and method of a specific channel.
Acquirer	Service that processes payment transactions. The acquiring fees (MDR) define how much the establishment pays for each transaction.
Terminal	Physical or virtual payment equipment (e.g.: POS card machine, e-commerce platform).
Device	Peripheral payment device (e.g.: pinpad).
Service	Complementary digital service included in the offering (e.g.: receivables anticipation, Pix, payment link, anti-fraud).
Voucher	Payment product via benefit voucher (e.g.: meal voucher, food voucher) from brands such as Alelo, VR, Ticket, Ben.
Modality	Product contracting modality: `rent` (monthly rental), `sale` (purchase) or `affiliation_fee` (affiliation fee).
Pricing Type	Pricing model applied to the product. The main ones are: `mdr` (percentage per transaction), `monthly_rent` (fixed monthly rental), `fixed_price` (single price), `transaction_fee` (fixed amount per transaction), `no_price` (no additional cost).
MCC (Merchant Category Code)	Code that classifies the line of business of the commercial establishment. Influences the available fees.
Channel	Sales channel responsible for the accreditation (e.g.: web portal, app, consultant).
Opt-in	Formal acceptance of terms by the customer (e.g.: LGPD, terms and conditions, digital account terms).
Delivery Data	Information about the delivery methods available for a physical product, considering the customer's postal code.
Price Book	Reference price table used in the calculation of dynamic pricing.
Anticipation	Receivables anticipation service that allows the merchant to receive the amount of installment sales before the normal deadline.
Brand	Payment card brand. Supported values: `visa`, `master`, `elo`, `amex`, `hipercard`.
Installment Type	Responsibility for financing the installment plan: `merchant` (merchant), `issuer` (issuing bank), `bndes`, `iata`, `crediario`.

On this page

Offerings API — Offerings Showcase

Offerings API — Offerings Showcase

1. Overview

2. Context and Use Cases

When to use this service?

Real Business Scenarios

3. Main Flow

Operation 1 — Offerings Showcase

Operation 2 — Delivery Methods (when the offering contains physical equipment)

Operation 3 — Direct Pricing (when the channel already knows the offering identifier)

Endpoint Summary

4. Prerequisites

Authentication

Dependencies

Available Environments

5. Quick Integration Guide

Step 1 — List the Showcase

Step 2 — Fetch Fees of the Selected Offering

Alternative — Everything in a Single Call

6. Business Rules

Operation Modes of GET /offerings

Monetary Value Formats

Required Fields by Product

Available Filters in the Showcase

Mandatory Opt-ins

7. Error Handling

Response Codes

Common Error Situations

8. Glossary

Operation Modes of `GET /offerings`