DocumentationAPI Reference

Introduction

The self-accreditation process aims to bring fluidity and agility to the release process through a 100% online flow to quickly enable the authorization of your operation. For self-accreditation in channels open to the public, it is necessary to send documentation and, mainly, facial biometrics via the Getnet Brasil app.

Through this guide, we will explore each of the steps, providing details of this journey in order to bring clarity and ensure that by the end of the reading, you are ready to be qualified.

What is the process like?

We can define that this process occurs in 3 main stages:

  • Offer showcase;
  • Establishment registration;
  • Order.

As you read, we will explore each of the steps, as well as business rules, REST operations, and how to complete them. The goal is that by the end of the reading, you will be ready to purchase products and services.

The steps

In this section, we will explore the steps in detail, showing what is necessary to achieve the objective in each of them in a functional and technical way.

The diagram below illustrates the self-accreditation flow, covering the steps that will be detailed below:

To consume REST operations, it is necessary to perform the authentication flow available in this documentation link . The generated access_token must be passed as a parameter called “ Authorization ” in the call header.

Step 1: Offer Showcase

The Offers Showcase aims to allow customers to find out which products and services are available for purchase. There is a variety of products and services ranging from digital and financial solutions to the famous card machines.

When we look at the topic of digital and financial solutions, there are mechanisms that can further promote financial health, such as the anticipation of receivables or facilitators for your operation, such as the payment link.

To find out about the available offers, we have a REST operation in the Offers service that brings all the products and services that can be purchased:

GET https://{getnet-api-base}/v1/offerings

Important parameters ( queryParams ):

  • country - This is the source channel and from there it returns the offers associated with the channel;
  • channel - Through this information, you will be able to see exclusive offers for the country informed;
  • fiscal_type - Denotes whether it is an individual or a legal entity.

Technical documentation for the service is available on the Listing and Obtaining Offers page .

After selecting one of the offers listed in the showcase, it must be priced, that is, the prices and rates of Getnet products and services must be consulted in the internal systems to generate the pricing according to the type of product.

Pricing must be done through the Offers service:

GET https://{getnet-api-base}/v1/offerings/{offering_id}/pricing

Important parameters (path):

  • offering_id - identifier of the offering to be priced.

Technical documentation for the service is available on the Pricing page .

Once the offer has been priced, it must be made available for inclusion in the order. To do this, all updated information about the offer must be retrieved, and this must be done through the Offers service:

GET https://{getnet-api-base}/v1/offerings?priced_offering_id={offering_id}

Important parameters ( queryParam ):

  • offering_id - offer identifier.

Technical documentation for the service is available on the Offers - Listing and Obtaining page .

Step 2: Establishment Registration

To consolidate offers and even see their viability, we need to know more about you and the establishment, because through this information we will be able to evaluate more personalized products and services, in addition to carrying out some internal validation flows.

The establishment registration is divided into two forms:

Simplified - In the simplified version, it will be necessary to perform 3 steps via APIs:

  • Pre - registration - Here you enter some basic information , such as type of person (legal or natural), document number and country to start the registration process;
  • The update - At this stage, the “ pre -registration” step returns some fields relevant to the operation and some additional information that must be used to update your registration completely:
    • Legal Entity: in addition to general company data, other groups of data are also required, such as: business address, economic activity, contact, partners, legal representative, opening hours, etc .;
    • Individual: in addition to personal data, other groups of data are also required, such as: residential and business address, economic activity, opening hours, etc.
  • Qualification - In this final stage , we will evaluate all the data sent to ensure that it is compliant and also , a complete evaluation of your registration will be carried out to enable the contracting of products and services;

Complete - In this aspect, the flow will occur in two stages also via APIs:

  • Registration - In this operation, it will be necessary to inform all fields relevant to the type of person:
    • Legal Entity: in addition to general company data, other groups of data are also required, such as: business address, economic activity, contact, partners, legal representative, opening hours, etc .;
    • Individual: in addition to personal data, other groups of data are also required, such as: residential and business address, economic activity, opening hours, etc.
  • Qualification - This stage follows the same format as the simplified version, i.e., the entire registration will be evaluated to ensure that the products and services are relevant.

REST Operations:

Simplified Registration

POST https://{getnet-api-base}/merchants

Important parameters (body):

  • acquirer_code : Acquirer code (will always be getnet );
  • merchant_legal_data : This is an object that will contain information about the establishment itself:
    • Legal Person : country, person.fiscal _type , person.legal _document_number ;
    • Individual : country, person.fiscal_type, person.legal_document_number and birth_date.
  • additional_information : For registration purposes, terms and conditions, it is necessary to accept this information and for this, this object represents the “acceptance” of the LGPD terms and general operating conditions.

Technical documentation for the services is available on the Simplified Registration and Document Consultation pages .

Registration supplement

PUT https://{getnet-api-base}/merchants

Important parameters (path):

  • merchant_id : Merchant ID. Important parameters (body):
  • acquirer_code : Acquirer code (will always be getnet );
  • merchant_legal_data : This is an object that will contain information about the establishment itself:
    • Legal Entity : country, person.fiscal_type, person.legal_document_number, person.legal_name, person.founding_date, person.business_address, person.economic_activity_profile, person.contacts, person.shareholders, person.legal_representative, person.working_hours and others;
    • Individual : country, person.fiscal_type, person.legal_document_number, person, person.birth_date, person.economic_activity_profile, person.residential_address, person.commercial_address, person.working_hours, person.legal_representative and others.
  • additional_information : For registration purposes, terms and conditions, it is necessary to accept this information and for this, this object represents the “acceptance” of the LGPD terms and general operating conditions.

Technical documentation for the services is available on the Simplified Registration and Document Consultation pages .

Registration qualification

POST https://{getnet-api-base}/merchants/{merchant_id}/qualification

Important parameters (path):

  • merchant_id : Establishment identification.

The technical documentation of the operations is available at this Merchants link .

Step 3: Creating the Order

For an individual or legal entity to actually become a Getnet customer , it is necessary to purchase products and/or services and to do so an order must be placed.

The request includes information about the selected offer, establishment details, as well as the customer's address and bank account for receiving payments.

To create an order, the Orders service must be used:

POST https://{getnet-api-base}/v1/orders

Important parameters (body):

  • merchant_legal_data : This is an object that will contain information about the establishment itself, such as: country, person.fiscal _type , person.legal _document_number and the like;
  • delivery_info : object containing the information to deliver the products purchased in the order;
  • merchant_accounts : object containing bank account details for receiving payments;
  • items : object that contains all the products and services requested in the order.

Technical documentation for the service is available on the Order Creation page .

After sending the order, it is necessary to validate the data sent for the order and check whether they are in order to actually submit the order.

To validate the order, the Orders service must be used:

POST https://{getnet-api-base}/v1/orders/{order_id}/validation

Important parameters (path):

  • order_id : identifier of the order to be validated.

Technical documentation for the service is available on the Order Validation page .

Once the order is validated and approved, the order can be submitted for purchase and shipping of products and/or services.

To send the order, the Orders service must be used:

PUT https://{getnet-api-base}/v1/orders/{order_id}/submit

Important parameters (path):

  • order_id : identifier of the order to be validated.

Technical documentation for the service is available on the Order Submission page .