Onboarding API — PJ
Before registering a partner through the API, confirm that your marketplace itself is already accredited with Getnet. This accreditation is a manual process, handled directly with Getnet, and is a prerequisite for every endpoint below.
Verify Whether the Partner Already Exists
Before registering a partner, check whether their CNPJ is already registered under your marketplace. Partners can also register directly through Getnet's Portal Minha Conta, so this check avoids a creation call being rejected for duplication.
- Send a GET request to
/v2/mgm/pj/consult/{merchant_id}/{cnpj}, replacingmerchant_idwith your marketplace's identification number at Getnet (EC, Merchant Establishment) andcnpjwith the partner's CNPJ. - Include the
Authorizationheader with the access token, in the formatBearer <token>. - Check the response code:
- 200: the partner is already registered. The response body returns the partner's current data inside an array.
- 206: no eligible registration was returned for that CNPJ. Rejected, declined, or de-accredited registrations may not appear in this query and may be handled later as a retry or reuse. Continue at Create the Partner's Pre-Registration.
- 400, 401, 404, 500: see Check the Response Codes, further below.
CNPJ Format
cnpj must have 14 positions. Both formats are accepted:- Numeric: 14 digits.
- Alphanumeric: the first 8 positions and the next 4 can be letters or numbers. The last 2 positions (check digits) must be numeric. Letters are automatically normalized to uppercase.
In both formats, the relationship between a headquarters and its branches is kept through the CNPJ's root digits.
Create the Partner's Pre-Registration
/v2/mgm/pj/create-presubseller with the partner's registration data.- Set the
Authorizationheader with the access token, in the formatBearer <token>. - Build the request body with the required fields listed in the table below.
- Send the request and check the response code in the Check the Response Codes table, further below.
Required Fields
| Field | Type | Rules |
|---|---|---|
merchant_id | string | Digits only. Your marketplace's identification number at Getnet (EC). |
legal_document_number | string | The partner's CNPJ. ATIVA status with the Federal Revenue Service is a business rule. The endpoint doesn't query the Federal Revenue Service directly in this flow. See CNPJ Format, above. |
legal_name | string | Corporate name, as registered with the Federal Revenue Service. Avoid special characters, accents, or abbreviations. |
trade_name | string | Trade name. Can't be empty. Avoid accented characters. |
state_fiscal_document_number | string | State registration number. Digits only, or "ISENTO" if the company is exempt. |
email | string | Valid email format. No accents or special characters. The domain can't be @getnet or @santander. |
business_address | object | See Address Rules, further below. |
bank_accounts | object | See Bank Account Rules, further below. Payments are only made to a bank account under the same CNPJ registered with Getnet. |
payment_plan | integer | Must match a plan returned by List the Available Payment Plans. |
accepted_contract | string | Must be "S". Although the field accepts "N", the registration only proceeds with "S". |
phone or cellphone | object | At least one of the two is required. See Phone Rules, further below. cellphone is required if the partner will use Anticipation. |
Optional Fields
| Field | Type | Notes |
|---|---|---|
business_entity_type | integer | Legal nature code from the CNPJ record. 4 digits. |
economic_activity_classification_code | integer | Main CNAE code from the CNPJ record. 6 or 7 digits. |
monthly_gross_income | number | Monthly revenue, or projected revenue if the company has no registered year. Must be greater than R$100.00. |
billing_value | number | Annual revenue, or projected revenue. Must be greater than R$100.00. Required for Anticipation. |
billing_date | string (date-time) | |
federal_registration_status | string | One of: "ATIVO", "SUSPENSO", "INAPTO", "DESATIVADO", "ANULADO". |
founding_date | string (date-time) | Must be after 01/01/1900 and can't be a future date. |
identification_document | object | NIRE document data. |
legal_representative | object | The partner's legal representative. |
shareholders | array | The partner's shareholders (individual or legal entity). |
list_commissions | array | See Commission Rules, further below. |
marketplace_store | string | "S" or "N". |
automatic_anticipation | string | "S" or "N". |
list_centralizer | array of strings | List of centralized ECs linked to the centralizing EC given in merchant_id. |
subsellerid_ext | string | Conditionally required or prohibited, depending on the marketplace's configuration. Required for marketplaces that use a sales plugin. It must not be sent by the others. |
Phone Rules
- Mobile: 9 digits, with the first digit being
9for most area codes (DDDs). DDDs 41, 46, 47, 48, 49, 51, 53, 54, 55, 61, 62, 64, 65, 66, 67, 68, and 69 have their own rules. - Landline: 8 digits, with the first digit
2,3,4, or5. The DDD must appear on ANATEL's list.
Address Rules
streetcan't be empty or null.numbermust contain digits only, if provided. Use0ornullif the address has no number.postal_codemust be a valid CEP (postal code).city,state, anddistrictare required.suiteis also part of the address object (e.g. apartment or unit number).
Bank Account Rules
type_accountsdistinguishes a single bank account (unique_account) from brand-specific accounts (custom_accounts). Send only the object that matchestype_accounts; never sendunique_accountandcustom_accountstogether.unique_account:account_type,bank(bank code),agency,agency_digit,account,account_digit.custom_accounts: an array with at least one item, with the same fields asunique_account, plusbrand(e.g."Mastercard").
Commission Rules
brand,product, andpayment_planare required.- Set
commission_percentageorcommission_value, not both. Ifcommission_percentageis greater than 0,commission_valuemust be0ornull. commission_percentageaccepts values between0.00and100.00.commission_valuemust be0.00or greater.
List the Available Payment Plans
/v2/mgm/pj/consult/paymentplans/{merchant_id} to get the payment plans available for your marketplace. Use the returned paymentplan_id values when setting payment_plan in Create the Partner's Pre-Registration.Check the Partner's Registration Status
/v2/mgm/pj/consult/{merchant_id}/{cnpj} to check a partner's current status at any time, using the same call described in Verify Whether the Partner Already Exists./v2/mgm/pj/callback/{merchant_id}/{cnpj}, which returns the data inside an array and may include additional report information.Update the Partner's Registration
/v2/mgm/pj/update-subseller with the fields you want to change. Only merchant_id, subseller_id, and legal_document_number are required. The remaining fields follow the same rules as Create the Partner's Pre-Registration and only need to be sent if they're being changed.De-Accredit the Partner
/v2/mgm/pj/de-accredit/{merchant_id}/{subseller_id} to de-accredit a partner, replacing subseller_id with the partner's identifier.Check the Response Codes
| Code | Meaning |
|---|---|
| 200 | Success. |
| 206 | No eligible registration returned (query only). Rejected, declined, or de-accredited registrations may not appear. |
| 400 | Invalid request. |
| 401 | Access denied. |
| 404 | Not found. |
| 500 | Internal server error. |
These calls cover the legal-entity partner's full lifecycle, from initial verification to de-accreditation. Always validate the result using the response codes above.
Next Steps
- Onboarding API — PF: the same flow for individual partners.
- Payment Acceptance: see how to process sales once the partner is registered.
On this page