### GET /offerings Response Example Source: https://docs.globalgetnet.com/pt/products/onboarding/orders This example shows a simplified response from the GET /offerings endpoint, detailing two selected offers with their respective items and quantities. ```APIDOC ## GET /offerings ### Description Retrieves a list of available product offerings. ### Method GET ### Endpoint /offerings ### Response #### Success Response (200) - **priced_offering_id** (string) - Unique identifier for the priced offering. - **smart_offering_id** (string) - Unique identifier for the smart offering. - **name** (string) - Name of the offering. - **items** (array) - List of items included in the offering. - **item_sequence_number** (integer) - Sequence number of the item within the offering. - **product** (object) - Details of the product. - **product_id** (string) - Unique identifier for the product. - **name** (string) - Name of the product. - **product_type** (string) - Type of the product (e.g., 'composite', 'terminal', 'service'). - **composite_type** (string, optional) - Type of composite product (e.g., 'acquirer'). - **transaction_channel_types** (array of strings, optional) - Types of transaction channels supported. - **modalities** (array of strings, optional) - Modalities of the product. - **terminal_type** (string, optional) - Type of terminal. - **transaction_channel_type** (string, optional) - Type of transaction channel. - **modality** (string, optional) - Modality of the product. - **delivery_method** (string, optional) - Delivery method for the product. - **wireless** (boolean, optional) - Indicates if the product is wireless. - **print_receipt** (boolean, optional) - Indicates if receipt printing is supported. - **model** (string, optional) - Model of the product. - **service_type** (string, optional) - Type of service. - **product_configuration** (object, optional) - Configuration details for the product. - **keyword** (string) - Keyword for the product configuration. - **issuer** (string) - Issuer of the product configuration. - **quantity** (integer) - Quantity of the item. - **settlement_period** (string, optional) - Settlement period for the item. - **unit_price** (number, optional) - Unit price of the item. - **total_price** (number, optional) - Total price of the item. ### Response Example ```json [ { "priced_offering_id": "6a0fc78fd653164a21cf71f8", "smart_offering_id": "6a0fc78fd653164a21cf71f8", "name": "Adquirência Físico Aluguel", "items": [ { "item_sequence_number": 1, "product": { "product_id": "693241e8c4e00969b33efaf1", "name": "ADQUIRENCIA FÍSICO ALUGUEL", "product_type": "composite", "composite_type": "acquirer", "transaction_channel_types": ["physical"], "modalities": ["rent"] }, "quantity": 1, "settlement_period": "receive_now_2" } ] }, { "priced_offering_id": "6a0fc78fd653164a21cf7201", "smart_offering_id": "6a0fc78fd653164a21cf7201", "name": "Oferta E-commerce - Link de Pagamento V2", "items": [ { "item_sequence_number": 1, "product": { "product_id": "69b2ece03abb838e8be1b21d", "name": "Terminal Ecommerce", "product_type": "terminal", "terminal_type": "ecommerce", "transaction_channel_type": "online", "modality": "rent", "delivery_method": "na", "wireless": false, "print_receipt": false, "model": "ecommerce" }, "quantity": 1, "unit_price": 0, "total_price": 0 }, { "item_sequence_number": 2, "product": { "product_id": "52fadc5225294c7781c862c4e4a2d91a", "name": "Conta SuperGet", "product_type": "service", "service_type": "service", "product_configuration": {"keyword": "prepaid_card", "issuer": "superget"} }, "quantity": 1 }, { "item_sequence_number": 3, "product": { "product_id": "6781192295d5d10a6194fe15", "name": "GetPay (link de pagamento)", "product_type": "service", "service_type": "ecommerce_service", "product_configuration": {"keyword": "ecommerce_payment_link"} }, "quantity": 1 } ] } ] ``` ``` -------------------------------- ### INSTALLATION_REQUESTED Event Payload Source: https://docs.globalgetnet.com/pt/products/sap-immediate-delivery/webook-sap Example of the JSON payload for an INSTALLATION_REQUESTED event. This event signifies a request for a new installation service. ```json { "metadata": { "event_id": "b46ee43a-246a-48cb-bcad-e6799b61f83d", "event_type": "INSTALLATION_REQUESTED", "schemaVersion":"1", "producer": "erp-field-service-ms", "order_number": "MXD54S433", "work_order_id": "bb2d7a60-0e88-4ca5-98c8-7aedc2098703", "work_order_number": "43214567", "occurred_at": "2025-12-27T10:00:00.000Z" }, "payload": { "id": "bb2d7a60-0e88-4ca5-98c8-7aedc2098703", "work_order_number": "43214567", "order_number": "MXD54S433", "type": "INSTALLATION", "activity": "INSTALLATION", "request": { "type": "", "subtype": "" }, "priority": "IMMEDIATE_DELIVERY", "sla": { "ec": "2025-12-27T12:00:00.000Z", "eps": "2025-12-27T12:00:00.000Z" }, "status": "CREATED", "details": "...", "accreditation_channel": "", "customer": { "id": "34556721", "cpf_cnpj": "76435275000110", "name": "EMPRESA DE TESTE", "address": { "cep":"96780000", "street": "Avenida Alceu Rossi", "number": "277", "complement": "AP 179", "reference": "Torre Leste", "district": "Centro", "city": "Paranaíta", "state": "MT" }, "phones": [ "51996557302" ], "workday": [ { "week_day": "MONDAY", "start": "08:00", "end": "12:00" }, { "week_day": "MONDAY", "start": "13:00", "end": "18:00" }, { "week_day": "TUESDAY", "start": "08:00", "end": "18:00" }, { "week_day": "WEDNESDAY", "start": "08:00", "end": "18:00" }, { "week_day": "THURSDAY", "start": "08:00", "end": "18:00" }, { "week_day": "FRIDAY", "start": "08:00", "end": "18:00" } ] }, "service_agent": { "provider": { "cnpj": "94081271000162" }, "technician": { "cpf": "40256529000" }, "work_center": { "id": "CT000123", "name": "Mobian" } }, "equipment": { "capture_method": "", "technology": "", "best_equipment": { "sku": "", "skuDescription": "", "condition": "GOOD", "charger": true } }, "chip": { "chip1": "", "chip2": "", "customer": "" }, "coil": { "kitSku": "", "kitQuantity": 2, "total": 10 } } } ``` -------------------------------- ### GET /offerings Response Example Source: https://docs.globalgetnet.com/pt/products/onboarding/orders This is a simplified JSON response for the GET /offerings endpoint, illustrating the structure when a customer selects two different offerings: 'Adquirência Físico Aluguel' with 1 item and 'Oferta E-commerce - Link de Pagamento V2' with 7 items. It details the product information, quantities, and pricing for each item within the selected offerings. ```json [ { "priced_offering_id": "6a0fc78fd653164a21cf71f8", "smart_offering_id": "6a0fc78fd653164a21cf71f8", "name": "Adquirência Físico Aluguel", "items": [ { "item_sequence_number": 1, "product": { "product_id": "693241e8c4e00969b33efaf1", "name": "ADQUIRENCIA FÍSICO ALUGUEL", "product_type": "composite", "composite_type": "acquirer", "transaction_channel_types": ["physical"], "modalities": ["rent"] }, "quantity": 1, "settlement_period": "receive_now_2" } ] }, { "priced_offering_id": "6a0fc78fd653164a21cf7201", "smart_offering_id": "6a0fc78fd653164a21cf7201", "name": "Oferta E-commerce - Link de Pagamento V2", "items": [ { "item_sequence_number": 1, "product": { "product_id": "69b2ece03abb838e8be1b21d", "name": "Terminal Ecommerce", "product_type": "terminal", "terminal_type": "ecommerce", "transaction_channel_type": "online", "modality": "rent", "delivery_method": "na", "wireless": false, "print_receipt": false, "model": "ecommerce" }, "quantity": 1, "unit_price": 0, "total_price": 0 }, { "item_sequence_number": 2, "product": { "product_id": "52fadc5225294c7781c862c4e4a2d91a", "name": "Conta SuperGet", "product_type": "service", "service_type": "service", "product_configuration": { "keyword": "prepaid_card", "issuer": "superget" } }, "quantity": 1 }, { "item_sequence_number": 3, "product": { "product_id": "6781192295d5d10a6194fe15", "name": "GetPay (link de pagamento)", "product_type": "service", "service_type": "ecommerce_service", "product_configuration": { "keyword": "ecommerce_payment_link" } }, "quantity": 1 } ] } ] ``` -------------------------------- ### Authorization Header Example Source: https://docs.globalgetnet.com/pt/products/online-payments/web-checkout?doc=checkout-iframe-doc Example of how to format the Authorization header for Getnet API authentication, using Base64 encoded credentials. ```javascript Authorization: Basic Y2xpZW50LTAxOnNlY3JldC1rZXktMDI= ``` -------------------------------- ### OAuth API Response Example Source: https://docs.globalgetnet.com/pt/products/online-payments/web-checkout?doc=checkout-iframe-doc Example JSON response from the Getnet OAuth API, containing the access token and related details. ```javascript { "access_token":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "token_type":"Bearer", "expires_in":3600, "scope":"oob" } ``` -------------------------------- ### Merchant Pendencies Response Example Source: https://docs.globalgetnet.com/pt/products/white-label/pendencies-api Example JSON response for a merchant with 'DATA_GRID' type pendencies, including required attributes for review. ```json { "person_type": "company", "situations": [ { "status": "pending", "status_update_date": "2026-05-27T14:30:00Z" } ], "pendencies": [ { "pendency_type": "DATA_GRID", "situation": { "status": "pending", "status_update_date": "2026-05-27T14:30:00Z" }, "grid_info": [ { "attribute": "trading_name", "required": true } ] } ] } ``` -------------------------------- ### Installation Failed Event Payload Source: https://docs.globalgetnet.com/pt/products/sap-immediate-delivery/webook-sap This payload is sent when an installation fails. It includes event metadata and payload details such as the status, failure timestamp, and the macro and micro reasons for the failure. ```json { "metadata": { "event_id": "b46ee43a-246a-48cb-bcad-e6799b61f83d", "event_type": "INSTALLATION_FAILED", "schema_version":"1", "producer": "erp-field-service-ms", "order_number": "MXD54S433", "work_order_id": "bb2d7a60-0e88-4ca5-98c8-7aedc2098703", "work_order_number": "43214567", "occurred_at": "2025-12-27T10:00:00.000Z" }, "payload": { "status": "FAILED", "failed_at": "2025-12-27T12:00:00", "failed_reason": { "macro": { "code":"", "description":"" }, "micro": { "code":"", "description":"" } } } } ``` ```json { "metadata": { "event_id": "b46ee43a-246a-48cb-bcad-e6799b61f83d", "event_type": "INSTALLATION_FAILED", "schema_version":"1", "producer": "erp-field-service-ms", "order_number": "MXD54S433", "work_order_id": "bb2d7a60-0e88-4ca5-98c8-7aedc2098703", "work_order_number": "43214567", "occurred_at": "2025-12-27T10:00:00.000Z" }, "payload": { "status": "FAILED", "failed_at": "2025-12-27T12:00:00", "failed_reason": { "macro": { "code":"", "description":"" }, "micro": { "code":"", "description":"" } } } } ``` -------------------------------- ### Installation Changed Event Payload Source: https://docs.globalgetnet.com/pt/products/sap-immediate-delivery/webook-sap This payload is sent when an installation's status changes. It includes metadata about the event and details about the service agent, priority, and SLA. ```json { "metadata": { "event_id": "b46ee43a-246a-48cb-bcad-e6799b61f83d", "event_type": "INSTALLATION_CHANGED", "order_number": "MXD54S433", "schema_version":"1", "producer": "erp-field-service-ms", "work_order_id": "bb2d7a60-0e88-4ca5-98c8-7aedc2098703", "work_order_number": "43214567", "ocurred_at": "2025-12-27T10:00:00.000Z" }, "payload": { "service_agent": { "provider": { "cnpj": "94081271000162" }, "technician": { "cpf": "40256529000" }, "work_center": { "id": "CT000123", "name": "Mobian" } }, "priority": "IMMEDIATE_DELIVERY", "sla": { "ec": "2025-12-27 12:00:00", "eps": "2025-12-27 12:00:00" } } } ``` ```json { "metadata": { "event_id": "b46ee43a-246a-48cb-bcad-e6799b61f83d", "event_type": "INSTALLATION_CHANGED", "order_number": "MXD54S433", "schema_version":"1", "producer": "erp-field-service-ms", "work_order_id": "bb2d7a60-0e88-4ca5-98c8-7aedc2098703", "work_order_number": "43214567", "ocurred_at": "2025-12-27T10:00:00.000Z" }, "payload": { "service_agent": { "provider": { "cnpj": "94081271000162" }, "technician": { "cpf": "40256529000" }, "work_center": { "id": "CT000123", "name": "Mobian" } }, "priority": "IMMEDIATE_DELIVERY", "sla": { "ec": "2025-12-27 12:00:00", "eps": "2025-12-27 12:00:00" } } } ``` -------------------------------- ### Installation Canceled Event Payload Source: https://docs.globalgetnet.com/pt/products/sap-immediate-delivery/webook-sap This payload is generated when an installation is canceled. It includes event metadata and payload details such as the status, cancellation timestamp, and reason for cancellation. ```json { "metadata": { "event_id": "b46ee43a-246a-48cb-bcad-e6799b61f83d", "event_type": "INSTALLATION_CANCELED", "schema_version":"1", "producer": "erp-field-service-ms", "order_number": "MXD54S433", "work_order_id": "bb2d7a60-0e88-4ca5-98c8-7aedc2098703", "work_order_number": "43214567", "occurred_at": "2025-12-27T10:00:00.000Z" }, "payload": { "status":"CANCELED", "canceled_at": "2025-12-27T11:23:54", "cancel_reason": { "id": "", "description": "" } } } ``` ```json { "metadata": { "event_id": "b46ee43a-246a-48cb-bcad-e6799b61f83d", "event_type": "INSTALLATION_CANCELED", "schema_version":"1", "producer": "erp-field-service-ms", "order_number": "MXD54S433", "work_order_id": "bb2d7a60-0e88-4ca5-98c8-7aedc2098703", "work_order_number": "43214567", "occurred_at": "2025-12-27T10:00:00.000Z" }, "payload": { "status":"CANCELED", "canceled_at": "2025-12-27T11:23:54", "cancel_reason": { "id": "", "description": "" } } } ``` -------------------------------- ### Example Totalization Fields Source: https://docs.globalgetnet.com/pt/products/onboarding/orders Demonstrates how to calculate and include totalization fields for different pricing types when creating or updating an order. This involves summing the 'total_price' based on the 'product.product_type'. ```JSON { "pricing_type": "monthly_rent", "total_monthly_rent": "somar total_price em total_monthly_rent" } { "pricing_type": "fixed_price", "total_fixed_price": "somar total_price em total_fixed_price" } { "pricing_type": "affiliation_fee", "total_affiliation_fee": "somar total_price em total_affiliation_fee" } { "pricing_type": "recurrent", "total_recurrent": "somar total_price em total_recurrent" } { "pricing_type": "payment_price", "total_payment_price": "somar total_price em total_payment_price" } { "pricing_type": "license", "total_license": "somar total_price em total_license" } ``` -------------------------------- ### Installation Concluded Event Payload Source: https://docs.globalgetnet.com/pt/products/sap-immediate-delivery/webook-sap This JSON payload represents an event where an installation process has been concluded. It includes metadata about the event and the payload details the status and conclusion time. ```json { "metadata": { "event_id": "b46ee43a-246a-48cb-bcad-e6799b61f83d", "event_type": "INSTALLATION_CONCLUDED", "schema_version":"1", "producer": "erp-field-service-ms", "order_number": "MXD54S433", "work_order_id": "bb2d7a60-0e88-4ca5-98c8-7aedc2098703", "work_order_number": "43214567", "occurred_at": "2025-12-27T10:00:00.000Z" }, "payload": { "status": "CONCLUDED", "equipment": { "installed": { "serial":"", "sku": "" } }, "concluded_at":"2025-12-27T16:45:10" } } ``` -------------------------------- ### Successful merchant creation response Source: https://docs.globalgetnet.com/pt/products/onboarding/merchants This is an example of a successful HTTP 200 response after creating a merchant. It includes the merchant's ID and the status of various onboarding steps. ```JSON { "situation": { "status": "accepted", "sub_status_steps": [ { "name": "DATA_GRID", "situation": { "status": "pending" } }, { "name": "SOCIAL_CONTRACT", "situation": { "status": "pending" } }, { "name": "LETTER_OF_ATTORNEY", "situation": { "status": "pending" } }, { "name": "TERMS_AND_CONDITIONS", "situation": { "status": "finished" } }, { "name": "PRIVACY_POLICY", "situation": { "status": "finished" } } ] }, "merchant": { "merchant_id": "6a0f43fd9a4f90ca92a8596d", "acquirer_merchant_code": "55317268", "merchant_legal_data": { "person": { "fiscal_type": "company", "legal_name": "NOME FANTASIA DA EMPRESA", "founding_date": "2014-04-30", "tax_regime": "EIRELI", "federal_registration_status": "active" } } } } ``` -------------------------------- ### Build and Run Fee Merchant Application Source: https://docs.globalgetnet.com/pt/products/white-label/fee-merchant Use these Maven and Java commands to build the project and run the application locally with development profile. ```bash # Build the project mvn clean package -DskipTests # Run the application java -jar target/mng-fee-merchant-adp-2.0.3.jar --spring.profiles.active=dev ``` -------------------------------- ### Complement Merchant Data (PUT) Source: https://docs.globalgetnet.com/pt/products/onboarding/merchants Use PUT to update merchant data. Always start with the GET response and modify only necessary fields. Monetary values are in cents. Ensure the postal code is valid before submitting. ```json { "acquirer_code": "getnet", "merchant_id": "6a0f23739a4f90ca92a85686", "merchant_legal_data": { "country": "BR", "person": { "fiscal_type": "natural_person", "legal_document_number": "24751750011", "name": "JOÃO DA SILVA SANTOS", "birth_date": "1985-03-22", "cell_phone": "11987654321", "email": "joao.santos@email.com", "nationality": "BR", "country_of_birth": "BR", "mothers_name": "MARIA DA SILVA", "economic_activity_profile": { "acquirer_merchant_category_code": "2119" }, "gross_monthly_income": 500000, "net_worth": 2000000, "residential_address": { "postal_code": "01321001", "street": "RUA MARTINIANO DE CARVALHO", "number": "611", "suite": "AP 64", "district": "BELA VISTA", "city": "SAO PAULO", "state": "SP", "country": "BR" }, "commercial_address": { "postal_code": "01321001", "street": "RUA MARTINIANO DE CARVALHO", "number": "611", "suite": "AP 64", "district": "BELA VISTA", "city": "SAO PAULO", "state": "SP", "country": "BR" }, "working_hours": [ { "start_day": "mon", "end_day": "fri", "start_time": "08:00:00", "end_time": "18:00:00" } ] } } } ``` -------------------------------- ### Run Locally with Maven Wrapper Source: https://docs.globalgetnet.com/pt/products/white-label/paper-rolls Use this command to run the application locally with the 'local' profile. Swagger UI and health check endpoints are available. ```bash ./mvnw spring-boot:run -Dspring-boot.run.profiles=local ``` -------------------------------- ### Get Available Offerings Source: https://docs.globalgetnet.com/pt/products/onboarding/onboarding-overview Consult the available offerings for a given country and channel to allow merchants to choose a plan before registering. You can also retrieve a single offering with detailed rates by providing the `priced_offering_id`. ```HTTP GET /offerings?country=BR&channel={canal} Host: api.getnet.com.br Authorization: Bearer {access_token} ``` ```HTTP GET /offerings?priced_offering_id={id} Host: api.getnet.com.br Authorization: Bearer {access_token} ``` ```HTTP GET /offerings?country=BR&channel={canal}&show_acquirers=true Host: api.getnet.com.br Authorization: Bearer {access_token} ``` -------------------------------- ### Validate Received Code Response Example Source: https://docs.globalgetnet.com/pt/products/white-label/pendencies-api Example JSON response upon successful validation of the received code, indicating the status as 'ok'. ```json { "sms_token_validation_id": "abc-123", "cell_phone": "11999999999", "acquirer_merchant_code": "MC123456", "token": "123456", "device_fingerprint": "fp_abc123xyz", "situation": { "status": "ok" } } ``` -------------------------------- ### Get Offerings (Two-Call Showcase Flow) Source: https://docs.globalgetnet.com/pt/products/onboarding/offerings Fetches a list of available offerings without acquirer fees. Use this when you need to load the list first and then retrieve detailed rates for a selected offer. ```HTTP GET /offerings?country=BR&channel={canal} ``` -------------------------------- ### Request Validation Code Body Example Source: https://docs.globalgetnet.com/pt/products/white-label/pendencies-api Example JSON body for requesting a validation code, specifying the contact channel type and value. ```json { "type": "cell_phone", "value": "11999999999" } ``` -------------------------------- ### Request Validation Code Response Example Source: https://docs.globalgetnet.com/pt/products/white-label/pendencies-api Example JSON response after successfully requesting a validation code, including a unique ID for the validation process. ```json { "sms_token_validation_id": "abc-123", "cell_phone": "11999999999", "acquirer_merchant_code": "MC123456", "situation": { "status": "pending" } } ``` -------------------------------- ### Validate Received Code Body Example Source: https://docs.globalgetnet.com/pt/products/white-label/pendencies-api Example JSON body for validating a received code, including the token, channel details, and an optional device fingerprint. ```json { "token": "123456", "type": "cell_phone", "value": "11999999999", "device_fingerprint": "fp_abc123xyz" } ``` -------------------------------- ### Configure Merchant Accounts for Multiple Brands Source: https://docs.globalgetnet.com/pt/products/onboarding/orders This example demonstrates how to configure a single bank account to receive funds for multiple card brands (master, visa, elo, amex). Ensure each brand has a corresponding entry in the `merchant_accounts` list. ```json { "merchant_accounts": [ { "brand": "master", "merchant": { "merchant_id": "6a0fc6f29a4f90ca92a8670e" }, "bank_account": { "bank": { "bank_country": "BR", "bank_code": "033" }, "bank_branch_code": "0001", "bank_account_number": "123456789", "bank_account_currency": "BRL", "account_type": "cc" }, "payment_center": true, "merchant_account_restriction": [] }, { "brand": "visa", "merchant": { "merchant_id": "6a0fc6f29a4f90ca92a8670e" }, "bank_account": { "bank": { "bank_country": "BR", "bank_code": "033" }, "bank_branch_code": "0001", "bank_account_number": "123456789", "bank_account_currency": "BRL", "account_type": "cc" }, "payment_center": true, "merchant_account_restriction": [] }, { "brand": "elo", "merchant": { "merchant_id": "6a0fc6f29a4f90ca92a8670e" }, "bank_account": { "bank": { "bank_country": "BR", "bank_code": "033" }, "bank_branch_code": "0001", "bank_account_number": "123456789", "bank_account_currency": "BRL", "account_type": "cc" }, "payment_center": true, "merchant_account_restriction": [] }, { "brand": "amex", "merchant": { "merchant_id": "6a0fc6f29a4f90ca92a8670e" }, "bank_account": { "bank": { "bank_country": "BR", "bank_code": "033" }, "bank_branch_code": "0001", "bank_account_number": "123456789", "bank_account_currency": "BRL", "account_type": "cc" }, "payment_center": true, "merchant_account_restriction": [] } ] } ``` -------------------------------- ### Create Order Source: https://docs.globalgetnet.com/pt/products/onboarding/onboarding-overview Creates a new order as part of the onboarding process. This is a prerequisite for subsequent order management steps. ```HTTP POST /orders ``` -------------------------------- ### Example Error Response (400) Source: https://docs.globalgetnet.com/pt/products/onboarding/centralizers This is an example of a 400 Bad Request error response. The 'details' field lists specific validation errors for fields in the payload. ```json { "status_code": 400, "message": "findEcByLegalDocumentNumber.legalDocumentNumber: Deve ser informado um documento válido com 14 digitos", "details": [ { "field": "legal_document_number", "message": "Deve ser informado um documento válido com 14 dígitos." } ] } ``` ```json { "status_code": 400, "message": "findEcByLegalDocumentNumber.legalDocumentNumber: Deve ser informado um documento válido com 14 digitos", "details": [ { "field": "legal_document_number", "message": "Deve ser informado um documento válido com 14 dígitos." } ] } ``` -------------------------------- ### Get Offerings with Acquirer Fees (One-Call Showcase Flow) Source: https://docs.globalgetnet.com/pt/products/onboarding/offerings Fetches a list of offerings that includes acquirer fees in a single call. This flow requires the 'Accept-Encoding: gzip' header and is suitable when you need the rates upfront. ```HTTP GET /offerings?country=BR&channel={canal}&show_acquirers=true ``` -------------------------------- ### Order Item Assembly Mapping Source: https://docs.globalgetnet.com/pt/products/onboarding/onboarding-overview For each selected offer, map its items to order items. This involves determining the 'item_sequence_number', copying 'offering.priced_offering_id' and 'offering.smart_offering_id', mapping 'item.product', using the customer's 'quantity', and including optional fields like 'settlement_period', 'unit_price', and 'total_price'. ```text Para cada oferta selecionada: └─ Para cada item em offering.items[]: ├─ item_sequence_number = próximo número sequencial global ├─ offering.priced_offering_id = offering.priced_offering_id (raiz da oferta) ├─ offering.smart_offering_id = offering.priced_offering_id (raiz da oferta) ├─ product = item.product (cópia integral) ├─ quantity = quantidade informada pelo cliente (item.quantity é apenas a quantidade inicial sugerida pela oferta) ├─ settlement_period = item.settlement_period (se presente) ├─ unit_price = item.unit_price (se presente) └─ total_price = item.total_price (se presente) ``` -------------------------------- ### List Offerings with Acquirers (All in One Call) Source: https://docs.globalgetnet.com/pt/products/onboarding/offerings Combines listing offerings and retrieving their acquisition fees into a single API call by setting the `show_acquirers` query parameter to true and including the `Accept-Encoding: gzip` header. ```APIDOC ## GET /v1/offerings?country=BR&channel=meu_canal&show_acquirers=true ### Description This endpoint allows fetching the list of offerings along with their acquisition fees in a single request. It requires the `show_acquirers` query parameter to be set to `true` and the `Accept-Encoding: gzip` header to be included for compression. ### Method GET ### Endpoint /v1/offerings ### Query Parameters - **country** (string) - Required - The country code (e.g., BR). - **channel** (string) - Required - The sales channel identifier (e.g., meu_canal). - **show_acquirers** (boolean) - Required - Set to `true` to include acquisition fees in the response. ### Headers - **Accept-Encoding** (string) - Required when `show_acquirers` is `true`. Use `gzip`. ### Request Example ```http GET /v1/offerings?country=BR&channel=meu_canal&show_acquirers=true HTTP/1.1 Host: api-homologacao.getnet.com.br:443 Authorization: {token} Accept-Encoding: gzip ``` ### Response #### Success Response (200) Returns a list of offerings, where each offering object includes detailed acquisition fees similar to the response of the 'Get Offering Details with Pricing' endpoint. ``` -------------------------------- ### Offerings - List Available Offers Source: https://docs.globalgetnet.com/pt/products/onboarding/onboarding-overview Consult the available offers for a given channel and country to allow merchants to choose a plan before registering. ```APIDOC ## GET /offerings ### Description Retrieves a list of available offerings for a specified country and channel. Optionally, it can include acquirer fees. ### Method GET ### Endpoint /offerings ### Query Parameters - **country** (string) - Required - The country code (e.g., 'BR'). - **channel** (string) - Required - The channel identifier. - **show_acquirers** (boolean) - Optional - If true, includes acquirer fees in the response. - **priced_offering_id** (string) - Optional - If provided, returns a single offering with detailed fees per card network. ### Response #### Success Response (200 OK) - **id** (string) - The unique identifier for the offering. - **name** (string) - The name of the offering. - **description** (string) - A description of the offering. - **acquirer_fees** (object) - Details about acquirer fees (only if `show_acquirers` is true or `priced_offering_id` is used). ### Response Example (List all offers) ```json [ { "id": "offer_123", "name": "Basic Plan", "description": "Standard onboarding package." }, { "id": "offer_456", "name": "Premium Plan", "description": "Includes advanced features and lower fees." } ] ``` ### Response Example (Single offer with fees) ```json { "id": "offer_789", "name": "Premium Plan with Fees", "description": "Detailed view of premium plan fees.", "acquirer_fees": { "visa": { "rate": "2.90%", "fixed_fee": "0.30" }, "mastercard": { "rate": "2.85%", "fixed_fee": "0.25" } } } ``` ``` -------------------------------- ### Installation Changed Payload with Priority Change Source: https://docs.globalgetnet.com/pt/products/sap-immediate-delivery/webook-sap This payload indicates an installation status change where the priority has been updated, potentially rerouting the service order to a different logistics provider. It includes metadata and a payload detailing the new priority and a reason for the change. ```json { "metadata": { "event_id": "b46ee43a-246a-48cb-bcad-e6799b61f83d", "event_type": "INSTALLATION_CHANGED", "schema_version":"1", "producer": "erp-field-service-ms", "order_number": "MXD54S433", "work_order_id": "bb2d7a60-0e88-4ca5-98c8-7aedc2098703", "work_order_number": "43214567", "occurred_at": "2025-12-27T10:00:00.000Z" }, "payload": { "priority": "NORMAL", "details": "A ordem de serviço foi encaminhada para outro operador logístico." } ``` ```json { "metadata": { "event_id": "b46ee43a-246a-48cb-bcad-e6799b61f83d", "event_type": "INSTALLATION_CHANGED", "schema_version":"1", "producer": "erp-field-service-ms", "order_number": "MXD54S433", "work_order_id": "bb2d7a60-0e88-4ca5-98c8-7aedc2098703", "work_order_number": "43214567", "occurred_at": "2025-12-27T10:00:00.000Z" }, "payload": { "priority": "NORMAL", "details": "A ordem de serviço foi encaminhada para outro operador logístico." } ``` -------------------------------- ### Create Merchant (Minimal Data) Source: https://docs.globalgetnet.com/pt/products/onboarding/onboarding-overview Use this endpoint to create a new merchant with essential information. The response includes the `merchant_id`, which is crucial for subsequent calls. ```bash POST /merchants │ Enviar: CPF/CNPJ + dados pessoais básicos + opt-ins (LGPD + termos) │ Retorna: merchant_id + sub_status_steps (etapas pendentes) │ └──► Guardar o merchant_id para usar nas etapas seguintes. ``` -------------------------------- ### Get Merchant Data Source: https://docs.globalgetnet.com/pt/products/onboarding/onboarding-overview Retrieves the complete data for a specific merchant. ```APIDOC ## GET /merchants/{merchant_id} ### Description Fetches the full details of a specific merchant using their unique ID. ### Method GET ### Endpoint /merchants/{merchant_id} ### Parameters #### Path Parameters - **merchant_id** (string) - Required - The unique identifier of the merchant. ### Response #### Success Response (200) - Returns the complete merchant object with all associated data. ``` -------------------------------- ### Get Merchant Details Source: https://docs.globalgetnet.com/pt/products/white-label/fee-merchant Retrieves details for a specific merchant using their ID. ```APIDOC ## GET /fee-merchant/v1/merchants/{id} ### Description Retrieves details for a specific merchant. ### Method GET ### Endpoint /fee-merchant/v1/merchants/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the merchant. #### Response #### Success Response (200) - **EstablishmentDTO** (object) - Contains the merchant's details. ``` -------------------------------- ### Get Merchant Qualification Result Source: https://docs.globalgetnet.com/pt/products/onboarding/merchants Retrieves the result of the latest qualification process for a merchant. ```APIDOC ## GET /merchants/{merchant_id}/qualification ### Description Retrieves the outcome of the most recent risk and compliance qualification for a merchant. ### Method GET ### Endpoint /merchants/{merchant_id}/qualification ### Parameters #### Path Parameters - **merchant_id** (string) - Required - The unique identifier of the merchant. ### Response #### Success Response (200) - **report.recommended.status** (string) - The status of the qualification ('approved' or 'reproved'). - **report.details** (array) - Details about the qualification, including reasons for reproval. ``` -------------------------------- ### Assisted Onboarding Endpoints Source: https://docs.globalgetnet.com/pt/products/onboarding/onboarding-overview Reference for API endpoints used in the assisted merchant onboarding flow. ```APIDOC ## POST /token ### Description Authenticates the user and obtains an access token. ### Method POST ### Endpoint /token ``` ```APIDOC ## GET /establishment-contracts-basic/legal-document-number/{doc}/ec-accredited ### Description Performs a preliminary check using the legal document number. ### Method GET ### Endpoint /establishment-contracts-basic/legal-document-number/{doc}/ec-accredited ### Parameters #### Path Parameters - **doc** (string) - Required - The legal document number for verification. ``` ```APIDOC ## POST /merchants ### Description Creates a new merchant profile. ### Method POST ### Endpoint /merchants ``` ```APIDOC ## GET /offerings ### Description Retrieves the available offerings with optional filtering parameters. ### Method GET ### Endpoint /offerings ### Parameters #### Query Parameters - **monthly_card_income** (string) - Optional - Filter by monthly card income. - **merchant_category_code** (string) - Optional - Filter by merchant category code. - **fiscal_type** (string) - Optional - Filter by fiscal type. ``` ```APIDOC ## GET /domains/zipcode/{postal_code} ### Description Queries for domain information based on a postal code. ### Method GET ### Endpoint /domains/zipcode/{postal_code} ### Parameters #### Path Parameters - **postal_code** (string) - Required - The postal code to query. ``` ```APIDOC ## GET /offerings/delivery-data ### Description Retrieves delivery data related to offerings. ### Method GET ### Endpoint /offerings/delivery-data ``` ```APIDOC ## GET /merchants/{merchant_id} ### Description Retrieves the current merchant's details. ### Method GET ### Endpoint /merchants/{merchant_id} ### Parameters #### Path Parameters - **merchant_id** (string) - Required - The ID of the merchant to retrieve. ``` ```APIDOC ## PUT /merchants/{merchant_id} ### Description Updates the details of an existing merchant. ### Method PUT ### Endpoint /merchants/{merchant_id} ### Parameters #### Path Parameters - **merchant_id** (string) - Required - The ID of the merchant to update. ``` ```APIDOC ## POST /merchants/{merchant_id}/qualification ### Description Initiates the qualification process for a merchant. ### Method POST ### Endpoint /merchants/{merchant_id}/qualification ### Parameters #### Path Parameters - **merchant_id** (string) - Required - The ID of the merchant to qualify. ``` ```APIDOC ## GET /merchants/{merchant_id}/qualification ### Description Queries the qualification status of a merchant. ### Method GET ### Endpoint /merchants/{merchant_id}/qualification ### Parameters #### Path Parameters - **merchant_id** (string) - Required - The ID of the merchant whose qualification status to check. ``` ```APIDOC ## POST /orders ### Description Creates a new order. ### Method POST ### Endpoint /orders ``` ```APIDOC ## PUT /orders/{order_id} ### Description Updates an existing order. ### Method PUT ### Endpoint /orders/{order_id} ### Parameters #### Path Parameters - **order_id** (string) - Required - The ID of the order to update. ``` ```APIDOC ## POST /orders/{order_id}/validation ### Description Validates an order. ### Method POST ### Endpoint /orders/{order_id}/validation ### Parameters #### Path Parameters - **order_id** (string) - Required - The ID of the order to validate. ``` ```APIDOC ## PUT /orders/{order_id}/submit ### Description Submits an order for processing. ### Method PUT ### Endpoint /orders/{order_id}/submit ### Parameters #### Path Parameters - **order_id** (string) - Required - The ID of the order to submit. ``` -------------------------------- ### Get Merchant Status Source: https://docs.globalgetnet.com/pt/products/onboarding/merchants Use this endpoint to retrieve the current status and data of a merchant before updating PJ information. ```text GET /merchants/6a0f43fd9a4f90ca92a8596d ``` -------------------------------- ### Get Merchant Data Source: https://docs.globalgetnet.com/pt/products/onboarding/merchants Retrieves all data for a specific merchant using their ID. This is a mandatory step before performing any updates. ```http GET /merchants/{merchant_id} ```