{ "swagger": "2.0", "info": { "version": "1.1.3", "title": "Marketplace API Reference - Backend Environment | Digital Platform", "description": "Available servers:\n\n| Environment | URL |\n| --- | --- |\n| Production | https://api-backoffice.getnet.com.br |\n| Homologation | https://api-homologacao.getnet.com.br |" }, "host": "api-homologacao.getnet.com.br", "schemes": [ "https" ], "tags": [ { "name": "Authentication", "x-displayName": "Authentication", "description": "The APIs listed in this documentation use OAuth2 authentication, which means that all requests must include an access token obtained through authentication with your Client ID and Client Secret.\n" } ], "paths": { "/v2/mgm/pf/create-presubseller": { "post": { "tags": [ "Onboarding Subseller" ], "summary": "Create pre-registration for individual store.", "description": "Store data for pre-registration. Attention: mandatory attributes marked as required.", "x-notes": "Migrated from OpenAPI 3.0 requestBody", "consumes": [ "application/json" ], "parameters": [ { "name": "Content-Type", "in": "header", "description": "Content type.", "required": true, "type": "string", "enum": [ "application/json" ], "default": "application/json" }, { "name": "Authorization", "in": "header", "description": "Authorization: Bearer *AuthString*. Where *AuthString* is the access token obtained from the authentication endpoint.", "required": true, "type": "string", "enum": [ "Bearer AuthString" ], "default": "Bearer AuthString" }, { "name": "body", "in": "body", "description": "Store data for pre-registration.", "required": true, "schema": { "$ref": "#/definitions/RequestPreSubSellerPFIncludeViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ResponsePreSubSellerPF" } }, "400": { "description": "Invalid request.", "schema": { "type": "string" } }, "401": { "description": "Access denied.", "schema": { "type": "string" } }, "404": { "description": "No results found.", "schema": { "type": "string" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/ResponseErrors" } } } } }, "/v2/mgm/pf/consult/{merchant_id}/{cpf}": { "get": { "tags": [ "Onboarding Subseller" ], "summary": "Query registration status for a CPF.", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Content type.", "required": true, "type": "string", "enum": [ "application/json" ], "default": "application/json" }, { "name": "Authorization", "in": "header", "description": "Authorization: Bearer *AuthString*. Where *AuthString* is the access token obtained from the authentication endpoint.", "required": true, "type": "string", "enum": [ "Bearer AuthString" ], "default": "Bearer AuthString" }, { "name": "merchant_id", "in": "path", "description": "Identification number (EC) of the Marketplace at GETNET.\r\n

Rules:

Must contain only numeric digits.

", "required": true, "type": "string" }, { "name": "cpf", "in": "path", "description": "CPF to be queried.\r\n

Rules:

Must contain only numeric digits;
Must contain a maximum of 11 numeric digits.

", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "One item returned successfully.", "schema": { "$ref": "#/definitions/ResponseSubSellerPF" } }, "206": { "description": "No results found.", "schema": { "type": "string" } }, "400": { "description": "Invalid request.", "schema": { "$ref": "#/definitions/ResponseMessages" } }, "401": { "description": "Access denied.", "schema": { "type": "string" } }, "404": { "description": "Not found.", "schema": { "type": "string" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/ResponseErrors" } } } } }, "/v2/mgm/pf/callback/{merchant_id}/{cpf}": { "get": { "tags": [ "Onboarding Subseller" ], "summary": "Query registration status for a CPF (CALLBACK).", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Content type.", "required": true, "type": "string", "enum": [ "application/json" ], "default": "application/json" }, { "name": "Authorization", "in": "header", "description": "Authorization: Bearer *AuthString*. Where *AuthString* is the access token obtained from the authentication endpoint.", "required": true, "type": "string", "enum": [ "Bearer AuthString" ], "default": "Bearer AuthString" }, { "name": "merchant_id", "in": "path", "description": "Marketplace identification number (EC) at GETNET.\r\n

Rules:

Must contain only numeric digits.

", "required": true, "type": "string" }, { "name": "cpf", "in": "path", "description": "CPF to be queried.\r\n

Rules:

Must contain only numeric digits;
Must contain a maximum of 11 numeric digits.

", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "One item returned successfully.", "schema": { "type": "array", "items": { "$ref": "#/definitions/ResponseSubSellerCallbackPF" } } }, "206": { "description": "No results found.", "schema": { "type": "string" } }, "400": { "description": "Invalid request. Observed scenario (invalid CPF): {\"messages\":[\"Ocorreu um erro ao consultar a situação cadastral.\",\"Número de CPF inválido.\"]}", "schema": { "$ref": "#/definitions/ResponseMessages" } }, "401": { "description": "Access denied.", "schema": { "type": "string" } }, "404": { "description": "Not found.", "schema": { "type": "string" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/ResponseErrors" } } } } }, "/v2/mgm/pf/consult/paymentplans/{merchant_id}": { "get": { "tags": [ "Onboarding Subseller" ], "summary": "Query payment plans that can be configured for Marketplace stores.", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Content type.", "required": true, "type": "string", "enum": [ "application/json" ], "default": "application/json" }, { "name": "Authorization", "in": "header", "description": "Authorization: Bearer *AuthString*. Where *AuthString* is the access token obtained from the authentication endpoint.", "required": true, "type": "string", "enum": [ "Bearer AuthString" ], "default": "Bearer AuthString" }, { "name": "merchant_id", "in": "path", "description": "Marketplace identification number (EC) at GETNET.\r\n

Rules:

Must contain only numeric digits.

", "required": true, "type": "string" } ], "responses": { "200": { "description": "One item returned successfully.", "schema": { "type": "array", "items": { "$ref": "#/definitions/ResponsePaymentPlan" } } }, "400": { "description": "Invalid request.", "schema": { "$ref": "#/definitions/ResponseMessages" } }, "401": { "description": "Access denied.", "schema": { "type": "object" } }, "404": { "description": "Not found.", "schema": { "type": "string" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/ResponseErrors" } } } } }, "/v2/mgm/pf/update-subseller": { "put": { "tags": [ "Onboarding Subseller" ], "summary": "Update store registration.", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Content type.", "required": true, "type": "string", "enum": [ "application/json" ], "default": "application/json" }, { "name": "Authorization", "in": "header", "description": "Authorization: Bearer *AuthString*. Where *AuthString* is the access token obtained from the authentication endpoint.", "required": true, "type": "string", "enum": [ "Bearer AuthString" ], "default": "Bearer AuthString" }, { "name": "body", "in": "body", "description": "Store data to update.", "required": true, "schema": { "$ref": "#/definitions/RequestSubSellerPFUpdateViewModel" } } ], "responses": { "200": { "description": "Change completed successfully.", "schema": { "$ref": "#/definitions/ResponseSubSellerUpdate" } }, "400": { "description": "Invalid request.", "schema": { "$ref": "#/definitions/ResponseMessages" } }, "401": { "description": "Access denied.", "schema": { "type": "string" } }, "404": { "description": "No results found.", "schema": { "type": "string" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/ResponseErrors" } } } } }, "/v2/mgm/pf/de-accredit/{merchant_id}/{subseller_id}": { "post": { "tags": [ "Onboarding Subseller" ], "summary": "Deactivate store.", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Content type.", "required": true, "type": "string", "enum": [ "application/json" ], "default": "application/json" }, { "name": "Authorization", "in": "header", "description": "Authorization: Bearer *AuthString*. Where *AuthString* is the access token obtained from the authentication endpoint.", "required": true, "type": "string", "enum": [ "Bearer AuthString" ], "default": "Bearer AuthString" }, { "name": "merchant_id", "in": "path", "description": "Marketplace identification number (EC) at GETNET.\r\n

Rules:

Must contain only numeric digits.

", "required": true, "type": "string" }, { "name": "subseller_id", "in": "path", "description": "Unique identifier of the store to be deactivated.\r\n

Rules:

Must contain only numeric digits.

Rules:

Must contain only numeric digits.

", "required": true, "type": "string" }, { "name": "cnpj", "in": "path", "description": "CNPJ to be queried.\r\n

Rules:

Must have 14 characters (CNPJ check digit calculation will be performed);
As of July 2026, CNPJ format is alphanumeric: the first 8 characters must be alphanumeric (letters and numbers), the next 4 characters must also be alphanumeric, and the last 2 characters must be numeric (check digits); letters are automatically normalized to UPPERCASE.
The purely numeric CNPJ format issued before July 2026 remains valid.
The relationship between headquarters (matriz) and branches (filiais) is maintained through the CNPJ's root/radical, in both the alphanumeric and purely numeric formats.

", "required": true, "type": "string" } ], "responses": { "200": { "description": "One item returned successfully.", "schema": { "$ref": "#/definitions/ResponseSubSellerPJ" } }, "206": { "description": "No results found.", "schema": { "type": "string" } }, "400": { "description": "Invalid request.", "schema": { "$ref": "#/definitions/ResponseMessages" } }, "401": { "description": "Access denied.", "schema": { "type": "string" } }, "404": { "description": "URL not found.", "schema": { "type": "string" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/ResponseErrors" } } } } }, "/v2/mgm/pj/callback/{merchant_id}/{cnpj}": { "get": { "tags": [ "Onboarding Subseller" ], "summary": "Query registration status of a CNPJ (CALLBACK).", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Content type.", "required": true, "type": "string", "enum": [ "application/json" ], "default": "application/json" }, { "name": "Authorization", "in": "header", "description": "Authorization: Bearer *AuthString*. Where *AuthString* is the access token obtained from the authentication endpoint.", "required": true, "type": "string", "enum": [ "Bearer AuthString" ], "default": "Bearer AuthString" }, { "name": "merchant_id", "in": "path", "description": "Marketplace identification number (EC) at GETNET.\r\n

Rules:

Must contain only numeric digits.

", "required": true, "type": "string" }, { "name": "cnpj", "in": "path", "description": "CNPJ to be queried.\r\n

Rules:

Must have 14 characters (CNPJ check digit calculation will be performed);
As of July 2026, CNPJ format is alphanumeric: the first 8 characters must be alphanumeric (letters and numbers), the next 4 characters must also be alphanumeric, and the last 2 characters must be numeric (check digits); letters are automatically normalized to UPPERCASE.
The purely numeric CNPJ format issued before July 2026 remains valid.
The relationship between headquarters (matriz) and branches (filiais) is maintained through the CNPJ's root/radical, in both the alphanumeric and purely numeric formats.

", "required": true, "type": "string" } ], "responses": { "200": { "description": "One item returned successfully.", "schema": { "type": "array", "items": { "$ref": "#/definitions/ResponseSubSellerCallbackPJ" } } }, "404": { "description": "Not found." }, "401": { "description": "Access denied." }, "206": { "description": "No results found." }, "400": { "description": "Invalid request.", "schema": { "$ref": "#/definitions/ResponseMessages" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/ResponseErrors" } } } } }, "/v2/mgm/pj/consult/paymentplans/{merchant_id}": { "get": { "tags": [ "Onboarding Subseller" ], "summary": "Query payment plans that can be configured for Marketplace stores.", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Content type.", "required": true, "type": "string", "enum": [ "application/json" ], "default": "application/json" }, { "name": "Authorization", "in": "header", "description": "Authorization: Bearer *AuthString*. Where *AuthString* is the access token obtained from the authentication endpoint.", "required": true, "type": "string", "enum": [ "Bearer AuthString" ], "default": "Bearer AuthString" }, { "name": "merchant_id", "in": "path", "description": "Marketplace identification number (EC) at GETNET.\r\n

Rules:

Must contain only numeric digits.

Mandatory rules:

Required - Mandatory fields for transactions;

When the attribute represents an object, consider the Required to define the object's mandatory status;
When the attribute represents an object, if informed (mandatory or optional) also consider the mandatory rules of the object's fields.

Mandatory for Anticipation - Mandatory fields for the anticipation service.

", "required": true, "schema": { "$ref": "#/definitions/RequestSubSellerPJUpdateViewModel" } } ], "responses": { "200": { "description": "Change completed successfully.", "schema": { "$ref": "#/definitions/ResponseSubSellerUpdate" } }, "400": { "description": "Invalid request.", "schema": { "$ref": "#/definitions/ResponseMessages" } }, "401": { "description": "Access denied.", "schema": { "type": "string" } }, "404": { "description": "No results found.", "schema": { "type": "string" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/ResponseErrors" } } } } }, "/v2/mgm/pj/de-accredit/{merchant_id}/{subseller_id}": { "post": { "tags": [ "Onboarding Subseller" ], "summary": "Deactivate store.", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Content type.", "required": true, "type": "string", "enum": [ "application/json" ], "default": "application/json" }, { "name": "Authorization", "in": "header", "description": "Authorization: Bearer *AuthString*. Where *AuthString* is the access token obtained from the authentication endpoint.", "required": true, "type": "string", "enum": [ "Bearer AuthString" ], "default": "Bearer AuthString" }, { "name": "merchant_id", "in": "path", "description": "Marketplace identification number (EC) at GETNET.\r\n

Rules:

Must contain only numeric digits.

", "required": true, "type": "string" }, { "name": "subseller_id", "in": "path", "description": "Unique identifier of the store to be deactivated.\r\n

Rules:

Must contain only numeric digits.

", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ResponseErrors" } }, "400": { "description": "Invalid request.", "schema": { "type": "string" } }, "401": { "description": "Access denied.", "schema": { "type": "string" } }, "404": { "description": "No results found.", "schema": { "type": "string" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/ResponseErrors" } } } } }, "/v3/mgm/statement/not-paginated": { "get": { "tags": [ "Statement V3" ], "summary": "Electronic Statement Request not paginated", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Content type.", "required": true, "type": "string", "enum": [ "application/json" ], "default": "application/json" }, { "name": "Authorization", "in": "header", "description": "Authorization: Bearer *AuthString*. Where *AuthString* is the access token obtained from the authentication endpoint.", "required": true, "type": "string", "enum": [ "Bearer AuthString" ], "default": "Bearer AuthString" }, { "name": "seller_id", "in": "query", "description": "Access key of the Anchor (SellerId). In addition to this field being mandatory, at least one other filter will be needed for combination", "required": true, "maxLength": 50, "type": "string" }, { "name": "subseller_id", "in": "query", "description": "Partner code generated by Payment Split. Suggestion: Use this filter to load the partner reconciliation result.", "required": false, "maxLength": 10, "type": "string" }, { "name": "subsellerid_ext", "in": "query", "description": "Partner code generated by Payment Split (alternative filter to 'subseller_id'). Has the same behavior and validation rules as the 'subseller_id' field. Must not be provided together with the 'subseller_id' field.", "required": false, "type": "string" }, { "name": "schedule_date_init", "in": "query", "description": "Schedule Date Start - when the processing method changes to use a schedule date range interval, the statement behavior changes. It searches for three different types of information:\r\n\r\n•\tAll schedules from all transactions performed in the requested period. Any transaction inserted in the requested period will have ALL its schedules\r\nlisted regardless of payment dates\r\n\r\n•\tAll schedules sensitized in the requested period. Schedules are sensitized by payment release, cancellation/chargeback or return of Nuclea files\r\nand payments made through Banco Santander such as PIX for example. This option is only present when the requested period corresponds to YESTERDAY.\r\nWe do not list sensitized schedules from other periods because the information is not persistent over time.\r\n\r\n•\tAll schedules with payment date scheduled for the requested period. In this case, all transactions involved are returned in record type 1,\r\nall scheduled transactions with the respective expected payment date and payment submission in Record Type 2, commission is returned in record type 3\r\nwith the respective expected payment date and payment submission, adjustments made through the system such as negative schedule reversal and entries made\r\nbetween the schedules of the Anchor's Own Store and the partner are returned in Record Type 4 where the expected settlement date and submission to settlement are also presented.\r\nChargebacks are returned in Record Type 5 with the original transaction data and expected settlement and submission to settlement and will also return record type\r\n7 which represents the settlement (Addition and subtraction) of all blocks that had the same Settlement reference number (reference_number).\r\nIn this block it is possible to identify where the payment was made and if it has any lien contract attached.\r\n\r\nThis filtering method will have the following behavior: If Subseller_ID is informed, the statement must list any date range it receives. Remembering that when informing\r\nthe SubSeller (which is optional for all statement listing forms), all results are filtered to values relative to it.\r\nWhen informing this filter, no other date period filter should be informed.", "required": false, "type": "string", "format": "date-time" }, { "name": "schedule_date_end", "in": "query", "description": "Schedule Date End - when the processing method changes to use a schedule date range interval, the statement behavior changes. It searches for three different types of information:\r\n\r\n•\tAll schedules from all transactions performed in the requested period. Any transaction inserted in the requested period will have ALL its schedules\r\nlisted regardless of payment dates\r\n\r\n•\tAll schedules sensitized in the requested period. Schedules are sensitized by payment release, cancellation/chargeback or return of Nuclea files\r\nand payments made through Banco Santander such as PIX for example. This option is only present when the requested period corresponds to YESTERDAY.\r\nWe do not list sensitized schedules from other periods because the information is not persistent over time.\r\n\r\n•\tAll schedules with payment date scheduled for the requested period. In this case, all transactions involved are returned in record type 1,\r\nall scheduled transactions with the respective expected payment date and payment submission in Record Type 2, commission is returned in record type 3\r\nwith the respective expected payment date and payment submission, adjustments made through the system such as negative schedule reversal and entries made\r\nbetween the schedules of the Anchor's Own Store and the partner are returned in Record Type 4 where the expected settlement date and submission to settlement are also presented.\r\nChargebacks are returned in Record Type 5 with the original transaction data and expected settlement and submission to settlement and will also return record type\r\n7 which represents the settlement (Addition and subtraction) of all blocks that had the same Settlement reference number (reference_number).\r\nIn this block it is possible to identify where the payment was made and if it has any lien contract attached.\r\n\r\nThis filtering method will have the following behavior: If Subseller_ID is informed, the statement must list any date range it receives. Remembering that when informing\r\nthe SubSeller (which is optional for all statement listing forms), all results are filtered to values relative to it.\r\nWhen informing this filter, no other date period filter should be informed.", "required": false, "type": "string", "format": "date-time" }, { "name": "transaction_date_init", "in": "query", "description": "Transaction capture date Start - If the statement receives a transaction date range interval, it will return all schedules related to transactions performed\r\nin this period. This case returns transactions from the requested period in record type 1, all payments and commissions originated from them in record types 2 and 3\r\nrespectively and returns no information in record types 4 and 5. In record type 7, payment submission and payment confirmation information will be returned\r\nincluding schedules not presented by the filter used. The recommended filter for reconciliation is 'schedule_date'. When informing this filter, no other date period filter\r\nshould be informed.", "required": false, "type": "string", "format": "date-time" }, { "name": "transaction_date_end", "in": "query", "description": "Transaction capture date End - If the statement receives a transaction date range interval, it will return all schedules related to transactions performed\r\nin this period. This case returns transactions from the requested period in record type 1, all payments and commissions originated from them in record types 2 and 3\r\nrespectively and returns no information in record types 4 and 5. In record type 7, payment submission and payment confirmation information will be returned\r\nincluding schedules not presented by the filter used. The recommended filter for reconciliation is 'schedule_date'. When informing this filter, no other date period filter\r\nshould be informed.", "required": false, "type": "string", "format": "date-time" }, { "name": "liquidation_date_init", "in": "query", "description": "Initial Settlement Date - Statement issued only with settlement data from the informed period that had their payments executed. \r\nIn this case, all compensated transactions that resulted in a value greater than 0 are returned in record type 1, as well as all payment schedules, \r\ncommissions, adjustments and chargebacks in record types 2, 3, 4 and 5. Record type 7 presents the sum of all blocks grouped by the settlement reference number \r\n(reference_number). In this block it is possible to identify where the payment was executed and if it has any lien contract attached. \r\nWhen informing this filter, no other date period filter should be informed.", "required": false, "type": "string", "format": "date-time" }, { "name": "liquidation_date_end", "in": "query", "description": "Final Settlement Date - Statement issued only with settlement data from the informed period that had their payments executed. \r\nIn this case, all compensated transactions that resulted in a value greater than 0 are returned in record type 1, as well as all payment schedules, \r\ncommissions, adjustments and chargebacks in record types 2, 3, 4 and 5. Record type 7 presents the sum of all blocks grouped by the settlement reference number \r\n(reference_number). In this block it is possible to identify where the payment was executed and if it has any lien contract attached. \r\nWhen informing this filter, no other date period filter should be informed.", "required": false, "type": "string", "format": "date-time" }, { "name": "confirmation_date_init", "in": "query", "description": "Transaction initial confirmation date - If the statement receives a date range of confirmed transactions, it will return all schedules related to \r\nthe transactions confirmed in this period. This case returns the transactions from the requested period in record type 1, all payments and commissions originated \r\nby them in record types 2 and 3 respectively, and returns no information in record types 4 and 5. In record type 7, payment sending and payment confirmation information \r\nwill be returned, including schedules not presented by the filter used. The recommended filter for reconciliation is 'schedule_date'. \r\nWhen informing this filter, no other date period filter should be informed.", "required": false, "type": "string", "format": "date-time" }, { "name": "confirmation_date_end", "in": "query", "description": "Transaction final confirmation date - If the statement receives a date range of confirmed transactions, it will return all schedules related to \r\nthe transactions confirmed in this period. This case returns the transactions from the requested period in record type 1, all payments and commissions originated \r\nby them in record types 2 and 3 respectively, and returns no information in record types 4 and 5. In record type 7, payment sending and payment confirmation information \r\nwill be returned, including schedules not presented by the filter used. The recommended filter for reconciliation is 'schedule_date'. \r\nWhen informing this filter, no other date period filter should be informed.", "required": false, "type": "string", "format": "date-time" }, { "name": "order_id", "in": "query", "description": "Order number - If an order number is passed, the statement will list all schedules related to ALL transactions involved in the requested order. \r\nThis case returns all transactions from the requested order (Sale / Cancellation) in record type 1, all payments and commissions originated by them in \r\nrecord types 2 and 3 respectively, chargebacks involved in the transactions in record type 5 with the original transaction data and compensation forecast \r\nand settlement submission, and will also return record type 7 which represents the compensation (Addition and subtraction) of all blocks that had the same settlement reference number \r\n(reference_number). In this block it is possible to identify where the payment was executed and if it has any lien contract attached, and returns no information in record type 4. \r\nWhen informing this filter, no other date period filter should be informed, nor the 'acquirer_transaction_id' filter.", "required": false, "type": "string" }, { "name": "acquirer_transaction_id", "in": "query", "description": "Transaction NSU. If the NSU of a transaction is passed, the statement will list all schedules related to the transaction in question, including commissions and \r\nrecord type 7 with payment information.\r\nWhen informing this filter, no other date period filter should be informed, nor the 'order_id' filter.", "required": false, "type": "string" }, { "name": "release_status", "in": "query", "description": "Payment release indicator:\r\n\r\nS - Payment released\r\n\r\nN - Payment not released\r\n\r\nThis filter returns all blocks that had schedules sensibilized for payment according to the period informed in the 'schedule_date' filter. \r\nTo use this filter, it is necessary to combine a date period.", "required": false, "type": "string" }, { "name": "blocks_codes", "in": "query", "description": "Codes of the blocks to be displayed in the query. Must be separated by commas. Ex.: \"TR,CO,AD\"\r\n\r\nTR - Transactions (Summary and Details)\r\n\r\nCO - Commissions\r\n\r\nAD - Adjustments\r\n\r\nCB - Chargebacks\r\n\r\nPS - Payment Summaries", "required": false, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ExtractResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/ExtractResponseStatus" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/ExtractResponseStatus" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found", "schema": { "type": "string" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ExtractResponseStatus" } } } } }, "/v3/mgm/statement/paginated": { "get": { "tags": [ "Statement V3" ], "summary": "Paginated Electronic Statement Request", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Content type.", "required": true, "type": "string", "enum": [ "application/json" ], "default": "application/json" }, { "name": "Authorization", "in": "header", "description": "Authorization: Bearer *AuthString*. Where *AuthString* is the access token obtained from the authentication endpoint.", "required": true, "type": "string", "enum": [ "Bearer AuthString" ], "default": "Bearer AuthString" }, { "name": "page", "in": "query", "description": "Active page of the search. This parameter indicates to the API which page should be returned. First call always starts with number 1.", "required": true, "type": "string" }, { "name": "rows_amount", "in": "query", "description": "Number of records that will be made available on each page. Records are counted by blocks, remembering that if I present a TR – Summary, \r\nfor details I will present all belonging to the summary and thus, this is not counted as records per page.", "type": "string" }, { "name": "seller_id", "in": "query", "description": "Access key of the Anchor (SellerId). In addition to this field being mandatory, some other filter will be necessary for combination", "required": true, "maxLength": 50, "type": "string" }, { "name": "subseller_id", "in": "query", "description": "Partner code generated by Payment Split. Suggestion: Use this filter to load the partner reconciliation results.", "required": false, "maxLength": 10, "type": "string" }, { "name": "subsellerid_ext", "in": "query", "description": "Partner code generated by Payment Split (alternative filter to 'subseller_id'). Has the same behavior and validation rules as the 'subseller_id' field. Must not be provided together with the 'subseller_id' field.", "required": false, "type": "string" }, { "name": "schedule_date_init", "in": "query", "description": "Schedule Date Start - when the treatment method becomes a schedule date range, the statement behavior changes. It searches for three different information:\r\n\r\n•\tAll schedules of all transactions performed in the requested period. Any transaction that was entered in the requested period will have ALL its schedules \r\nlisted regardless of payment dates\r\n\r\n•\tAll schedules sensibilized in the requested period. Schedules are sensibilized by payment release, cancellation/chargeback or return of Nuclea files \r\nand payments made through Santander bank such as PIX for example. This option is only present when the requested period corresponds to YESTERDAY. \r\nWe do not list sensibilized schedules from other periods because the information is not persistent over time.\r\n\r\n•\tAll schedules with payment date scheduled for the requested period. In this case, all involved transactions are returned in record type 1, \r\nall transactions scheduled with their respective payment forecast date and payment submission in record type 2, commission is returned in record type 3 \r\nwith the respective payment forecast date and payment submission, adjustments made via system such as negative schedule reversal and entries made \r\nbetween Anchor's Own Store schedules and the partner are returned in record type 4 where the forecast date for compensation and settlement submission is also presented. \r\nChargebacks are returned in record type 5 with the original transaction data and forecast for compensation and settlement submission, and will also return record type \r\n7 which represents the compensation (Addition and subtraction) of all blocks that had the same settlement reference number (reference_number). \r\nIn this block it is possible to identify where the payment was executed and if it has any lien contract attached.\r\n\r\nThis filtering method will have the following behavior: If Subseller_ID is informed, the statement should list any date range it receives. Remember that when informing \r\nthe SubSeller (which is optional for all statement listing methods), all results are filtered to values relative to the same.\r\nWhen informing this filter, no other date period filter should be informed.", "required": false, "type": "string", "format": "date-time" }, { "name": "schedule_date_end", "in": "query", "description": "Schedule Date End - when the treatment method becomes a schedule date range, the statement behavior changes. It searches for three different information:\r\n\r\n•\tAll schedules of all transactions performed in the requested period. Any transaction that was entered in the requested period will have ALL its schedules \r\nlisted regardless of payment dates\r\n\r\n•\tAll schedules sensibilized in the requested period. Schedules are sensibilized by payment release, cancellation/chargeback or return of Nuclea files \r\nand payments made through Santander bank such as PIX for example. This option is only present when the requested period corresponds to YESTERDAY. \r\nWe do not list sensibilized schedules from other periods because the information is not persistent over time.\r\n\r\n•\tAll schedules with payment date scheduled for the requested period. In this case, all involved transactions are returned in record type 1, \r\nall transactions scheduled with their respective payment forecast date and payment submission in record type 2, commission is returned in record type 3 \r\nwith the respective payment forecast date and payment submission, adjustments made via system such as negative schedule reversal and entries made \r\nbetween Anchor's Own Store schedules and the partner are returned in record type 4 where the forecast date for compensation and settlement submission is also presented. \r\nChargebacks are returned in record type 5 with the original transaction data and forecast for compensation and settlement submission, and will also return record type \r\n7 which represents the compensation (Addition and subtraction) of all blocks that had the same settlement reference number (reference_number). \r\nIn this block it is possible to identify where the payment was executed and if it has any lien contract attached.\r\n\r\nThis filtering method will have the following behavior: If Subseller_ID is informed, the statement should list any date range it receives. Remember that when informing \r\nthe SubSeller (which is optional for all statement listing methods), all results are filtered to values relative to the same.\r\nWhen informing this filter, no other date period filter should be informed.", "required": false, "type": "string", "format": "date-time" }, { "name": "transaction_date_init", "in": "query", "description": "Transaction capture date Start - If the statement receives a transaction date range it will return all schedules related to transactions performed \r\nin this period. This case returns the transactions from the requested period in record type 1, all payments and commissions originated by them in record types 2 and 3 \r\nrespectively, and returns no information in record types 4 and 5. In record type 7, payment sending and payment confirmation information will be returned \r\nincluding schedules not presented by the filter used. The recommended filter for reconciliation is 'schedule_date'. When informing this filter, no other date period filter \r\nshould be informed.", "required": false, "type": "string", "format": "date-time" }, { "name": "transaction_date_end", "in": "query", "description": "Transaction capture date End - If the statement receives a transaction date range it will return all schedules related to transactions performed \r\nin this period. This case returns the transactions from the requested period in record type 1, all payments and commissions originated by them in record types 2 and 3 \r\nrespectively, and returns no information in record types 4 and 5. In record type 7, payment sending and payment confirmation information will be returned \r\nincluding schedules not presented by the filter used. The recommended filter for reconciliation is 'schedule_date'. When informing this filter, no other date period filter \r\nshould be informed.", "required": false, "type": "string", "format": "date-time" }, { "name": "liquidation_date_init", "in": "query", "description": "Initial Settlement Date - Statement issued only with settlement data from the informed period that had their payments executed. \r\nIn this case, all compensated transactions that resulted in a value greater than 0 are returned in record type 1, as well as all payment schedules, \r\ncommissions, adjustments and chargebacks in record types 2, 3, 4 and 5. Record type 7 presents the sum of all blocks grouped by the settlement reference number \r\n(reference_number). In this block it is possible to identify where the payment was executed and if it has any lien contract attached. \r\nWhen informing this filter, no other date period filter should be informed.", "required": false, "type": "string", "format": "date-time" }, { "name": "liquidation_date_end", "in": "query", "description": "Final Settlement Date - Statement issued only with settlement data from the informed period that had their payments executed. \r\nIn this case, all compensated transactions that resulted in a value greater than 0 are returned in record type 1, as well as all payment schedules, \r\ncommissions, adjustments and chargebacks in record types 2, 3, 4 and 5. Record type 7 presents the sum of all blocks grouped by the settlement reference number \r\n(reference_number). In this block it is possible to identify where the payment was executed and if it has any lien contract attached. \r\nWhen informing this filter, no other date period filter should be informed.", "required": false, "type": "string", "format": "date-time" }, { "name": "confirmation_date_init", "in": "query", "description": "Transaction initial confirmation date - If the statement receives a date range of confirmed transactions, it will return all schedules related to \r\nthe transactions confirmed in this period. This case returns the transactions from the requested period in record type 1, all payments and commissions originated \r\nby them in record types 2 and 3 respectively, and returns no information in record types 4 and 5. In record type 7, payment sending and payment confirmation information \r\nwill be returned, including schedules not presented by the filter used. The recommended filter for reconciliation is 'schedule_date'. \r\nWhen informing this filter, no other date period filter should be informed.", "required": false, "type": "string", "format": "date-time" }, { "name": "confirmation_date_end", "in": "query", "description": "Transaction final confirmation date - If the statement receives a date range of confirmed transactions, it will return all schedules related to transactions confirmed in this period. This case returns the transactions from the requested period in record type 1, all payments and commissions originated by them in record types 2 and 3 respectively, and returns no information in record types 4 and 5. In record type 7, payment sending and payment confirmation information will be returned, including schedules not shown by the filter used. The recommended filter for reconciliation is 'schedule_date'. When informing this filter, no other date period filter should be informed.", "required": false, "type": "string", "format": "date-time" }, { "name": "order_id", "in": "query", "description": "Order number - If an order number is passed, the statement will list all schedules related to ALL transactions involved in the requested order. This case returns all transactions from the requested order (Sale / Cancellation) in record type 1, all payments and commissions originated by them in record types 2 and 3 respectively, chargebacks involved in transactions in record type 5 with the data from the original transaction and expected compensation and settlement sending, and record type 7 will also be returned representing the compensation (Sum and subtraction) of all blocks that had the same Settlement reference number (reference_number). In this block it is possible to identify where the payment was made and if it has any lien contract attached, and returns no information in record type 4. When informing this filter, no other date period filter should be informed, nor the 'acquirer_transaction_id' filter.", "required": false, "type": "string" }, { "name": "acquirer_transaction_id", "in": "query", "description": "Transaction NSU. If the NSU of a transaction is passed, the statement will list all schedules related to the transaction in question, including commissions and record type 7 with payment information. When informing this filter, no other date period filter should be informed, nor the 'order_id' filter.", "required": false, "type": "string" }, { "name": "release_status", "in": "query", "description": "Payment release indicator:\r\n\r\nS - Payment released\r\n\r\nN - Payment not released\r\n\r\nThis filter returns all blocks that had schedules sensitized for payment according to the period informed in the 'schedule_date' filter. To use this filter, it is necessary to combine a date period.", "required": false, "type": "string" }, { "name": "blocks_codes", "in": "query", "description": "Codes of the blocks to be displayed in the query. They must be informed separated by commas. Example: \"TR,CO,AD\"\r\n\r\nTR - Transactions (Summary and Details)\r\n\r\nCO - Commissions\r\n\r\nAD - Adjustments\r\n\r\nCB - Chargebacks\r\n\r\nPS - Payment Summaries", "required": false, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ExtractPaginatedResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/ExtractResponseStatus" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/ExtractResponseStatus" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found", "schema": { "type": "string" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ExtractResponseStatus" } } } } }, "/v4/mgm/statement": { "get": { "tags": [ "Statement V4" ], "summary": "Electronic Statement Request with pagination", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Content type.", "required": true, "type": "string", "enum": [ "application/json" ], "default": "application/json" }, { "name": "Authorization", "in": "header", "description": "Authorization: Bearer *AuthString*. Where *AuthString* is the access token obtained from the authentication endpoint.", "required": true, "type": "string", "enum": [ "Bearer AuthString" ], "default": "Bearer AuthString" }, { "name": "seller_id", "in": "query", "description": "Access key of the Anchor (SellerId). In addition to this field being mandatory, at least one other filter will be necessary for combination", "required": true, "schema": { "type": "string" } }, { "name": "subseller_id", "in": "query", "description": "Partner code generated by Payment Split. Suggestion: Use this filter to load the partner reconciliation result.", "schema": { "type": "string" } }, { "name": "subsellerid_ext", "in": "query", "description": "Partner code generated by Payment Split (alternative filter to 'subseller_id'). Has the same behavior and validation rules as the 'subseller_id' field. Must not be provided together with the 'subseller_id' field.", "schema": { "type": "string" } }, { "name": "schedule_date_init", "in": "query", "description": "Schedule Date Start - when the treatment form becomes a date range of scheduling, the statement behavior changes. It searches for three different pieces of information:\r\n\r\n• All schedules of all transactions performed in the requested period. Any transaction that was inserted in the requested period will have ALL of its schedules listed regardless of payment dates\r\n\r\n• All schedules sensitized in the requested period. Schedules are sensitized by payment release, cancellation/chargeback, or return of files from Nuclea and payments made through Santander bank such as PIX for example. This option is only present when the requested period corresponds to YESTERDAY. We do not list sensitized schedules from other periods because the information is not persistent over time.\r\n\r\n• All schedules with payment date scheduled for the requested period. In this case, all involved transactions are returned in record type 1, all transactions scheduled with the respective expected payment date and payment sending in Record type 2, commission is returned in record type 3 with the respective expected payment date and payment sending, adjustments made via system such as reversal of negative schedule and entries made between Anchor's Own Store and partner schedules are returned in Record type 4 where the expected compensation date and settlement sending are also presented. Chargebacks are returned in Record type 5 with the original transaction data and expected compensation and settlement sending. Schedule payment clearance can be identified in the \"payments\" field – this field represents the amount paid in a lien contract or in a free settlement, this field is only filled when a schedule item is compensated in the settlement with a balance greater than zero.\r\n\r\nIn this filtering form, it will have the following behavior: If \"Subseller_ID\" is informed, the statement should list any date range it receives. Remembering that when informing SubSeller (which is optional for all statement listing forms), all results are filtered to values relative to it.\r\n\r\nWhen informing this filter, no other date period filter should be informed.", "schema": { "type": "string", "format": "date-time" } }, { "name": "schedule_date_end", "in": "query", "description": "Schedule Date End - when the treatment form becomes a date range of scheduling, the statement behavior changes. It searches for three different pieces of information:\r\n\r\n• All schedules of all transactions performed in the requested period. Any transaction that was inserted in the requested period will have ALL of its schedules listed regardless of payment dates\r\n\r\n• All schedules sensitized in the requested period. Schedules are sensitized by payment release, cancellation/chargeback, or return of files from Nuclea and payments made through Santander bank such as PIX for example. This option is only present when the requested period corresponds to YESTERDAY. We do not list sensitized schedules from other periods because the information is not persistent over time.\r\n\r\n• All schedules with payment date scheduled for the requested period. In this case, all involved transactions are returned in record type 1, all transactions scheduled with the respective expected payment date and payment sending in Record type 2, commission is returned in record type 3 with the respective expected payment date and payment sending, adjustments made via system such as reversal of negative schedule and entries made between Anchor's Own Store and partner schedules are returned in Record type 4 where the expected compensation date and settlement sending are also presented. Chargebacks are returned in Record type 5 with the original transaction data and expected compensation and settlement sending. Schedule payment clearance can be identified in the \"payments\" field – this field represents the amount paid in a lien contract or in a free settlement, this field is only filled when a schedule item is compensated in the settlement with a balance greater than zero.\r\n\r\nIn this filtering form, it will have the following behavior: If \"Subseller_ID\" is informed, the statement should list any date range it receives. Remembering that when informing SubSeller (which is optional for all statement listing forms), all results are filtered to values relative to it.\r\n\r\nWhen informing this filter, no other date period filter should be informed.", "schema": { "type": "string", "format": "date-time" } }, { "name": "transaction_date_init", "in": "query", "description": "Transaction capture date Start - If the statement receives a date range of transactions, it will return all schedules related to transactions performed in this period. This case returns the transactions from the requested period in record type 1, all payments and commissions originated by them in record types 2 and 3 respectively, and returns no information in record types 4 and 5. Schedule payment clearance can be identified in the \"payments\" field – this field represents the amount paid in a lien contract or in a free settlement, this field is only filled when a schedule item (item / commission) is compensated in the settlement with a balance greater than zero.\r\nThe recommended filter for reconciliation is 'schedule_date'.\r\n\r\nWhen informing this filter, no other date period filter should be informed.", "schema": { "type": "string", "format": "date-time" } }, { "name": "transaction_date_end", "in": "query", "description": "Transaction capture date End - If the statement receives a date range of transactions, it will return all schedules related to transactions performed in this period. This case returns the transactions from the requested period in record type 1, all payments and commissions originated by them in record types 2 and 3 respectively, and returns no information in record types 4 and 5. Schedule payment clearance can be identified in the \"payments\" field – this field represents the amount paid in a lien contract or in a free settlement, this field is only filled when a schedule item (item / commission) is compensated in the settlement with a balance greater than zero.\r\nThe recommended filter for reconciliation is 'schedule_date'.\r\n\r\nWhen informing this filter, no other date period filter should be informed.", "schema": { "type": "string", "format": "date-time" } }, { "name": "liquidation_date_init", "in": "query", "description": "Settlement Date Start - Statement issuance only with settlement data from the informed period that had their payments made (field \"subseller_rate_confirm_date\" in \"payments\" filled). In this case, all compensated transactions that resulted in a value greater than 0 are returned in record type 1, as well as all payment schedules, commission, adjustments, and chargebacks in record types 2, 3, 4, and 5. Schedule payment clearance will be identified in the \"payments\" field – this field represents the amount paid in a lien contract or in a free settlement, this field is only filled when a schedule item (item / commission / adjustment / entry / chargeback) is compensated in the settlement with a balance greater than zero.\r\n\r\nWhen informing this filter, no other date period filter should be informed.", "schema": { "type": "string", "format": "date-time" } }, { "name": "liquidation_date_end", "in": "query", "description": "Settlement Date End - Statement issuance only with settlement data from the informed period that had their payments made (field \"subseller_rate_confirm_date\" in \"payments\" filled). In this case, all compensated transactions that resulted in a value greater than 0 are returned in record type 1, as well as all payment schedules, commission, adjustments, and chargebacks in record types 2, 3, 4, and 5. Schedule payment clearance will be identified in the \"payments\" field – this field represents the amount paid in a lien contract or in a free settlement, this field is only filled when a schedule item (item / commission / adjustment / entry / chargeback) is compensated in the settlement with a balance greater than zero.\r\n\r\nWhen informing this filter, no other date period filter should be informed.", "schema": { "type": "string", "format": "date-time" } }, { "name": "confirmation_date_init", "in": "query", "description": "Confirmation date Start - If the statement receives a date range of confirmed transactions, it will return all schedules related to transactions confirmed in this period. This case returns the transactions from the requested period in record type 1, all payments and commissions originated by them in record types 2 and 3 respectively, and returns no information in record types 4 and 5. Schedule payment clearance can be identified in the \"payments\" field – this field represents the amount paid in a lien contract or in a free settlement, this field is only filled when a schedule item (item / commission) is compensated in the settlement with a balance greater than zero.\r\nThe recommended filter for reconciliation is 'schedule_date'.\r\n\r\nWhen informing this filter, no other date period filter should be informed.", "schema": { "type": "string", "format": "date-time" } }, { "name": "confirmation_date_end", "in": "query", "description": "Confirmation date End - If the statement receives a date range of confirmed transactions, it will return all schedules related to transactions confirmed in this period. This case returns the transactions from the requested period in record type 1, all payments and commissions originated by them in record types 2 and 3 respectively, and returns no information in record types 4 and 5. Schedule payment clearance can be identified in the \"payments\" field – this field represents the amount paid in a lien contract or in a free settlement, this field is only filled when a schedule item (item / commission) is compensated in the settlement with a balance greater than zero.\r\n\r\nWhen informing this filter, no other date period filter should be informed.", "schema": { "type": "string", "format": "date-time" } }, { "name": "order_id", "in": "query", "description": "Order number - If an order number is passed, the statement will list all schedules related to ALL transactions involved in the requested order. This case returns all transactions from the requested order (Sale / Cancellation) in record type 1, all payments and commissions originated by them in record types 2 and 3 respectively, chargebacks involved in transactions in record type 5 with the data from the original transaction and expected compensation and settlement sending, and returns no information in record type 4. Schedule payment clearance can be identified in the \"payments\" field – this field represents the amount paid in a lien contract or in a free settlement, this field is only filled when a schedule item (item / commission / chargeback) is compensated in the settlement with a balance greater than zero.\r\n\r\nWhen informing this filter, no other date period filter should be informed, nor the 'acquirer_transaction_id' filter.", "schema": { "type": "string" } }, { "name": "acquirer_transaction_id", "in": "query", "description": "NSU of the transaction - If the NSU of a transaction is provided, the statement will list all schedules related to the transaction in question, including commissions. The cancellation of schedules can be identified in the \"payments\" field – this field represents the amount paid in a lien contract or in a free settlement, this field is only filled when a schedule (item / commission) is cleared in the settlement with a balance greater than zero.\r\n\r\nWhen providing this filter, no other date period filter should be informed, nor should the 'order_id' filter.", "schema": { "type": "string" } }, { "name": "release_status", "in": "query", "description": "Payment release indicator:\r\n\r\nS - Payment released\r\n\r\nN - Payment not released\r\n\r\nThis filter returns all blocks that had schedules sensitized for payment according to the period specified in the 'schedule_date' filter. To use this filter, it is necessary to combine a date period.", "schema": { "type": "string" } }, { "name": "blocks_codes", "in": "query", "description": "Codes of the blocks to be displayed in the query. They must be informed separated by commas. Ex.: \"TR,CO,AD\"\r\n\r\nTR - Transactions (Summary and Details)\r\n\r\nCO - Commissions\r\n\r\nAD - Adjustments\r\n\r\nCB - Chargebacks", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Active page of the search. This parameter indicates to the API which page should be returned. First call always starts with the number 1.", "required": true, "schema": { "type": "string" } }, { "name": "rows_amount", "in": "query", "description": "Number of records that will be available on each page. Records are counted by blocks, remembering that if I display a TR – Summary, for details I will display all belonging to the summary and thus, this is not counted as records per page.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ExtractResponseV4" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/ExtractStatusV4" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/ExtractStatusV4" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found", "schema": { "type": "string" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/ExtractStatusV4" } } } } }, "/v1/mgm/rejected-payments": { "get": { "tags": [ "Rejected Payments" ], "summary": "Search for rejected payments", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Content type.", "required": true, "type": "string", "enum": [ "application/json" ], "default": "application/json" }, { "name": "Authorization", "in": "header", "description": "Authorization: Bearer *AuthString*. Where *AuthString* is the access token obtained from the authentication endpoint.", "required": true, "type": "string", "enum": [ "Bearer AuthString" ], "default": "Bearer AuthString" }, { "name": "MerchantId", "in": "query", "description": "NumEC of the anchor.", "required": true, "type": "integer", "format": "string" }, { "name": "Subsellerid", "in": "query", "description": "Subseller code.", "maxLength": 50, "type": "integer", "format": "int32" }, { "name": "SubsellerIdExt", "in": "query", "description": "External subseller code (VTEX).", "type": "string" }, { "name": "Status", "in": "query", "description": "Payment status. Accepted values: rejected.", "required": true, "type": "string" }, { "name": "Date", "in": "query", "description": "Date period filter function: between(yyyy-mm-dd, yyyy-mm-dd). For this parameter, dates must respect the 90-day interval.", "required": true, "type": "string" }, { "name": "ExportType", "in": "query", "description": "Export type. Accepted value: payments.", "type": "string" } ], "responses": { "200": { "description": "Payment List", "schema": { "type": "array", "items": { "$ref": "#/definitions/PaymentReturn" } } }, "204": { "description": "Empty list" }, "400": { "description": "Invalid parameters" }, "500": { "description": "Internal service error", "schema": { "$ref": "#/definitions/GetPaymentsErrorResponse" } } } } }, "/v1/mgm/show-ur/cancel-permission": { "get": { "tags": [ "show-ur" ], "summary": "Query if Item can be canceled", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Content type.", "required": true, "type": "string", "enum": [ "application/json" ], "default": "application/json" }, { "name": "Authorization", "in": "header", "description": "Authorization: Bearer *AuthString*. Where *AuthString* is the access token obtained from the authentication endpoint.", "required": true, "type": "string", "enum": [ "Bearer AuthString" ], "default": "Bearer AuthString" }, { "name": "SellerId", "in": "query", "description": "Access key of the Anchor (SellerId). Must be a valid UUID.", "required": true, "type": "string" }, { "name": "SubSellerId", "in": "query", "description": "Partner code generated by Payment Split.", "required": true, "type": "integer", "format": "int64", "minimum": 1 }, { "name": "OrderId", "in": "query", "description": "Order number generated by the anchor", "required": true, "type": "string", "maxLength": 255 }, { "name": "OrderItemId", "in": "query", "description": "Product code received in the order generated by the Anchor", "required": true, "type": "string", "maxLength": 25 }, { "name": "Amount", "in": "query", "description": "Amount to query if it can be canceled, in cents. Example: 150 equals R$ 1.50", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ResponseCancelPermission" } }, "204": { "description": "No Content" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "422": { "description": "Client Error", "schema": { "type": "array", "items": { "type": "string" } } } } } }, "/v1/mgm/show-ur/summary": { "get": { "tags": [ "show-ur" ], "summary": "Gets URs summarized by card flag and Date", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Content type.", "required": true, "type": "string", "enum": [ "application/json" ], "default": "application/json" }, { "name": "Authorization", "in": "header", "description": "Authorization: Bearer *AuthString*. Where *AuthString* is the access token obtained from the authentication endpoint.", "required": true, "type": "string", "enum": [ "Bearer AuthString" ], "default": "Bearer AuthString" }, { "name": "SellerId", "in": "query", "description": "Access key of the Anchor (SellerId). Must be a valid UUID.", "required": true, "type": "string" }, { "name": "SubSellerId", "in": "query", "description": "Partner code generated by Payment Split.", "required": true, "type": "string" }, { "name": "StartDate", "in": "query", "description": "Start Date in format yyyy-MM-dd", "required": true, "type": "string" }, { "name": "EndDate", "in": "query", "description": "End Date in format yyyy-MM-dd", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ResponseSummary" } }, "204": { "description": "No Content" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "422": { "description": "Client Error", "schema": { "type": "array", "items": { "type": "string" } } } } } }, "/v1/mgm/adjustment/request-adjustments": { "post": { "tags": [ "Adjustments" ], "summary": "Accounting entry request", "operationId": "V1AdjustmentsRequestAdjustmentsPost", "consumes": [ "application/json" ], "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "Content-Type", "in": "header", "description": "Content type.", "required": true, "type": "string", "enum": [ "application/json" ], "default": "application/json" }, { "name": "Authorization", "in": "header", "description": "Authorization: Bearer *AuthString*. Where *AuthString* is the access token obtained from the authentication endpoint.", "required": true, "type": "string", "enum": [ "Bearer AuthString" ], "default": "Bearer AuthString" }, { "name": "param_request_adjustments", "in": "body", "description": "Entry parameters", "required": false, "schema": { "$ref": "#/definitions/ParamRequestAdjustments" } } ], "responses": { "200": { "description": "Request completed successfully.", "schema": { "$ref": "#/definitions/ReturnRequestAdjustments" } }, "400": { "description": "Invalid request.", "schema": { "$ref": "#/definitions/ReturnError" } }, "401": { "description": "Invalid authentication.", "schema": { "type": "string" } }, "404": { "description": "Not found." }, "500": { "description": "Internal server or service error.", "schema": { "$ref": "#/definitions/ReturnError" } } } } }, "/v1/mgm/adjustment/get-adjustments-entries": { "get": { "tags": [ "Adjustments" ], "summary": "Endpoint for querying launch status", "operationId": "V1AdjustmentsGet-adjustments-entriesGet", "consumes": [], "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "Content-Type", "in": "header", "description": "Content type.", "required": true, "type": "string", "enum": [ "application/json" ], "default": "application/json" }, { "name": "Authorization", "in": "header", "description": "Authorization: Bearer *AuthString*. Where *AuthString* is the access token obtained from the authentication endpoint.", "required": true, "type": "string", "enum": [ "Bearer AuthString" ], "default": "Bearer AuthString" }, { "name": "seller_id", "in": "query", "description": "MarketPlace ID (SellerId) is mandatory if the \"merchant_id\" field is not informed.", "required": false, "type": "string", "maxLength": 50 }, { "name": "merchant_id", "in": "query", "description": "EC number is mandatory if the \"seller_id\" field is not informed.", "required": false, "type": "string" }, { "name": "subseller_id", "in": "query", "description": "Subseller ID", "required": false, "type": "string", "maxLength": 10 }, { "name": "adjustment_entry_id", "in": "query", "description": "Entry ID", "required": false, "type": "integer", "format": "int32" }, { "name": "adjustment_entry_date_start", "in": "query", "description": "Start date of the research period for entries made. Maximum research period, if subseller_id is informed, is 30 days.\r\nIf subseller_id is not informed in the search, the maximum period will be 2 days.", "required": true, "type": "string" }, { "name": "adjustment_entry_date_end", "in": "query", "description": "End date of the research period for entries made. Maximum research period, if subseller_id is informed, is 30 days.\r\nIf subseller_id is not informed in the search, the maximum period will be 2 days.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ReturnGetAdjustmentEntries" } }, "400": { "description": "Invalid request. Observed scenarios:
Missing \"adjustment_entry_date_start\": {\"success\":false,\"status_code\":\"9002\",\"message\":\"Campo 'adjustment_entry_date_start' é obrigatório.\"}
Search period between \"adjustment_entry_date_start\" and \"adjustment_entry_date_end\" above the maximum of 2 days: {\"success\":false,\"status_code\":\"9008\",\"message\":\"Período máximo de pesquisa entre 'adjustment_entry_date_start' e 'adjustment_entry_date_end' é de 2 dias.\"}", "schema": { "$ref": "#/definitions/AdjustmentStatus" } }, "401": { "description": "Unauthorized", "schema": { "type": "string" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found", "schema": { "type": "string" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/AdjustmentStatus" } } } } }, "/v1/mgm/balances/balance/summary": { "get": { "tags": [ "Balance" ], "summary": "Performs a search of balances by Seller and optionally their Subseller", "operationId": "GetBalanceSummary", "consumes": [], "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "Content-Type", "in": "header", "description": "Content type.", "required": true, "type": "string", "enum": [ "application/json" ], "default": "application/json" }, { "name": "Authorization", "in": "header", "description": "Authorization: Bearer *AuthString*. Where *AuthString* is the access token obtained from the authentication endpoint.", "required": true, "type": "string", "enum": [ "Bearer AuthString" ], "default": "Bearer AuthString" }, { "name": "seller_id", "in": "query", "description": "Access key of the Anchor (SellerId).", "required": true, "type": "string", "maxLength": 50 }, { "name": "subseller_id", "in": "query", "description": "Partner code generated by Payment Split. Mandatory if the query period is longer than two days.", "required": false, "type": "integer", "format": "int32" }, { "name": "balance_start_date", "in": "query", "description": "Must fill in the start date to perform the search. Format yyyy-mm-dd.", "required": true, "type": "string", "format": "date" }, { "name": "balance_end_date", "in": "query", "description": "Must fill in the end date to perform the search. Format yyyy-mm-dd.", "required": true, "type": "string", "format": "date" }, { "name": "blocks_codes", "in": "query", "description": "Codes of the blocks to be displayed in the query. Must be informed separated by commas. Ex.: \"E,C,F\", where:
E = Expired
C = Current
F = Future", "required": false, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ResponseBalanceViewModel" } }, "400": { "description": "Bad Request. Returned when a required parameter is missing, a parameter value is invalid, or a business rule is violated. Observed scenarios:
Missing required parameter (\"seller_id\", \"balance_start_date\", or \"balance_end_date\"): {\"<field>\":[\"Campo '<field>' é obrigatório.\"]}
Invalid \"blocks_codes\" value: {\"blocks_codes\":[\"Os seguintes códigos de blocos informados são inválidos.: <value> - Códigos permitidos: E, C ou F (letras maiúsculas e separados por vírgula)\"]}
Search period longer than 2 days without \"subseller_id\": {\"status_code\":\"Período Incorreto\",\"message\":\"Período máximo de pesquisa entre Data Inicial e Data final é de 2 dias\"}
Search period longer than 30 days (with \"subseller_id\"): {\"status_code\":\"Período Incorreto\",\"message\":\"Período máximo de pesquisa entre Data Inicial e Data final é de 30 dias\"}
Future-balance query more than 18 months from \"balance_start_date\": {\"status_code\":\"Período Incorreto\",\"message\":\"A data limite para consulta de saldo Futuro é de 18 meses a partir da Data Inicial\"}
\"subseller_id\" not associated with the informed \"seller_id\": {\"status_code\":\"9105\",\"message\":\"SubSeller_id não associada ao Marketplace informado.\"}
\"seller_id\" not found: {\"status_code\":\"9103\",\"message\":\"Seller_id informado, inexiste na base.\"}
\"subseller_id\" not found: {\"status_code\":\"9104\",\"message\":\"SubSeller_id informado, inexiste na base.\"}", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/ResponseStatusViewModel" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found", "schema": { "type": "string" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ResponseStatusViewModel" } } } } }, "/credenciamento/auth/oauth/v2/token": { "post": { "summary": "Access token generation", "description": "Endpoint responsible for generating the access token used in other requests, for this we use [HTTP Basic Authentication](https://www.w3.org/Protocols/HTTP/1.0/draft-ietf-http-spec.html#BasicAA)", "tags": [ "Authentication" ], "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "parameters": [ { "in": "header", "name": "Content-type", "required": true, "type": "string", "enum": [ "application/x-www-form-urlencoded" ], "default": "application/x-www-form-urlencoded", "description": "Default content type application/x-www-form-urlencoded.\n" }, { "in": "header", "name": "Authorization", "required": true, "type": "string", "description": "Authorization: Basic *AuthString*
Where *AuthString* is the concatenation of your Client ID, followed by \":\" (colon) plus your Client Secret, converted to base64.
As an example: For Client ID equal to client-01 and Client Secret equal to secret-key-02, we will have the text client-01:secret-key-02 after concatenation, converting to base64 we will have the result 2xpZW50LTAxOnNlY3JldC1rZXktMDI=.
In this case the Authorization in the request header will be:
Authorization: Basic Y2xpZW50LTAxOnNlY3JldC1rZXktMDI=\n" }, { "in": "formData", "required": true, "type": "string", "name": "scope", "description": "Use the fixed value \"mgm\"", "default": "mgm" }, { "in": "formData", "required": true, "type": "string", "name": "grant_type", "description": "Use the fixed value \"client_credentials\"", "default": "client_credentials" } ], "responses": { "200": { "description": "Returns the access token.", "schema": { "type": "object", "properties": { "access_token": { "type": "string", "description": "API access token for submission in all requests", "example": "ca22a2ge-1914-4b0c-a0fb-d3ce0fde7346", "format": "uuidv4", "minLength": 36, "maxLength": 36 }, "token_type": { "type": "string", "description": "Token type, must be sent in the header along with the token (https://tools.ietf.org/html/rfc6750)", "example": "Bearer" }, "expires_in": { "type": "number", "description": "Token expiration time in seconds", "example": 3600 }, "scope": { "type": "string", "description": "Token scope", "example": "mgm" } } } }, "400": { "description": "Invalid request.", "schema": { "$ref": "#/definitions/error_authentication" } }, "401": { "description": "Not authorized.", "schema": { "$ref": "#/definitions/error_authentication" } } }, "x-code-samples": [ { "lang": "cURL", "source": "curl -X POST \\\nhttps://api-homologacao.getnet.com.br/credenciamento/auth/oauth/v2/token \\\n-H 'authorization: Basic 2xpZW50LTAxOnNlY3JldC1rZXktMDI=' \\\n-H 'content-type: application/x-www-form-urlencoded' \\\n-d 'scope=mgm&grant_type=client_credentials'\n" } ] } } }, "definitions": { "error_authentication": { "type": "object", "properties": { "error": { "type": "string", "description": "Error message." }, "error_description": { "type": "string", "description": "Error description." } } }, "BankAccountFacade": { "description": "Single Bank Domicile. \r\n

The bank domicile informed will be used for all available payment brands.

Rules: \r\nSend only if type_accounts = \"unique\".

", "required": [ "bank", "agency", "account", "account_type", "account_digit" ], "type": "object", "properties": { "account_type": { "description": "Account type. \r\n

Rules: \r\nMust inform the value according to valid values;\r\n\"C\" for checking account; \"P\" for savings account.

", "enum": [ "C", "P" ], "type": "string" }, "bank": { "format": "int32", "description": "Bank code where sales proceeds will be deposited. \r\n

Rules: \r\nMust contain at least 1 and at most 3 numeric digits;\r\nInform according to the list of domains available at: \"domains/banks\"

", "type": "integer" }, "agency": { "format": "int32", "description": "\r\n
Number of the bank agency where sales proceeds will be deposited.
\r\n

\r\n Rules: \r\n For checking (C) or savings (P) accounts, the completion must follow the following model:

\r\n

Must contain at least 1 and at most 4 numeric digits.
Must be greater than 0 (zero);

", "type": "integer" }, "account": { "format": "int64", "description": "Account number where sales proceeds will be deposited.\r\n

Rules: Must contain only numeric digits; For accounts with domicile at Caixa Econômica Federal, the completion must follow the following model:

It is 3 digits for the account type, 8 digits for the account, the account types are as follows:\r\n
- 001 – Checking Account for Individual;
- 003 – Checking Account for Business;
- 013 – Savings Account for Individual;
- 022 – Savings Account for Business.

Example: in the account field, it will be necessary to enter the account type (without leading zeros) and the account number: 100000123.

", "type": "integer" }, "account_digit": { "description": "Account Digit number where sales proceeds will be deposited. \r\n

Rules: \r\nMust contain 1 numeric digit; \r\nIf the account digit is X, replace with 0.

", "type": "string" } } }, "BasicAddressFacade": { "description": "Address. \r\n

If informed: \r\nMust be informed following the internal rules of the address object.

", "required": [ "street", "district", "city", "state", "postal_code" ], "type": "object", "properties": { "street": { "description": "Street address. \r\n

Rules:

Cannot be empty or null;
We recommend sending this information without special characters;
Should contain the type of street and name of the street (Example: AVENIDA BORGES DE MEDEIROS).

", "type": "string" }, "number": { "format": "int32", "description": "Street number. \r\n

Rules:

If informed, must contain only numeric digits;
For address without number, inform null or 0 (zero);
If the informed value is null, the system will understand that it is an address without a number and will use 0 (zero) as the default value.

", "type": "integer" }, "district": { "description": "Neighborhood name. \r\n

Rules: \r\nCannot be empty or null; \r\nShould not contain special characters (Incorrect example: SANTO ANDRÉ, Correct example: SANTO ANDRE).

", "type": "string" }, "city": { "description": "City name. \r\n

Rules: \r\nCannot be empty or null; \r\nShould not contain special characters (Incorrect example: SANTO ANDRÉ, Correct example: SANTO ANDRE).

", "type": "string" }, "state": { "description": "State code. \r\n

Rules:

List of accepted states: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

", "type": "string" }, "postal_code": { "format": "int32", "description": "ZIP code. \r\n

Rules:

Must contain only numeric digits;
Must contain at most 8 digits;
Must be valid in the postal code registry.

", "type": "integer" }, "suite": { "description": "Complement/Reference point. \r\n

Rules:

We recommend sending this information without special accent characters;
We do not recommend sending this information containing only numbers (Incorrect example: 406, Correct examples: APT 406, HOUSE 123).

", "type": "string", "maxLength": 20 } } }, "BasicAddressUpdateFacade": { "description": "Address. \r\n

If informed:

Must follow the internal rules of the address object.

Mandatory for Anticipation - Mandatory field for receivable anticipation.

", "required": [ "street", "district", "city", "state", "postal_code" ], "type": "object", "properties": { "street": { "description": "Street address. \r\n

Rules: \r\nCannot be empty or null; \r\nShould not contain special characters; \r\nShould contain the type of street and name of the street (Example: AVENIDA BORGES DE MEDEIROS).

", "type": "string" }, "number": { "format": "int32", "description": "Street number. \r\n

Rules:

If informed, must contain only numeric digits;
For address without number, inform null or 0 (zero);
If the informed value is null, the system will understand that it is an address without a number and will use 0 (zero) as the default value.

", "type": "integer" }, "district": { "description": "Neighborhood name. \r\n

Rules: \r\nCannot be empty or null; \r\nShould not contain special characters (Incorrect example: SANTO ANDRÉ, Correct example: SANTO ANDRE).

", "type": "string" }, "city": { "description": "City name. \r\n

Rules: \r\nCannot be empty or null; \r\nShould not contain special characters (Incorrect example: SANTO ANDRÉ, Correct example: SANTO ANDRE).

", "type": "string" }, "state": { "description": "State code. \r\n

Rules: \r\nList of accepted states: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

", "type": "string" }, "postal_code": { "format": "int32", "description": "ZIP code. \r\n

Rules:

Must contain only numeric digits;
Must contain at most 8 digits;
Must be valid in the postal code registry.

", "type": "integer" }, "suite": { "description": "Complement/Reference point\r\n

Rules:

We recommend sending this information without special accent characters;
We do not recommend sending this information containing only numbers (Incorrect example: 406, Correct examples: APT 406, HOUSE 123).

", "type": "string", "maxLength": 20 } } }, "CellPhoneFacade": { "description": "Mobile phone. \r\n

Rules: \r\nThis field is mandatory if \"phone\" is not informed. If \"phone\" is informed, this field is optional.

", "required": [ "area_code", "phone_number" ], "type": "object", "properties": { "area_code": { "format": "int32", "description": "Mobile phone area code. \r\n

Rules: \r\nMust be registered in the ANATEL list: 11, 12, 13, 14, 15, 16, 17, 18, 19, 21, 22, 24, 27, 28, 31, 32, 33, 34, 35, 37, 38, 41, 42, 43, 44, 45, 46, 47, 48, 49, 51, 53, 54, 55, 61, 62, 63, 64, 65, 66, 69, 67, 68, 71, 73, 74, 75, 77, 79, 81, 87, 82, 83, 84, 85, 88, 86, 89, 91, 93, 94, 92, 97, 95, 96, 98, 99.

", "type": "integer" }, "phone_number": { "format": "int32", "description": "Mobile phone number. \r\n

Rules: \r\nMust have 9 digits; \r\nMust follow ANATEL rules for mobile numbers; \r\nFor the following area codes, the first digit must be = 9: \r\n11, 12, 13, 14, 15, 16, 17, 18, 19, 21, 22, 24, 27, 28, 31, 32, 33, 34, 35, 37, 38, 41, 42, 43, 44, 45, 68, 71, 73, 74, 75, 77, 79, 81, 87, 82, 83, 84, 85, 88, 86, 89, 91, 93, 94, 92, 97, 95, 96, 98, 99; \r\nFor the following area codes, the first digit must be = 9 and the second can be: 9 or 8 or 7 and total digits = 9: \r\n41, 46, 47, 48, 49, 51, 53, 54, 55, 61, 62, 64, 65, 66, 67, 69, 68\"

", "type": "integer" } } }, "CellPhoneUpdateFacade": { "description": "Mobile phone. \r\n

If informed:

Must follow the internal rules of the object.
If a mobile phone is already registered, it will be updated.
If it does not exist, a mobile phone will be registered.

Mandatory for Anticipation - Mandatory field for receivable anticipation.

", "required": [ "area_code", "phone_number" ], "type": "object", "properties": { "area_code": { "format": "int32", "description": "Mobile phone area code. \r\n

", "type": "integer" }, "phone_number": { "format": "int32", "description": "Mobile phone number. \r\n

", "type": "integer" } } }, "CommissionFacade": { "description": "Rate/Commission by Brand and Sales Plan.", "required": [ "brand", "product", "payment_plan" ], "type": "object", "properties": { "brand": { "description": "Brand. \r\n

Rules: \r\nMust inform the value according to valid values.

", "enum": [ "MASTERCARD", "MAESTRO", "VISA", "VISA ELECTRON", "AMEX", "ELO CRÉDITO", "ELO DÉBITO", "HIPERCARD", "BOLETO" ], "type": "string" }, "product": { "description": "Sales plan. \r\n

Rules: \r\nMust inform the value according to valid values.

", "enum": [ "DEBITO A VISTA", "CREDITO A VISTA", "PARCELADO LOJISTA 3X", "PARCELADO LOJISTA 6X", "PARCELADO LOJISTA 9X", "PARCELADO LOJISTA 12X", "PARCELADO EMISSOR", "BOLETO" ], "type": "string" }, "payment_plan": { "format": "int32", "description": "Payment plan. \r\n

Rules: \r\nMust contain only numeric digits; \r\nInform according to the list available at: `domains/paymentplans/{merchant_id}`

", "type": "integer" }, "commission_percentage": { "format": "double", "description": "Percentage rate/commission value (%). \r\n

Rules: \r\nThis field is mandatory if \"commission_value\" is not informed;\r\nIf \"commission_value\" is greater than zero, \"commission_percentage\" must be \"null\" or zero;\r\nMust contain only numeric digits and a decimal separator (.); \r\nMust contain two decimal places; \r\nValue must be between 0.00 and 100.00 .

", "type": "number" }, "commission_value": { "format": "double", "description": "Fixed rate/commission value. \r\n

Rules: \r\nThis field is mandatory if \"commission_percentage\" is not informed;\r\nIf \"commission_percentage\" is greater than zero, \"commission_value\" must be \"null\" or zero;\r\nMust contain only numeric digits and a decimal separator (.); \r\nMust contain two decimal places; \r\nValue must be greater than or equal to 0.00.

", "type": "number" } } }, "CommissionSubSeller": { "description": "MDR by Brand and Sales Plan.", "type": "object", "properties": { "brand_id": { "description": "Brand.", "type": "string" }, "product_id": { "description": "Sales plan.", "type": "string" }, "percent": { "format": "double", "description": "Percentage rate value (%).", "type": "number" }, "value": { "format": "double", "description": "Fixed rate value.", "type": "number" }, "payment_plan": { "format": "int32", "description": "Payment plan.", "type": "integer" } } }, "CompleteAddressFacade": { "description": "Commercial address. \r\n

If informed: \r\nMust be informed following the internal rules of the complete address object.

", "required": [ "mailing_address_equals", "street", "district", "city", "state", "postal_code" ], "type": "object", "properties": { "mailing_address_equals": { "description": "Mailing address. \r\n

Rules:

If this field is filled with the value \"S\", the informed address will be copied to the mailing address and it is not necessary to inform the value of the \"mailing_address\" field.

If this field is filled with the value \"N\", the informed address will not be copied to the mailing address and it is mandatory to inform the value of the \"mailing_address\" field

", "enum": [ "S", "N" ], "type": "string" }, "street": { "description": "Street address. \r\n

Rules: \r\nCannot be empty or null; \r\nShould not contain special characters; \r\nShould contain the type of street and name of the street (Example: AVENIDA BORGES DE MEDEIROS).

", "type": "string" }, "number": { "format": "int32", "description": "Street number. \r\n

Rules:

If informed, must contain only numeric digits;
For address without number, inform null or 0 (zero);
If the informed value is null, the system will understand that it is an address without a number and will use 0 (zero) as the default value.

", "type": "integer" }, "district": { "description": "Neighborhood name. \r\n

Rules:

Cannot be empty or null;
We recommend sending this information without special characters (Incorrect example: SANTO ANDRÉ, Correct example: SANTO ANDRE).

", "type": "string" }, "city": { "description": "City name. \r\n

Rules:

Cannot be empty or null;
We recommend sending this information without special characters (Incorrect example: SANTO ANDRÉ, Correct example: SANTO ANDRE).

", "type": "string" }, "state": { "description": "State code. \r\n

Rules: \r\nList of accepted states: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

", "type": "string" }, "postal_code": { "format": "int32", "description": "ZIP code. \r\n

Rules: \r\nMust contain only numeric digits; \r\nMust contain at most 8 digits; \r\nMust be valid in the postal code registry.

", "type": "integer" }, "suite": { "description": "Complement/Reference point. \r\n

Rules: \r\nShould not contain special accent characters; \r\nCannot be informed with only numbers (Incorrect example: 406, Correct examples: APT 406, HOUSE 123).

", "type": "string", "maxLength": 20 } } }, "CustomBankAccountFacade": { "description": "Bank Domicile by Brand.", "type": "object", "properties": { "brand": { "description": "Required\r\n
Brand whose sales will be deposited in the informed account.
\r\n

\r\n Rules:\r\n

\r\n

Must inform the value according to valid values.

", "enum": [ "MASTERCARD", "MAESTRO", "VISA", "VISA ELECTRON", "AMEX", "ELO CRÉDITO", "ELO DÉBITO", "HIPERCARD", "BOLETO" ], "type": "string" }, "account_type": { "description": "Required\r\n
Account type
\r\n

\r\n Rules: \r\n Must inform the value according to valid values:

\r\n

\r\n P: for Savings Account.

", "enum": [ "C", "P" ], "type": "string" }, "bank": { "format": "int32", "description": "Required\r\n
Bank code where sales proceeds will be deposited.
\r\n

\r\n Rules:\r\n

\r\n

Must contain at least 1 and at most 3 numeric digits;
Inform according to the list of domains available at: `domains/banks`.

", "type": "integer" }, "agency": { "format": "int32", "description": "Required\r\n
Number of the bank agency where sales proceeds will be deposited.
\r\n

\r\n Rules: \r\n For checking (C) or savings (P) accounts, the completion must follow the following model:

\r\n

Must contain at least 1 and at most 4 numeric digits.
Must be greater than 0 (zero);

\r\n", "type": "integer" }, "account": { "format": "double", "description": "Required\r\n
Account number where sales proceeds will be deposited.
\r\n

\r\n Rules: \r\n For Checking (C) or Savings (P) account types, the filling must follow the following model:

\r\n

Must contain only numeric digits;
For accounts domiciled at Caixa Econômica Federal, the filling must follow the following model: \r\n
- 1 to 4 digits for the account type according to the list of types below plus 8 digits for the account number (if necessary fill with leading zeros):\r\n
  - 0001 – Checking Account for Natural Person;
  - 0003 – Checking Account for Legal Entity;
  - 1288 – Savings Account for Natural Person;
  - 0022 – Savings Account for Legal Entity.
Example: in the account field, you will need to enter the account type (without leading zeros) and the account number: 100000123.

", "type": "number" }, "account_digit": { "description": "Required\r\n
Account check digit number where sales proceeds will be deposited.
\r\n

\r\n Rules:\r\n

\r\n

Must contain 1 numeric digit;
If the account digit is X, replace it with 0.

", "type": "string" } } }, "CustomBankAccountReturn": { "description": "Bank domicile by card brand.", "type": "object", "properties": { "brand": { "description": "Card brand.", "type": "string" }, "bank": { "format": "int32", "description": "Bank code.", "type": "integer" }, "agency": { "format": "int32", "description": "Branch.", "type": "integer" }, "agency_digit": { "description": "Branch check digit.", "type": "string" }, "account": { "format": "int64", "description": "Account.", "type": "integer" }, "account_type": { "description": "Account type. (Send \"C\" for checking account; Or \"P\" for savings account.)", "type": "string" }, "account_digit": { "description": "Account check digit.", "type": "string" } } }, "DocumentPFFacade": { "description": "Document (Send ID for Natural Person)\r\n

If provided:

Must follow the internal rules of the object.

", "required": [ "document_type", "document_number", "document_issue_date", "document_issuer", "document_issuer_state" ], "type": "object", "properties": { "document_type": { "description": "Type of identification document.\r\n

Rules: Must provide the value according to valid values:

id_card: for ID;
driver_license: for Driver's License;
rne: for RNE.

", "enum": [ "id_card", "driver_license", "rne" ], "type": "string" }, "document_number": { "format": "double", "description": "Identification document number.", "type": "number" }, "document_issue_date": { "format": "date-time", "description": "Issuance/expedience date of the identification document.", "type": "string" }, "document_issuer": { "description": "Issuing body of the identification document.", "type": "string" }, "document_issuer_state": { "description": " Issuing state of the identification document.\r\n

Rules:

List of accepted states: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

", "type": "string" }, "document_expiration_date": { "format": "date-time", "description": "Expiration date of the identification document.", "type": "string" }, "document_serial_number": { "description": "Serial number of the identification document.", "type": "string" } } }, "DocumentPFFacadeUpdate": { "description": "Document. (Send ID for Natural Person)\r\n

If provided:

Must follow the internal rules of the object.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

Rules: Must provide the value according to valid values:

id_card: for ID;
driver_license: for Driver's License;
rne: for RNE.

Rules:

List of accepted states: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

", "type": "string" }, "document_expiration_date": { "format": "date-time", "description": "Expiration date of the identification document.", "type": "string" }, "document_serial_number": { "description": "Serial number of the identification document.", "type": "string" } } }, "DocumentPJFacade": { "description": "Document (Send NIRE for Legal Entity)\r\n

If provided:

Must follow the internal rules of the object.

", "required": [ "document_type", "document_number", "document_issuer_state" ], "type": "object", "properties": { "document_type": { "description": "Type of identification document.\r\n

Rules: Must provide the value according to valid values:

nire: for NIRE;

", "enum": [ "nire" ], "type": "string" }, "document_number": { "format": "double", "description": "Identification document number.", "type": "number" }, "document_issuer_state": { "description": " Issuing state of the identification document.\r\n

Rules:

List of accepted states: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

", "type": "string" } } }, "DocumentPJUpdateFacade": { "description": "Document (Send NIRE for Legal Entity)\r\n

If provided:

Must follow the internal rules of the object.

", "required": [ "document_type", "document_number", "document_issuer_state" ], "type": "object", "properties": { "document_type": { "description": "Type of identification document.\r\n

Rules: Must provide the value according to valid values:

nire: for NIRE;

Rules:

List of accepted states: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

", "type": "string" } } }, "MailingAddress": { "description": "Mailing address. \r\n

If provided: \r\nMust follow the internal rules of the mailing address object.

", "required": [ "street", "district", "city", "state", "postal_code" ], "type": "object", "properties": { "street": { "description": "Street address. \r\n

Rules: \r\nCannot be empty or null; \r\nWe recommend sending this information without special characters; \r\nShould contain the type of street address and name (Example: AVENIDA BORGES DE MEDEIROS).

", "type": "string" }, "number": { "format": "int32", "description": "Street number. \r\n

Rules:

If provided, must contain only numeric digits;
For an address without number, provide null or 0 (zero);
If the value provided is null, the system will understand that it is an address without number and will use 0 (zero) as the default value.

", "type": "integer" }, "district": { "description": "Neighborhood name. \r\n

Rules:

Cannot be empty or null;
We recommend sending this information without special characters (Incorrect example: SANTO ANDRÉ, Correct example: SANTO ANDRE).

", "type": "string" }, "city": { "description": "City name. \r\n

Rules:

Cannot be empty or null;
We recommend sending this information without special characters (Incorrect example: SANTO ANDRÉ, Correct example: SANTO ANDRE).

", "type": "string" }, "state": { "description": "State code. \r\n

Rules: \r\nList of accepted states: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

", "type": "string" }, "postal_code": { "format": "int32", "description": "ZIP code. \r\n

Rules: \r\nMust contain only numeric digits; \r\nMust contain a maximum of 8 digits; \r\nMust be valid in the postal code registry.

", "type": "integer" }, "suite": { "description": "Complement/Reference point. \r\n

Rules:

We recommend sending this information without special accent characters;
We do not recommend sending this information containing only numbers (Incorrect example: 406, Correct examples: APT 406, HOUSE 123).

", "type": "string", "maxLength": 20 } } }, "MerchantReturn": { "description": "Response object for registration status inquiry", "type": "object", "properties": { "subseller_id": { "format": "int32", "description": "Unique SubSeller identifier. \r\n

Return: \r\nThe return value contains only numeric digits;\r\nThe return value contains a maximum of 9 digits.

", "type": "integer" }, "subsellerid_ext": { "description": "Unique external SubSeller identifier.\r\n

Return: \r\nThe return value contains up to 50 characters;

", "type": "string" }, "legal_document_number": { "format": "int64", "description": "Registration document number. \r\n
CPF for Natural Person(F) or CNPJ for Legal Entity(J).

Return: \r\nThe value contains only numeric digits without leading zeros; \r\nFor CPF the value contains a maximum of 11 digits; \r\nFor CNPJ the value contains a maximum of 14 digits.

", "type": "integer" }, "fiscal_type": { "description": "Identifies if the registration is a Natural Person or Legal Entity. \r\n

Return: \r\nFor natural person the return value is \"natural_person\"; \r\nFor legal entity the return value is \"company\".

", "type": "string" }, "enabled": { "description": "Indicates if the subseller is active. \r\n

Return: \r\nFor active registration the return value is \"S\"; \r\nFor inactive registration the return value is \"N\".

", "type": "string" }, "status": { "description": "SubSeller status.

\r\n Return: \r\n According to the lifecycle within the onboarding, the status may assume the values below: \r\n Under Analysis; \r\n Awaiting Marketplace Handling; \r\n Rejected to Process/ Reason: {0};\r\n Approved to Process; \r\n Approved to Process and Anticipate.\r\n

", "type": "string" }, "payment_plan": { "format": "int32", "description": "Payment plan code configured for the registration.\r\n

Return: \r\nThe return value contains only numeric digit(s).

", "type": "integer" }, "capture_payments_enabled": { "description": "Indicates if transaction capture is enabled. \r\n

Return: \r\nFor transaction capture enabled the return value is \"S\"; \r\nFor transaction capture blocked the return value is \"N\".

", "type": "string" }, "anticipation_enabled": { "description": "Indicates if receivables anticipation is enabled. \r\n

Return: \r\nFor anticipation enabled the return value is \"S\"; \r\nFor anticipation disabled the return value is \"N\".

", "type": "string" }, "automatic_anticipation": { "description": "Indicates if the SubSeller will use the MGM anticipation service.\r\n

Return:

\"S\" if the subseller will use the anticipation service;
\"N\" if the subseller will not use the anticipation service.

", "type": "string" }, "accepted_contract": { "description": "Acceptance of Getnet Acquiring settlement services. \r\n

Return: \r\nFor service contract accepted the return value is \"S\"; \r\nFor service contract not accepted the return value is \"N\".

", "type": "string" }, "bank_accounts": { "description": "Bank domicile by card brand.\r\n

Attention: \r\nReturn details must be consulted internally in the bank domicile object.

", "type": "array", "items": { "$ref": "#/definitions/CustomBankAccountReturn" } }, "list_commissions": { "description": "List of MDR by Card Brand and product. \r\n

Attention: \r\nReturn details must be consulted internally in the commission object.

", "type": "array", "items": { "$ref": "#/definitions/CommissionSubSeller" } }, "lock_schedule": { "format": "date-time", "description": "Moment the schedule was blocked. \r\n

Return: \r\nFor unblocked schedule the return value is \"null\"; \r\nFor blocked schedule the return value is a date (yyyy-MM-dd HH:mm:ss.fff) with the moment of blocking.

", "type": "string" }, "lock_capture_payments": { "format": "date-time", "description": "Moment the transaction capture was blocked. \r\n

Return: \r\nFor unblocked transaction capture the return value is \"null\"; \r\nFor blocked transaction capture the return value is a date (yyyy-MM-dd HH:mm:ss.fff) with the moment of blocking.

", "type": "string" }, "create_date": { "format": "date-time", "description": "Store registration date. \r\n

Return: \r\nThe return value is a date (yyyy-MM-dd HH:mm:ss.fff) with the moment of registration creation.

", "type": "string" } } }, "PartnerLegalDataFacade": { "description": "Partner. \r\n

If provided: \r\nMust be provided following the internal rules of the partner object.

", "required": [ "participation_percentage", "initial_involvement_date", "fiscal_type", "legal_document_number" ], "type": "object", "properties": { "participation_percentage": { "format": "double", "description": "Percentage of equity participation. \r\n

Rules: \r\nMust be provided for both natural person and legal entity partners.

", "type": "number" }, "initial_involvement_date": { "format": "date-time", "description": "Relationship start date.", "type": "string" }, "partner_data (PF)": { "$ref": "#/definitions/PartnerPFFacade", "description": "Regulatory data of natural person partners. \r\n

Rules: \r\nMust be provided only when the partner is a natural person.

" }, "partner_data (PJ)": { "$ref": "#/definitions/PartnerPJFacade", "description": "Regulatory data of legal entity partners. \r\n

Rules: \r\nMust be provided only when the partner is a legal entity.

" }, "fiscal_type": { "description": "Fiscal type. \r\n

Rules: \r\nMust be provided for both natural person and legal entity partners;\r\nMust provide the value according to valid values.

", "enum": [ "natural_person", "company" ], "type": "string" }, "legal_document_number": { "format": "int64", "description": "Tax identifier of the partner from the perspective of the responsible government agency, usually the tax authority. \r\n

Rules: \r\nMust be informed for both individual and legal entity partners.

For individual partners: \r\nSend CPF (Individual Taxpayer Registry); \r\nMust have a maximum of 11 numeric digits (CPF check digit will be calculated); \r\nThe CPF number must be valid with the Brazilian Federal Revenue Service and be in \"REGULAR\" status.

For legal entity partners: \r\nSend CNPJ (National Registry of Legal Entities);\r\nMust have a maximum of 14 numeric digits (CNPJ check digit will be calculated); \r\nThe CNPJ number must be valid with the Brazilian Federal Revenue Service and be in \"ACTIVE\" status.

", "type": "integer" } } }, "PartnerLegalDataUpdateFacade": { "description": "Partner. \r\n

If informed: \r\nMust follow the internal rules of the partner object.

Rules:

Must be informed for both individual and legal entity partners.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "number" }, "initial_involvement_date": { "format": "date-time", "description": "Relationship start date. \r\n

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "partner_data (PF)": { "$ref": "#/definitions/PartnerPFUpdateFacade", "description": "Regulatory data for individual partners. \r\n

Rules:

Must be informed only when the partner is of individual type.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "partner_data (PJ)": { "$ref": "#/definitions/PartnerPJUpdateFacade", "description": "Regulatory data for legal entity partners. \r\n

Rules:

Must be informed only when the partner is of legal entity type.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "fiscal_type": { "description": "Tax Type. \r\n

Rules:

Must be informed for both individual and legal entity partners;
Must inform the value according to valid values.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

Rules:

Must be informed for both individual and legal entity partners.
For individual partners: \r\n
- Send CPF (Individual Taxpayer Registry);
- Must have a maximum of 11 numeric digits (CPF check digit will be calculated);
- The CPF number must be valid with the Brazilian Federal Revenue Service and be in `REGULAR` status.
For legal entity partners: \r\n
- Send CNPJ (National Registry of Legal Entities);
- Must have a maximum of 14 numeric digits (CNPJ check digit will be calculated);
- The CNPJ number must be valid with the Brazilian Federal Revenue Service and be in `ACTIVE` status.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "integer" } } }, "PartnerPFFacade": { "description": "Regulatory data for individuals. \r\n

If informed: \r\nMust be informed following the internal rules of the individual partner object.

", "required": [ "name", "birth_date", "mothers_name" ], "type": "object", "properties": { "name": { "description": "Full name. \r\n

Rules: \r\nMust have at least two names (e.g.: Mario Silveira); \r\nWe recommend sending this information without special characters, accents or abbreviations; \r\nThe full name from the CPF must be informed as registered with the Federal Revenue Service.

", "type": "string" }, "birth_date": { "format": "date-time", "description": "Date of Birth. \r\n

Rules: \r\nMust be older than 18 years;\r\nThe date of birth must correspond to the CPF provided.

", "type": "string" }, "sex": { "description": "Gender.\r\n

If informed:

Must inform the value according to valid values.

", "enum": [ "female", "male" ], "type": "string" }, "nationality": { "description": "Nationality. \r\n

If informed:

Must have 2 characters;
Must inform the country code according to ISO-3166.

If informed:

Must inform the value according to valid values.

", "enum": [ "not_applied", "in_exercise", "close_or_relative", "inactive_or_away" ], "type": "string" }, "ppe_description": { "description": "PEP Description. \r\n

If informed:

If the value of \"ppe_indication\" field equals \"not_applied\", inform \"NAO APLICADO\";
If the value of \"ppe_indication\" field is different from \"not_applied\", inform the name of the politically exposed person.

", "type": "string" }, "mothers_name": { "description": "Mother's Name. \r\n

If informed:

Must have at least two names (e.g. Maria Silveira);
We recommend sending this information without special characters, accents or abbreviations;
Inform the mother's full name as it appears in identification documents.

", "type": "string" }, "gross_equity": { "format": "double", "description": "Patrimony value. \r\n

If informed:

Must contain only numeric digits and decimal separator (.);
If there are decimal places, up to two decimal digits will be considered;

", "type": "number" }, "monthly_gross_income": { "format": "double", "description": "Monthly income value. \r\nMandatory submission for individual partner (F)", "type": "number" }, "identification_document": { "$ref": "#/definitions/DocumentPFFacade", "description": "Complementary Document. (Send RG, RNE or CNH for Individual)" } } }, "PartnerPJFacade": { "description": "Regulatory data for legal entities. \r\n

If informed:

Must follow the internal rules of the individual partner object.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "required": [ "legal_name", "founding_date" ], "type": "object", "properties": { "legal_name": { "description": "Company Name. \r\n

Rules: \r\nWe recommend sending this information without special characters, accents or abbreviations; \r\nThe full company name must be informed as registered with the Federal Revenue Service.

", "type": "string" }, "founding_date": { "format": "date-time", "description": "CNPJ founding date as registered with the Federal Revenue Service. \r\n

Rules: \r\nMust be after 01/01/1900;\r\nCannot be later than the current date.

", "type": "string" }, "phone": { "$ref": "#/definitions/PhoneBusinessFacade", "description": "Phone." }, "cellphone": { "$ref": "#/definitions/CellPhoneFacade", "description": "Mobile." }, "identification_document": { "$ref": "#/definitions/DocumentPJFacade", "description": "Send NIRE for Legal Entity." } } }, "PartnerPFUpdateFacade": { "description": "Regulatory data for individuals\r\n

If informed:

Must follow the internal rules of the individual partner object.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "object", "properties": { "name": { "description": "Full name. \r\n

If informed:

Must have at least two names (e.g.: Mario Silveira);
We recommend sending this information without special characters, accents or abbreviations;
The full name from the CPF must be informed as registered with the Federal Revenue Service.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "birth_date": { "format": "date-time", "description": "Date of Birth.\r\n

If informed:

Must be older than 18 years;
The date of birth must correspond to the CPF provided.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "sex": { "description": "Gender.\r\n

If informed:

Must inform the value according to valid values.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "enum": [ "female", "male" ], "type": "string" }, "nationality": { "description": "Nationality.\r\n

If informed:

Must have 2 characters;
Must inform the country code according to ISO-3166.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "phone": { "$ref": "#/definitions/PhoneBusinessUpdateFacade", "description": "Phone.\r\n

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "cellphone": { "$ref": "#/definitions/CellPhoneUpdateFacade", "description": "Mobile.\r\n

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "ppe_indication": { "description": "PEP Indication.\r\n

If informed:

Must inform the value according to valid values.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "enum": [ "not_applied", "in_exercise", "close_or_relative", "inactive_or_away" ], "type": "string" }, "ppe_description": { "description": "PEP Description.\r\n

If informed:

If the value of \"ppe_indication\" field equals \"not_applied\", inform \"NAO APLICADO\";
If the value of \"ppe_indication\" field is different from \"not_applied\", inform the name of the politically exposed person.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "mothers_name": { "description": "Mother's Name.\r\n

If informed:

Must have at least two names (e.g. Maria Silveira);
We recommend sending this information without special characters, accents or abbreviations;
Inform the mother's full name as it appears in identification documents.

", "type": "string" }, "gross_equity": { "format": "double", "description": "Patrimony value.\r\n

If informed:

Must contain only numeric digits and decimal separator (.);
If there are decimal places, up to two decimal digits will be considered;

", "type": "number" }, "monthly_gross_income": { "format": "double", "description": "Monthly income value \r\nMandatory submission for individual partner (F)", "type": "number" }, "identification_document": { "$ref": "#/definitions/DocumentPFFacade", "description": "Complementary Document (Send RG, RNE or CNH for Individual)" } } }, "PartnerPJUpdateFacade": { "description": "Regulatory data for legal entities. \r\n

If informed:

Must follow the internal rules of the legal entity partner object.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "object", "properties": { "legal_name": { "description": "Company Name.\r\n

Rules:

We recommend sending this information without special characters, accents or abbreviations;
The full company name must be informed as registered with the Federal Revenue Service.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "founding_date": { "format": "date-time", "description": "CNPJ founding date as registered with the Federal Revenue Service.\r\n

Rules:

Must be after 01/01/1900;
Cannot be later than the current date.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "monthly_gross_income": { "format": "double", "description": "Monthly income value. \r\nMandatory submission for individual partner (F)", "type": "number" }, "phone": { "$ref": "#/definitions/PhoneBusinessUpdateFacade", "description": "Phone.\r\n

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "cellphone": { "$ref": "#/definitions/CellPhoneUpdateFacade", "description": "Mobile.\r\n

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "identification_document": { "$ref": "#/definitions/DocumentPJFacade", "description": "Send NIRE for Legal Entity." } } }, "PaymentPlan": { "description": "Payment plan.", "type": "object", "properties": { "paymentplan_id": { "format": "int32", "description": "Payment plan identifier number.", "type": "integer" }, "name": { "description": "Payment plan description.", "type": "string" }, "anticipation": { "description": "Indicates if plan allows anticipation (\"Y\" or \"N\").", "type": "string" } } }, "PhoneBusinessFacade": { "description": "Business Phone. \r\n

Rules: \r\nThis field is mandatory if \"cellphone\" is not informed. If \"cellphone\" is informed, this field is optional.

", "required": [ "area_code", "phone_number" ], "type": "object", "properties": { "area_code": { "format": "int32", "description": "Area code. \r\n

Rules: \r\nMust be registered in ANATEL list: 11, 12, 13, 14, 15, 16, 17, 18, 19, 21, 22, 24, 27, 28, 31, 32, 33, 34, 35, 37, 38, 41, 42, 43, 44, 45, 46, 47, 48, 49, 51, 53, 54, 55, 61, 62, 63, 64, 65, 66, 69, 67, 68, 71, 73, 74, 75, 77, 79, 81, 87, 82, 83, 84, 85, 88, 86, 89, 91, 93, 94, 92, 97, 95, 96, 98, 99.

", "type": "integer" }, "phone_number": { "format": "int32", "description": "Landline Phone Number. \r\n

Rules: \r\nMust comply with ANATEL rules for landline phone numbers; \r\nThe first digit can only be: 2 or 3 or 4 or 5; \r\nTotal digits must be = 8 (eight).

", "type": "integer" } } }, "PhoneBusinessUpdateFacade": { "description": "Business Phone. \r\n

If informed:

Must follow the internal rules of the object.
If a business phone is already registered, it will be updated.
If it does not exist, a business phone will be registered.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "required": [ "area_code", "phone_number" ], "type": "object", "properties": { "area_code": { "format": "int32", "description": "Area Code for Landline. \r\n

", "type": "integer" }, "phone_number": { "format": "int32", "description": "Landline Phone Number. \r\n

Rules: \r\nMust comply with ANATEL rules for landline phone numbers; \r\nThe first digit can only be: 2 or 3 or 4 or 5; \r\nTotal digits must be = 8 (eight).

", "type": "integer" } } }, "PhoneResidentialFacade": { "description": "Residential Phone. \r\n

Rules:

This field is mandatory if \"cellphone\" is not informed.
If \"cellphone\" is informed, this field is optional.

", "required": [ "area_code", "phone_number" ], "type": "object", "properties": { "area_code": { "format": "int32", "description": "Area Code for Landline. \r\n

Rules

Must be registered in ANATEL list: 11, 12, 13, 14, 15, 16, 17, 18, 19, 21, 22, 24, 27, 28, 31, 32, 33, 34, 35, 37, 38, 41, 42, 43, 44, 45, 46, 47, 48, 49, 51, 53, 54, 55, 61, 62, 63, 64, 65, 66, 69, 67, 68, 71, 73, 74, 75, 77, 79, 81, 87, 82, 83, 84, 85, 88, 86, 89, 91, 93, 94, 92, 97, 95, 96, 98, 99.

", "type": "integer" }, "phone_number": { "format": "int32", "description": "Landline Phone Number\r\n

Rules: \r\nMust comply with ANATEL rules for landline phone numbers; \r\nThe first digit can only be: 2 or 3 or 4 or 5; \r\nTotal digits must be = 8 (eight).

", "type": "integer" } } }, "PhoneResidentialUpdateFacade": { "description": "Residential Phone. \r\n

If informed:

Must follow the internal rules of the object.
If a residential phone is already registered, it will be updated.
If it does not exist, a residential phone will be registered.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "required": [ "area_code", "phone_number" ], "type": "object", "properties": { "area_code": { "format": "int32", "description": "Area Code for Landline\r\n

", "type": "integer" }, "phone_number": { "format": "int32", "description": "Fixed Phone Number\r\n

Rules: \r\nMust comply with ANATEL rules for fixed phone numbers; \r\nThe first digit can only be: 2 or 3 or 4 or 5; \r\nThe total number of digits must be = 8 (eight).

", "type": "integer" } } }, "PreSubSellerPFInclude": { "description": "Data model used for inclusion and update of Individual SubSeller.", "required": [ "merchant_id", "legal_document_number", "legal_name", "birth_date", "occupation", "business_address", "email", "bank_accounts", "list_commissions", "payment_plan", "accepted_contract", "marketplace_store" ], "type": "object", "properties": { "merchant_id": { "description": "Identification number (EC) of the marketplace at GETNET.\r\n

Rules: \r\nMust contain only numeric digits.

", "type": "string" }, "legal_document_number": { "format": "int64", "description": "CPF number (Individual Taxpayer Registration).\r\n

Rules: \r\nMust have a maximum of 11 numeric digits (CPF digit verification will be performed); \r\nThe CPF number must be valid with the Brazilian Federal Revenue Service and be in \"REGULAR\" status.

", "type": "integer" }, "legal_name": { "description": "Full name. \r\n

Rules: \r\nMust have at least two names (e.g.: Mario Silveira); \r\nCannot contain special characters, accents, or abbreviations; \r\nThe full name of the CPF must be informed as registered with the Federal Revenue Service.

", "type": "string" }, "birth_date": { "format": "date-time", "description": "Date of Birth.\r\n

Rules: \r\nMust be older than 18 years;\r\nThe date of birth must correspond to the CPF provided.

", "type": "string" }, "mothers_name": { "description": "Mother's Name. \r\n

Rules: \r\nMust have at least two names (e.g. Maria Silveira); \r\nCannot contain special characters, accents, or abbreviations;\r\nProvide the mother's full name as it appears on an identification document.

", "type": "string" }, "occupation": { "description": "Profession / Business Activity.\r\n

If provided:

We recommend sending this information without special characters (Incorrect example: MÉDICO, Correct example: MEDICO).

", "type": "string" }, "subsellerid_ext": { "description": "Unique identifier of the External SubSeller.\r\n

Return: \r\nThe return value contains up to 50 characters;

", "type": "string" }, "monthly_gross_income": { "format": "double", "description": "Income value of the CPF provided. \r\n

Rules: \r\nMust be greater than zero.

", "type": "number" }, "gross_equity": { "format": "double", "description": "Equity value.
Mandatory submission for individual (F)).", "type": "number" }, "business_address": { "$ref": "#/definitions/CompleteAddressFacade", "description": "Commercial address." }, "mailing_address": { "$ref": "#/definitions/MailingAddress", "description": "Mailing address." }, "phone": { "$ref": "#/definitions/PhoneResidentialFacade", "description": "Phone. This field must be provided." }, "cellphone": { "$ref": "#/definitions/CellPhoneFacade", "description": "Mobile phone. This field must be provided." }, "email": { "description": "Email. \r\n

Rules: \r\nMust have a valid email format (Example: name@domain.com); \r\nCannot contain accents or special characters; \r\nThe domain cannot be @getnet or @santander.

", "type": "string" }, "bank_accounts": { "$ref": "#/definitions/SubSellerBankAccountFacade", "description": "Banking domicile. Payments will only be made to banking domiciles with the same holder as the document (CPF or CNPJ) registered with Getnet." }, "list_commissions": { "description": "List of commissions by card brand and product. \r\n

If provided: \r\nMust be informed following the internal rules of the commission object.

", "type": "array", "items": { "$ref": "#/definitions/CommissionFacade" } }, "url_callback": { "description": "Callback URL where MGM should send registration status changes.\r\n

Rules: \r\nThe URL must be valid and have a valid certificate; \r\nThe Marketplace must provide a copy of the certificate to Getnet; \r\nGetnet will use the certificate to authorize the call to the Marketplace URL via Callback. \r\nNote:This field is optional for customers who do not use the callback URL, that is, for those who use only callback consultation. For customers who use the callback URL, this field is mandatory.

", "type": "string" }, "payment_plan": { "format": "int32", "description": "SubSeller payment plan. \r\n
To consult the payment plans registered for the marketplace, use: `GET pf/consult/paymentplans/{merchant_id}`
\r\n

Rules: \r\nMust contain only numeric digits; \r\nProvide as listed in: domains/paymentplans/{merchant_id}

", "type": "integer" }, "accepted_contract": { "description": "SubSeller acceptance of Getnet Acquiring settlement services.\r\n

Rules: \r\nMust be \"S\". Although the field accepts \"N\", the registration only proceeds with \"S\"; \"N\" is rejected.

", "enum": [ "S", "N" ], "type": "string" }, "marketplace_store": { "description": "Indicates whether the SubSeller is a marketplace's own store.\r\n

Rules: \r\nMust inform the value according to valid values; \r\nSend \"S\" if the subseller is a marketplace's own store; \r\nSend \"N\" if the subseller is not a marketplace's own store.

", "enum": [ "S", "N" ], "type": "string" }, "automatic_anticipation": { "description": "Indicates whether the SubSeller will use the MGM automatic anticipation service.\r\n

Rules:

Must inform the value according to valid values;
Send \"S\" if the subseller will use the automatic anticipation service;
Send \"N\" if the subseller will not use the automatic anticipation service.

", "enum": [ "S", "N" ], "type": "string" } } }, "PreSubSellerPFUpdate": { "required": [ "merchant_id", "subseller_id", "legal_document_number" ], "type": "object", "properties": { "merchant_id": { "description": "Identification number (EC) of the Marketplace at GETNET.\r\n

Rules: \r\nMust contain only numeric digits.

", "type": "string" }, "subseller_id": { "format": "int32", "description": "Unique identifier of the SubSeller.\r\n

Rules: \r\nMust contain only numeric digits;\r\nMust contain a maximum of 9 digits.

", "type": "integer" }, "legal_document_number": { "format": "int64", "description": "CPF number (Individual Taxpayer Registration).\r\n

Rules:

Must have a maximum of 11 numeric digits (CPF digit verification will be performed);
The CPF number must be valid with the Brazilian Federal Revenue Service and be in `REGULAR` status.

Mandatory for Anticipation - Mandatory field for receivable anticipation.

", "type": "integer" }, "legal_name": { "description": "Full name. \r\n

Rules: \r\nThis attribute is optional during complementary registration;\r\nIf provided:

Must have at least two names (e.g.: Mario Silveira);
We recommend sending this information without special characters, accents, or abbreviations;
The full name of the CPF must be informed as registered with the Federal Revenue Service.

Mandatory for Anticipation - Mandatory field for receivable anticipation.

", "type": "string" }, "date": { "format": "date-time", "description": "Date of Birth.\r\n

Rules:

Must be older than 18 years;
The date of birth must correspond to the CPF provided.

Mandatory for Anticipation - Mandatory field for receivable anticipation.

", "type": "string" }, "email": { "description": "Email.\r\n

Rules:

Must have a valid email format (Example: name@domain.com);
Cannot contain accents or special characters;
The domain cannot be @getnet or @santander.

Mandatory for Anticipation - Mandatory field for receivable anticipation.

", "type": "string" }, "phone": { "$ref": "#/definitions/PhoneResidentialUpdateFacade", "description": "Fixed Phone.\r\n

Mandatory for Anticipation - Mandatory field for receivable anticipation.

" }, "cellphone": { "$ref": "#/definitions/CellPhoneUpdateFacade", "description": "Mobile Phone.\r\n

Mandatory for Anticipation - Mandatory field for receivable anticipation.

" }, "business_address": { "$ref": "#/definitions/BasicAddressUpdateFacade", "description": "Commercial Address.\r\n

Mandatory for Anticipation - Mandatory field for receivable anticipation.

" }, "residential_address": { "$ref": "#/definitions/BasicAddressUpdateFacade", "description": "Residential Address.\r\n

Mandatory for Anticipation - Mandatory field for receivable anticipation.

" }, "identification_document": { "$ref": "#/definitions/DocumentPFFacadeUpdate", "description": "Submit RG, RNE, or CNH for Individual.\r\n

Mandatory for Anticipation - Mandatory field for receivable anticipation.

" }, "bank_accounts": { "$ref": "#/definitions/SubSellerBankAccountFacade", "description": "Banking Domicile(s)." }, "list_commissions": { "description": "List of commissions by card brand and product.\r\n

If provided: \r\nMust follow the internal rules of the commission object.

", "type": "array", "items": { "$ref": "#/definitions/CommissionFacade" } }, "url_callback": { "description": "Callback URL where MGM should send registration status changes.\r\n

Rules: \r\nThe URL must be valid and have a valid certificate (Example: https://domain/url_callback); \r\nThe Marketplace must provide a copy of the certificate to Getnet; \r\nGetnet will use the certificate to authorize the call to the Marketplace URL via Callback. \r\nThis field is optional for customers who do not use the callback URL, that is, for those who use only callback consultation. For customers who use the callback URL, this field is mandatory.

", "type": "string" }, "payment_plan": { "format": "int32", "description": "SubSeller Payment Plan.\r\n

Rules: \r\nMust contain only numeric digits; \r\nProvide as listed in: \"domains/paymentplans/{merchant_id}\"

", "type": "integer" }, "marketplace_store": { "description": "Indicates whether the SubSeller is a marketplace's own store.\r\n

Rules: \r\nMust inform the value according to valid values; \r\nSend \"S\" if the subseller is a marketplace's own store; \r\nSend \"N\" if the subseller is not a marketplace's own store.

", "enum": [ "S", "N" ], "type": "string" }, "sex": { "description": "Gender.\r\n

Rules:

Must inform the value according to valid values.

Mandatory for Anticipation - Mandatory field for receivable anticipation.

", "enum": [ "female", "male" ], "type": "string" }, "nationality": { "description": "Nationality.\r\n

Rules:

Must have 2 characters;
Must provide the country code according to ISO-3166.

Mandatory for Anticipation - Mandatory field for receivable anticipation.

", "type": "string" }, "mothers_name": { "description": "Mother's Name.\r\n

If provided:

Must have at least two names (e.g. Maria Silveira);
We recommend sending this information without special characters, accents, or abbreviations;
Provide the mother's full name as it appears on an identification document.

Mandatory for Anticipation - Mandatory field for receivable anticipation.

", "type": "string" }, "fathers_name": { "description": "Father's full name.\r\n

If provided:

Must have at least two names (e.g. Mario Silveira);
We recommend sending this information without special characters, accents, or abbreviations;
Provide the father's full name as it appears on an identification document.

Mandatory for Anticipation - Mandatory field for receivable anticipation.

", "type": "string" }, "birth_city": { "description": "City of birth.\r\n

If provided:

We recommend sending this information without special characters (Incorrect example: SANTO ANDRÉ, Correct example: SANTO ANDRE).

Mandatory for Anticipation - Mandatory field for receivable anticipation.

", "type": "string" }, "birth_state": { "description": "State of birth.\r\n

If provided:

List of accepted states: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

Mandatory for Anticipation - Mandatory field for receivable anticipation.

", "type": "string" }, "occupation": { "description": "Profession / Business activity.", "type": "string" }, "monthly_income": { "format": "double", "description": "Income value of the CPF provided. \r\n

Rules: \r\nMust be greater than or equal to R$100.00.

", "type": "number" }, "ppe_indication": { "description": "PEP indication.", "enum": [ "not_applied", "in_exercise", "close_or_relative", "inactive_or_away" ], "type": "string" }, "ppe_description": { "description": "PEP description.", "type": "string" }, "patrimony": { "format": "double", "description": "Equity value.", "type": "number" } } }, "PreSubSellerPJInclude": { "description": "Data model used for inclusion and update of Corporate SubSeller.", "required": [ "merchant_id", "legal_document_number", "legal_name", "trade_name", "state_fiscal_document_number", "email", "business_address", "bank_accounts", "accepted_contract", "marketplace_store", "payment_plan" ], "type": "object", "properties": { "merchant_id": { "description": "Identification number (EC) of the Marketplace at GETNET. \r\n

Rules: \r\nMust contain only numeric digits.

", "type": "string" }, "legal_document_number": { "format": "int64", "description": "CNPJ number (National Registry of Legal Entities). \r\n

Rules: \r\nMust have a maximum of 14 numeric digits (CNPJ digit verification will be performed); \r\nThe CNPJ number must be valid with the Brazilian Federal Revenue Service and be in \"ACTIVE\" status.

", "type": "integer" }, "legal_name": { "description": "SubSeller legal name. \r\n

Rules: \r\nCannot contain special characters, accents, or abbreviations; \r\nThe full legal name must be informed as registered with the Federal Revenue Service.

", "type": "string" }, "trade_name": { "description": "SubSeller trade name. \r\n

Rules: \r\nCannot be empty;\r\nWe recommend sending this information without special accent characters.

", "type": "string" }, "subsellerid_ext": { "description": "Unique identifier of the External SubSeller.\r\n

Return: \r\nThe return value contains up to 50 characters;

", "type": "string" }, "state_fiscal_document_number": { "description": "SubSeller State Registration. \r\n

Rules: \r\nCannot be empty;\r\nCan be text (\"EXEMPT\") or only numeric digits;\r\nWhen the company is required to register state registration, provide only numeric digits;\r\nWhen not applicable, inform \"EXEMPT\".

", "type": "string" }, "email": { "description": "Email. \r\n

Rules: \r\nMust have a valid email format (Example: name@domain.com); \r\nCannot contain accents or special characters; \r\nThe domain cannot be @getnet or @santander.

", "type": "string" }, "phone": { "$ref": "#/definitions/PhoneBusinessFacade", "description": "Fixed Phone. This field must be provided." }, "cellphone": { "$ref": "#/definitions/CellPhoneFacade", "description": "Mobile Phone. This field must be provided." }, "business_address": { "$ref": "#/definitions/BasicAddressFacade", "description": "SubSeller Tax Address." }, "bank_accounts": { "$ref": "#/definitions/SubSellerBankAccountFacade", "description": "Banking domicile. Payments will only be made to banking domiciles with the same holder as the document (CPF or CNPJ) registered with Getnet." }, "url_callback": { "description": "Callback URL where MGM should send registration status changes.\r\n

Rules: \r\nThe URL must be valid and have a valid certificate; \r\nThe Marketplace must provide a copy of the certificate to Getnet; \r\nGetnet will use the certificate to authorize the call to the Marketplace URL via Callback. \r\nThis field is optional for customers who do not use the callback URL, that is, for those who use only callback consultation. For customers who use the callback URL, this field is mandatory.

", "type": "string" }, "accepted_contract": { "description": "SubSeller acceptance of Getnet Acquiring settlement services. \r\n

Rules: \r\nMust be \"S\". Although the field accepts \"N\", the registration only proceeds with \"S\"; \"N\" is rejected.

", "enum": [ "S", "N" ], "type": "string" }, "marketplace_store": { "description": "Indicates whether the SubSeller is a marketplace's own store.\r\n

Rules: \r\nMust inform the value according to valid values; \r\nSend \"S\" if the subseller is a marketplace's own store; \r\nSend \"N\" if the subseller is not a marketplace's own store.

", "enum": [ "S", "N" ], "type": "string" }, "automatic_anticipation": { "description": "Indicates whether the SubSeller will use the MGM automatic anticipation service.\r\n

Rules:

Must inform the value according to valid values;
Send \"S\" if the subseller will use the automatic anticipation service;
Send \"N\" if the subseller will not use the automatic anticipation service.

", "enum": [ "S", "N" ], "type": "string" }, "payment_plan": { "format": "int32", "description": "SubSeller Payment Plan.\r\n

Rules: \r\nMust contain only numeric digits; \r\nProvide as listed in: \"domains/paymentplans/{merchant_id}\"

", "type": "integer" }, "business_entity_type": { "format": "int32", "description": "Provide the legal nature code of the company as stated on the CNPJ card. \r\n

Rules: \r\nMust contain only numeric digits; \r\nMust have 4 numeric digits.

", "type": "integer" }, "economic_activity_classification_code": { "format": "int32", "description": "Inform the company's primary CNAE as shown on the CNPJ card\r\n

Rules: \r\nMust contain only numeric digits; \r\nMust have 6 or 7 numeric digits.

", "type": "integer" }, "monthly_gross_income": { "format": "double", "description": "Inform the company's annual revenue. If the company does not have a year of registration, the projected revenue must be reported.\r\n

Rules: \r\nMust contain only numeric digits; \r\nMust be greater than R$100.00.

", "type": "number" }, "billing_value": { "format": "double", "description": "Inform the company's annual revenue. If the company does not have a year of registration, the projected revenue must be reported.\r\n

Rules:

Must contain only numeric digits;
Must be greater than R$100.00.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "number" }, "billing_date": { "format": "date-time", "description": "Invoice date.", "type": "string" }, "federal_registration_status": { "description": "Subseller status with the Brazilian Tax Authority.\r\n

Rules: \r\nMust inform the value according to valid values.

", "enum": [ "active", "suspended", "unfit", "dactivated", "nulified" ], "type": "string" }, "founding_date": { "format": "date-time", "description": "CNPJ founding date as registered with the Brazilian Tax Authority.\r\n

Rules: \r\nMust be greater than 01/01/1900;\r\nCannot be greater than the current date.

", "type": "string" }, "list_commissions": { "description": "List of commissions by flag and product.\r\n

If informed: \r\nMust be informed following the internal rules of the commission object.

", "type": "array", "items": { "$ref": "#/definitions/CommissionFacade" } }, "legal_representative": { "$ref": "#/definitions/RepresentanteLegal", "description": "Legal representative of the Subseller." }, "shareholders": { "description": "List of Subseller partners.", "type": "array", "items": { "$ref": "#/definitions/PartnerLegalDataFacade" } } } }, "PreSubSellerPJUpdate": { "required": [ "merchant_id", "subseller_id", "legal_document_number" ], "type": "object", "properties": { "merchant_id": { "description": "Identification number (EC) of the Marketplace at GETNET.\r\n

Rules: \r\nMust contain only numeric digits.

", "type": "string" }, "subseller_id": { "format": "int32", "description": "Unique SubSeller identifier.\r\n

Rules: \r\nMust contain only numeric digits;\r\nMust contain a maximum of 9 digits.

", "type": "integer" }, "legal_document_number": { "format": "int64", "description": "CNPJ number (National Register of Legal Entities).\r\n

Rules:

Must have a maximum of 14 numeric digits (CNPJ digit calculation will be performed);
The CNPJ number must be valid with the Brazilian Tax Authority and be in \"ACTIVE\" status.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "integer" }, "legal_name": { "description": "Subseller company name.\r\n

Rules:

Cannot contain special characters, accents, or abbreviations;
The complete company name as registered with the Brazilian Tax Authority must be informed.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "trade_name": { "description": "Subseller trade name.\r\n

Rules:

Cannot be empty;
Cannot contain special accent characters.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "date": { "format": "date-time", "description": "CNPJ founding date as registered with the Brazilian Tax Authority.\r\n

Rules:

Must be greater than 01/01/1900;
Cannot be greater than the current date.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "business_entity_type": { "format": "int32", "description": "Inform the code of the company's legal nature as shown on the CNPJ card\r\n

Rules:

Must contain only numeric digits;
Must have 4 numeric digits.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

Rules:

Must contain only numeric digits;
Must be greater than R$100.00.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

Rules:

Must contain only numeric digits;
Must be greater than R$100.00.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "number" }, "billing_date": { "format": "date-time", "description": "Invoice date.\r\n

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "phone": { "$ref": "#/definitions/PhoneBusinessUpdateFacade", "description": "Landline phone.\r\n

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "cellphone": { "$ref": "#/definitions/CellPhoneUpdateFacade", "description": "Mobile phone.\r\n

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "business_address": { "$ref": "#/definitions/BasicAddressUpdateFacade", "description": "Tax address.\r\n

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "economic_activity_classification_code": { "format": "int32", "description": "Inform the company's primary CNAE as shown on the CNPJ card\r\n

Rules:

Must contain only numeric digits;
Must have 6 or 7 numeric digits.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "integer" }, "federal_registration_status": { "description": "Subseller status with the Brazilian Tax Authority.\r\n

Rules:

Must inform the value according to valid values.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "federal_registration_status_date": { "format": "date-time", "description": "Date of Subseller status with the Brazilian Tax Authority.\r\n

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "state_fiscal_document_number": { "description": "Subseller State Registration.\r\n

Rules:

Cannot be empty;
Can be text (\"EXEMPT\") or only numeric digits;
When the company is required to register state registration, only numeric digits must be informed;
When not applicable, inform \"EXEMPT\".

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "email": { "description": "Email.\r\n

Rules:

Must have a valid email format (Example: name@domain.com);
Cannot contain accents or special characters;
The domain cannot be @getnet or @santander.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "legal_representative": { "$ref": "#/definitions/UpdateRepresentanteLegal", "description": "Legal representative." }, "shareholders": { "description": "List of Partners.\r\n

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "array", "items": { "$ref": "#/definitions/PartnerLegalDataFacade" } }, "automatic_anticipation": { "description": "Indicates if the Subseller will use the MGM anticipation service.\r\n

If informed:

Must inform the value according to valid values;
Send \"S\" if the subseller will use the anticipation service;
Send \"N\" if the subseller will not use the anticipation service.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "enum": [ "S", "N" ], "type": "string" }, "identification_document": { "$ref": "#/definitions/DocumentPJFacade", "description": "Send NIRE for Legal Entity." }, "url_callback": { "description": "Callback URL where MGM must send registration status changes.\r\n

Rules: \r\nThe URL must be valid and have a valid certificate (Example: https://domain/callback_url); \r\nThe Marketplace must provide a copy of the certificate to Getnet; \r\nGetnet will use the certificate to authorize the Marketplace URL call via Callback.\r\nThis field is optional for clients who do not use the callback URL, that is, for those who use only the callback query. For clients who use the callback URL, this field is mandatory.

", "type": "string" }, "marketplace_store": { "description": "Indicates if the Subseller is a marketplace's own store.\r\n

Rules:

Must inform the value according to valid values;
Send \"S\" if the subseller is a marketplace's own store;
Send \"N\" if the subseller is not a marketplace's own store.

", "enum": [ "S", "N" ], "type": "string" }, "payment_plan": { "format": "int32", "description": "Subseller Payment Plan.\r\n

Rules: \r\nMust contain only numeric digits; \r\nInform according to the list available at: \"domains/paymentplans/{merchant_id}\"

", "type": "integer" }, "bank_accounts": { "$ref": "#/definitions/SubSellerBankAccountFacade", "description": "Bank Account Domicile(s)." }, "list_commissions": { "description": "List of commissions by flag and product.\r\n

If informed: \r\nMust be informed following the internal rules of the commission object.

", "type": "array", "items": { "$ref": "#/definitions/CommissionFacade" } } } }, "RepresentanteLegal": { "description": "Subseller legal representative.\r\n

If informed: \r\nMust be informed following the internal rules of the legal representative object.

", "required": [ "name", "birth_date", "legal_document_number" ], "type": "object", "properties": { "name": { "description": "Full name.\r\n

Rules: \r\nMust have at least two names (e.g.: Mario Silveira); \r\nCannot contain special characters, accents, or abbreviations; \r\nThe complete CPF name must be informed as registered with the Brazilian Tax Authority.

", "type": "string" }, "birth_date": { "format": "date-time", "description": "Birth date.\r\n

Rules: \r\nMust be greater than 18 years old and less than 80;\r\nThe birth date must correspond to the reported CPF.

", "type": "string" }, "legal_document_number": { "format": "int64", "description": "CPF number (Individual Taxpayer Registry).\r\n

Rules: \r\nMust have a maximum of 11 numeric digits (CPF digit calculation will be performed); \r\nThe CPF number must be valid with the Brazilian Tax Authority and be in \"REGULAR\" status.

", "type": "integer" }, "sex": { "description": "Gender.\r\n

Rules:

Must inform the value according to valid values.

", "enum": [ "female", "male" ], "type": "string" }, "nationality": { "description": "Nationality.\r\n

Rules:

Must have 2 characters;
Must inform the country code according to ISO-3166.

", "type": "string" }, "ppe_indication": { "description": "PEP indication.\r\n

Rules:

Must inform the value according to valid values.

", "enum": [ "not_applied", "in_exercise", "close_or_relative", "inactive_or_away" ], "type": "string" }, "ppe_description": { "description": "PEP description.\r\n

Rules:

If the value of the \"ppe_indication\" field equals \"not_applied\", inform \"NAO APLICADO\";
If the value of the \"ppe_indication\" field is different from \"not_applied\", inform the name of the politically exposed person.

", "type": "string" }, "mothers_name": { "description": "Mother's name.\r\n

If informed:

Must have at least two names (e.g. Maria Silveira);
We recommend sending this information without special characters, accents, or abbreviations;
Inform the complete mother's name as shown in identification document.

", "type": "string" }, "fathers_name": { "description": "Father's full name.\r\n

If informed:

Must have at least two names (e.g. Mario Silveira);
We recommend sending this information without special characters, accents, or abbreviations;
Inform the complete father's name as shown in identification document.

", "type": "string" }, "identification_document": { "$ref": "#/definitions/DocumentPFFacade", "description": "Complementary document.\r\n
Send RG, RNE, or CNH for Individual." }, "monthly_gross_income": { "format": "double", "description": "Monthly income value.", "type": "number" }, "monthly_gross_income_date": { "format": "date-time", "description": "Reference date for Monthly Income.", "type": "string" } } }, "Response": { "description": "Response class.", "type": "object", "properties": { "success": { "description": "Indicates if the operation was completed successfully.", "type": "boolean", "readOnly": true }, "errors": { "description": "List of errors.", "type": "array", "items": { "type": "string" } } } }, "SubSellerBankAccountFacade": { "description": "Bank Account Domicile(s).\r\n

If informed:\r\nPayments will only be made to bank domiciles with the same holder as the document (CPF or CNPJ) registered with Getnet.\r\nMust be informed following the internal rules of the bank account domicile object.

", "required": [ "type_accounts" ], "type": "object", "properties": { "type_accounts": { "description": "Type of bank account domicile configuration.\r\n

Rules:

If this field is filled with the value \"unique\", it is mandatory to inform the value of the \"unique_account\" field.

If this field is filled with the value \"custom\", it is mandatory to inform the value of the \"custom_accounts\" field.

", "enum": [ "unique", "custom" ], "type": "string" }, "unique_account": { "$ref": "#/definitions/BankAccountFacade", "description": "Unique Bank Account Domicile.\r\n

The bank domicile informed will be used for all available flags.

Rules: \r\nSend only if type_accounts = \"unique\".

" }, "custom_accounts": { "description": "Bank Account Domicile by Flag.\r\n

Rules: \r\nSend only if type_accounts = \"custom\"; \r\nMust inform a bank domicile per available flag;\r\nInform bank domicile for all available flags.

", "type": "array", "items": { "$ref": "#/definitions/CustomBankAccountFacade" } } } }, "SubSellerPFUpdate": { "description": "Data model used for Subseller inclusion and update.", "required": [ "merchant_id", "subseller_id", "legal_document_number" ], "type": "object", "properties": { "merchant_id": { "description": "Identification number (EC) of the Marketplace at GETNET.\r\n

Rules: \r\nMust contain only numeric digits.

", "type": "string" }, "subseller_id": { "format": "int32", "description": "Unique subseller identifier.\r\n

Rules: \r\nMust contain only numeric digits;\r\nMust contain a maximum of 9 digits.

", "type": "integer" }, "subsellerid_ext": { "description": "Unique external SubSeller identifier.\r\n

Return: \r\nThe return value contains up to 50 characters;

", "type": "string" }, "legal_document_number": { "format": "int64", "description": "CPF number (Individual Taxpayer Registry).\r\n

Rules:

Must have a maximum of 11 numeric digits (CPF digit calculation will be performed);
The CPF number must be valid with the Brazilian Tax Authority and be in \"REGULAR\" status.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "integer" }, "legal_name": { "description": "Full name.\r\n

Rules:

Must have at least two names (e.g.: Mario Silveira);
Cannot contain special characters, accents, or abbreviations;
The complete CPF name must be informed as registered with the Brazilian Tax Authority.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "birth_date": { "format": "date-time", "description": "Birth date.\r\n

Rules:

Must be greater than 18 years old;
The birth date must correspond to the reported CPF.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "sex": { "description": "Gender.\r\n

If informed:

Must inform the value according to valid values.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "enum": [ "female", "male" ], "type": "string" }, "mothers_name": { "description": "Mother's name.\r\n

Rules:

Must have at least two names (e.g. Maria Silveira);
Cannot contain special characters, accents, or abbreviations;
Inform the complete mother's name of the CPF as shown in identification document.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "fathers_name": { "description": "Full name of father.\r\n

If informed:

Must have at least two names (ex. Mario Silveira);
We recommend sending this information without special characters, accents or abbreviations;
Inform the father's full name as it appears in an identification document.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "gross_equity": { "format": "double", "description": "Asset value.\r\n

If informed:

Must contain only numeric digits and decimal separator (.);
If there is a decimal place, up to two decimal digits will be considered;

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "number" }, "monthly_gross_income": { "format": "double", "description": "Monthly income value of the informed CPF. \r\n

If informed:

Must contain only numeric digits and decimal separator (.);
If there is a decimal place, up to two decimal digits will be considered;
Must be greater than or equal to 100.00.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "number" }, "business_address": { "$ref": "#/definitions/BasicAddressUpdateFacade", "description": "Commercial Address.\r\n

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "residential_address": { "$ref": "#/definitions/BasicAddressUpdateFacade", "description": "Residential Address.\r\n

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "birth_city": { "description": "City of birth.\r\n

If informed:

We recommend sending this information without special characters (Incorrect example: SANTO ANDRÉ, Correct example: SANTO ANDRE).

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "birth_state": { "description": "State of birth.\r\n

If informed:

List of accepted states: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "identification_document": { "$ref": "#/definitions/DocumentPFFacadeUpdate", "description": "Send ID for Individual.\r\n

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "phone": { "$ref": "#/definitions/PhoneBusinessUpdateFacade", "description": "Landline Phone. \r\n

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "cellphone": { "$ref": "#/definitions/CellPhoneUpdateFacade", "description": "Mobile Phone. \r\n

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "nationality": { "description": "Nationality.\r\n

If informed:

Must have 2 characters;
Must inform the country code according to ISO-3166.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "naturalized": { "description": "Naturalized.\r\n

If informed:

Must inform the value according to valid values;
Send \"S\" if the CPF holder is naturalized;
Send \"N\" if the CPF holder is not naturalized.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "enum": [ "S", "N" ], "type": "string" }, "ppe_indication": { "description": "PEP Indication.\r\n

If informed:

Must inform the value according to valid values.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "enum": [ "not_applied", "in_exercise", "close_or_relative", "inactive_or_away" ], "type": "string" }, "ppe_description": { "description": "PEP Description.\r\n

If informed:

If the value of the field \"ppe_indication\" equals \"not_applied\", inform \"NAO APLICADO\";
If the value of the field \"ppe_indication\" is different from \"not_applied\", inform the name of the politically exposed person.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "email": { "description": "E-mail. \r\n

Rules:

Must have a valid email format (Example: name@domain.com);
Cannot contain accents or special characters;
The domain cannot be @getnet and @santander.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "occupation": { "description": "Profession / Business Activity. \r\n

If informed:

We recommend sending this information without special characters (Incorrect example: MÉDICO, Correct example: MEDICO).

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "automatic_anticipation": { "description": "Indicates whether the Subseller will use the MGM anticipation service.\r\n

If informed:

Must inform the value according to valid values;
Send \"S\" if the subseller will use the anticipation service;
Send \"N\" if the subseller will not use the anticipation service.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "enum": [ "S", "N" ], "type": "string" }, "marketplace_store": { "description": "Indicates whether the Subseller is a marketplace's own store. \r\n

Rules: \r\nMust inform the value according to valid values; \r\nSend \"S\" if the subseller is a marketplace's own store; \r\nSend \"N\" if the subseller is not a marketplace's own store.

", "enum": [ "S", "N" ], "type": "string" }, "payment_plan": { "format": "int32", "description": "Subseller Payment Plan. \r\n

Rules: \r\nMust contain only numeric digits; \r\nInform according to the list available at: \"domains/paymentplans/{merchant_id}\"

", "type": "integer" }, "block_payments": { "description": "This field should be used to block/unblock the Subseller payment schedule.\r\n

Rules: \r\nMust inform the value according to valid values; \r\nSend \"S\" to block the payment schedule; \r\nSend \"N\" to unblock the payment schedule.

", "enum": [ "S", "N" ], "type": "string" }, "block_transactions": { "description": "This field should be used to block/unblock transaction capture for the Subseller.\r\n

Rules: \r\nMust inform the value according to valid values; \r\nSend \"S\" to block transaction capture; \r\nSend \"N\" to unblock transaction capture.

", "enum": [ "S", "N" ], "type": "string" }, "bank_accounts": { "$ref": "#/definitions/SubSellerBankAccountFacade", "description": "Bank domicile. Payments will only be made to bank domiciles with the same ownership as the document (CPF or CNPJ) registered with Getnet." }, "list_commissions": { "description": "List of commissions by brand and product. \r\n

If informed: \r\nMust be informed following the internal rules of the commission object.

", "type": "array", "items": { "$ref": "#/definitions/CommissionFacade" } } } }, "SubSellerPJUpdate": { "description": "Data model used for inclusion and update of Subseller.", "required": [ "merchant_id", "subseller_id", "legal_document_number" ], "type": "object", "properties": { "merchant_id": { "description": "Identification number (EC) of the marketplace at GETNET. \r\n

Rules: \r\nMust contain only numeric digits.

", "type": "string" }, "subseller_id": { "format": "int32", "description": "Unique SubSeller identifier. \r\n

Rules: \r\nMust contain only numeric digits;\r\nMust contain a maximum of 9 digits.

", "type": "integer" }, "subsellerid_ext": { "description": "Unique External SubSeller identifier.\r\n

Return: \r\nThe return value contains up to 50 characters;

", "type": "string" }, "legal_document_number": { "format": "int64", "description": "CNPJ number (National Registry of Legal Entities). \r\n

Rules:

Must have a maximum of 14 numeric digits (CNPJ digit calculation will be performed);
The CNPJ number must be valid with the Brazilian Federal Revenue and be in \"ACTIVE\" status.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "integer" }, "legal_name": { "description": "Subseller legal name. \r\n

Rules:

Cannot contain special characters, accents or abbreviations;
The complete legal name as registered with the Federal Revenue must be informed.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "trade_name": { "description": "Subseller trade name. \r\n

Rules:

Cannot be empty;
Cannot contain special accent characters.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "founding_date": { "format": "date-time", "description": "CNPJ founding date as registered with the Federal Revenue.\r\n

Rules:

Must be greater than 01/01/1900;
Cannot be greater than the current date.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "business_entity_type": { "format": "int32", "description": "Inform the legal nature code of the company as it appears on the CNPJ card. \r\n

Rules:

Must contain only numeric digits;
Must have 4 numeric digits.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "integer" }, "monthly_gross_income": { "format": "double", "description": "Inform the company's monthly revenue. If the company does not have a year of registration, the projected revenue should be informed.\r\n

Rules:

Must contain only numeric digits;
Must be greater than R$100.00.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

Rules:

Must contain only numeric digits;
Must be greater than R$100.00.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "number" }, "billing_date": { "format": "date-time", "description": "Revenue date.\r\n

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "phone": { "$ref": "#/definitions/PhoneBusinessUpdateFacade", "description": "Landline Phone.\r\n

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "cellphone": { "$ref": "#/definitions/CellPhoneUpdateFacade", "description": "Mobile Phone.\r\n

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "business_address": { "$ref": "#/definitions/BasicAddressFacade", "description": "Tax Address.\r\n

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "economic_activity_classification_code": { "format": "int32", "description": "Inform the company's primary CNAE as it appears on the CNPJ card. \r\n

Rules:

Must contain only numeric digits;
Must have 6 or 7 numeric digits.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "integer" }, "federal_registration_status": { "description": "Subseller status with the Federal Revenue. \r\n

Rules:

Must inform the value according to valid values.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "enum": [ "active", "suspended", "unfit", "dactivated", "nulified" ], "type": "string" }, "federal_registration_status_date": { "format": "date-time", "description": "Date of Subseller status with the Federal Revenue.\r\n

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "state_fiscal_document_number": { "description": "Subseller State Registration. \r\n

Rules:

Cannot be empty;
Can be text (\"EXEMPT\") or only numeric digits;
When the company is required to register for state registration, only numeric digits must be informed;
When not applicable, inform \"EXEMPT\".

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "email": { "description": "E-mail. \r\n

Rules:

Must have a valid email format (Example: name@domain.com);
Cannot contain accents or special characters;
The domain cannot be @getnet and @santander.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "identification_document": { "$ref": "#/definitions/DocumentPJUpdateFacade", "description": "Send NIRE for Legal Entity.\r\n

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "legal_representative": { "$ref": "#/definitions/UpdateRepresentanteLegal", "description": "Legal representative of the Subseller." }, "shareholders": { "description": "List of Partners.\r\n

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "array", "items": { "$ref": "#/definitions/PartnerLegalDataUpdateFacade" } }, "automatic_anticipation": { "description": "Indicates whether the Subseller will use the MGM anticipation service.\r\n

If informed:

Must inform the value according to valid values;
Send \"S\" if the subseller will use the anticipation service;
Send \"N\" if the subseller will not use the anticipation service.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "enum": [ "S", "N" ], "type": "string" }, "marketplace_store": { "description": "Indicates whether the Subseller is a marketplace's own store. \r\n

Rules: \r\nMust inform the value according to valid values; \r\nSend \"S\" if the subseller is a marketplace's own store; \r\nSend \"N\" if the subseller is not a marketplace's own store.

", "enum": [ "S", "N" ], "type": "string" }, "payment_plan": { "format": "int32", "description": "Subseller Payment Plan. \r\n

Rules: \r\nMust contain only numeric digits; \r\nInform according to the list available at: \"domains/paymentplans/{merchant_id}\"

", "type": "integer" }, "block_payments": { "description": "This field should be used to block/unblock the Subseller payment schedule. \r\n

Rules: \r\nMust inform the value according to valid values; \r\nSend \"S\" to block the payment schedule; \r\nSend \"N\" to unblock the payment schedule.

", "enum": [ "S", "N" ], "type": "string" }, "block_transactions": { "description": "This field should be used to block/unblock transaction capture for the Subseller.\r\n

Rules: \r\nMust inform the value according to valid values; \r\nSend \"S\" to block transaction capture; \r\nSend \"N\" to unblock transaction capture.

If informed: \r\nMust be informed following the internal rules of the commission object.

", "type": "array", "items": { "$ref": "#/definitions/CommissionFacade" } } } }, "UpdateRepresentanteLegal": { "description": "Legal representative of the Subseller.\r\n

If informed:

Must follow the internal rules of the object.
If a mobile phone is registered, it will be changed.
If it does not exist, a mobile phone will be registered.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "required": [ "legal_document_number" ], "type": "object", "properties": { "legal_document_number": { "format": "int64", "description": "CPF number (Cadastro de Pessoa Física).\r\n

Rules:

Must have a maximum of 11 numeric digits (CPF digit calculation will be performed);
The CPF number must be valid with the Brazilian Federal Revenue Service and in \"REGULAR\" status.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "integer" }, "identification_document": { "$ref": "#/definitions/DocumentPFFacadeUpdate", "description": "Complementary document.\r\n
Send RG for Individual (F) or Nire for Legal Entity (J)." }, "monthly_gross_income": { "format": "double", "description": "Monthly income value of the informed CPF. \r\n

If informed:

Must be greater than or equal to R$100.00.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "number" }, "name": { "description": "Full name. \r\n

Rules:

Must have at least two names (e.g.: Mario Silveira);
We recommend sending this information without special characters, accents or abbreviations;
The full name of the CPF must be informed as registered with the Federal Revenue Service.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "mothers_name": { "description": "Mother's name.\r\n

If informed:

Must have at least two names (e.g.: Maria Silveira);
We recommend sending this information without special characters, accents or abbreviations;
Provide the full name of the mother as it appears in the identification document.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "fathers_name": { "description": "Father's full name.\r\n

If informed:

Must have at least two names (e.g.: Mario Silveira);
We recommend sending this information without special characters, accents or abbreviations;
Provide the full name of the father as it appears in the identification document.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "birth_date": { "format": "date-time", "description": "Date of Birth.\r\n

If informed:

Must be older than 18 years;
The date of birth must correspond to the informed CPF.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "sex": { "description": "Gender.\r\n

If informed:

Must inform the value according to valid values.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "enum": [ "female", "male" ], "type": "string" }, "nationality": { "description": "Nationality.\r\n

If informed:

Must have 2 characters;
Must inform the country code according to ISO-3166.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "naturalized": { "description": "Naturalized.\r\n

If informed:

Must inform the value according to valid values;
Send \"S\" if the CPF holder is naturalized;
Send \"N\" if the CPF holder is not naturalized.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "enum": [ "S", "N" ], "type": "string" }, "phone": { "$ref": "#/definitions/PhoneBusinessUpdateFacade", "description": "Phone.\r\n

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "cellphone": { "$ref": "#/definitions/CellPhoneUpdateFacade", "description": "Mobile phone.\r\n

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "ppe_indication": { "description": "PEP indication.\r\n

If informed:

Must inform the value according to valid values.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "enum": [ "not_applied", "in_exercise", "close_or_relative", "inactive_or_away" ], "type": "string" }, "ppe_description": { "description": "PEP description.\r\n

If informed:

If the value of the field \"ppe_indication\" equals \"not_applied\", inform \"NAO APLICADO\";
If the value of the field \"ppe_indication\" is different from \"not_applied\", inform the name of the politically exposed person.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "birth_city": { "description": "City of birth.\r\n

If informed:

We recommend sending this information without special characters (Incorrect example: SANTO ANDRÉ, Correct example: SANTO ANDRE).

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "birth_state": { "description": "State of birth.\r\n

If informed:

List of accepted states: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "monthly_gross_income_date": { "format": "date-time", "description": "Reference date for Monthly Income.\r\n

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "type": "string" }, "gross_equity": { "format": "double", "description": "Equity value.", "type": "number" } } }, "AdjustmentsStatement": { "description": "Adjustments", "type": "object", "properties": { "type_register": { "format": "int32", "description": "Record type | 4 - Adjustments.", "type": "integer" }, "bank": { "description": "Bank domicile - Bank.", "type": "string" }, "agency": { "description": "Bank domicile - Agency with digit.", "type": "string" }, "account_number": { "description": "Bank domicile - Account number with digit.", "type": "string" }, "marketplace_subsellerid": { "description": "Marketplace own store code.", "type": "string" }, "adjustment_origin": { "description": "Origin of the listed adjustment: \r\nA: automatically generated by the system \r\nM: manually entered by the marketplace", "type": "string" }, "marketplace_schedule_id": { "format": "int64", "description": "NSU of the scheduling in the MGM system.", "type": "integer" }, "nu_liquid": { "description": "Settlement.", "type": "string" }, "merchand_id": { "description": "Commercial establishment code.", "type": "string" }, "cpfcnpj_subseller": { "description": "CPF/CNPJ of the subseller.", "type": "string" }, "cnpj_marketplace": { "description": "CNPJ of the marketplace.", "type": "string" }, "adjustment_id": { "format": "int32", "description": "Adjustment id.", "type": "integer" }, "adjustment_type": { "format": "int32", "description": "Adjustment type \r\n1 'Credit Adjustment', \r\n2 'Debit Adjustment', \r\n3 'Electronic Statement Cancellation', \r\n4 'Electronic Statement Chargeback', \r\n6 'Credit for Expired Negative', \r\n7 'Debit for Expired Negative', \r\n8 'Credit Adjustment Anticipation', \r\n9 'Debit Adjustment Anticipation', \r\n10 'Brand Fine', \r\n11 'Debit Adjustment Refund of Store Boleto', \r\n12 'Debit Adjustment Refund of Marketplace Boleto'", "type": "integer" }, "adjustment_date": { "format": "date-time", "description": "Date of the adjustment request.", "type": "string" }, "adjustment_amount": { "format": "int64", "description": "Adjustment value in cents.", "type": "integer" }, "subseller_rate_closing_date": { "format": "date-time", "description": "Instant of sending for payment of the value.", "type": "string" }, "subseller_rate_confirm_date": { "format": "date-time", "description": "Instant of bank confirmation return.", "type": "string" }, "payment_date": { "format": "date-time", "description": "Date calculated by the system for payment of the value to the subseller.", "type": "string" }, "transaction_sign": { "description": "'+' Credit, '-' Debit.", "type": "string" }, "adjustment_reason": { "description": "Adjustment description.", "type": "string" }, "order_id": { "description": "Order number (Num_Pedido) generated by the marketplace.", "type": "string" }, "product_id": { "format": "int32", "description": "Product code. \r\n1\tMASTERCARD, \r\n2\tMAESTRO, \r\n 3\tVISA, \r\n 4\tVISA ELECTRON, \r\n 5\tAMEX, \r\n 11\tELO CREDIT, \r\n 12\tELO DEBIT, \r\n 13\tHIPER-HIPERCARD CREDIT, \r\n 101\tBOLETO SANTANDER", "type": "integer" }, "our_number": { "description": "Boleto \"Our Number\" field", "type": "string" }, "nsu_boleto_adjustment": { "description": "NSU of boleto refund", "type": "string" } } }, "ChargebackStatement": { "description": "Chargeback", "type": "object", "properties": { "type_register": { "format": "int32", "description": "Record type | 5 - Chargeback", "type": "integer" }, "bank": { "description": "Bank Domicile - Bank", "type": "string" }, "agency": { "description": "Bank Domicile - Agency with digit", "type": "string" }, "account_number": { "description": "Bank Domicile - Account number with digit", "type": "string" }, "marketplace_schedule_id": { "format": "int64", "description": "NSU of the scheduling in the MGM system.", "type": "integer" }, "marketplace_subsellerid": { "description": "Marketplace own store code.", "type": "string" }, "nu_liquid": { "description": "Settlement.", "type": "string" }, "release_status": { "description": "Indicates if the scheduling has already been released for payment Y/N.", "type": "string" }, "merchand_id": { "description": "Commercial establishment code.", "type": "string" }, "marketplace_transaction_id": { "format": "int64", "description": "NSU Marketplace Management", "type": "integer" }, "transaction_date": { "format": "date-time", "description": "Transaction Date/Time", "type": "string" }, "installment_date": { "format": "date-time", "description": "Installment Date/Time represented", "type": "string" }, "chargeback_amount": { "format": "int64", "description": "Installment value in cents.", "type": "integer" }, "subseller_rate_confirm_date": { "format": "date-time", "description": "Date of bank payment confirmation return", "type": "string" }, "seller_id": { "description": "Marketplace Id (SellerId)", "type": "string" }, "transaction_sign": { "description": "'+' Credit, '-' Debit", "type": "string" }, "adjustment_id": { "format": "int32", "description": "Adjustment Id", "type": "integer" }, "adjustment_type": { "format": "int32", "description": "Adjustment Type \r\n1 'Credit Adjustment', \r\n2 'Debit Adjustment', \r\n3 'Electronic Statement Cancellation', \r\n4 'Electronic Statement Chargeback', \r\n6 'Credit for Expired Negative', \r\n7 'Debit for Expired Negative', \r\n8 'Credit Adjustment Anticipation', \r\n9 'Debit Adjustment Anticipation', \r\n10 'Brand Fine', \r\n11 'Debit Adjustment Refund of Store Boleto', \r\n12 'Debit Adjustment Refund of Marketplace Boleto'", "type": "integer" }, "adjustment_date": { "format": "date-time", "description": "Date of the adjustment request.", "type": "string" }, "adjustment_amount": { "format": "int64", "description": "Adjustment value in cents.", "type": "integer" }, "adjustment_origin": { "description": "- Origin of the listed adjustment: \r\nA : automatically generated by the system \r\nM : manually entered by the marketplace", "type": "string" }, "adjustment_reason": { "description": "Adjustment Description.", "type": "string" }, "acquirer_transaction_id": { "description": "Acquirer transaction code.", "type": "string" }, "card_payment_amount": { "format": "int64", "description": "Card transaction value in cents.", "type": "integer" }, "sum_details_card_payment_amount": { "format": "int64", "description": "Sum of values listed in details in cents listed in type 2 records.", "type": "integer" }, "marketplace_original_transaction_id": { "format": "int64", "description": "Original NSU Marketplace Management (Only for Cancellation/Chargeback)", "type": "integer" }, "transaction_status_code": { "format": "int32", "description": "Transaction Status Code \r\n0\tApproved, \r\n70\tAwaiting, \r\n77\tPending, \r\n78\tPending Payment , \r\n83\tTimeout, \r\n86\tReversed, \r\n90\tNonexistent, \r\n91\tDenied - Issuer, \r\n92\tRefunded, \r\n93\tDuplicate, \r\n94\tRefunded Reconciliation, \r\n98\tCanceled - Without Confirmation, \r\n99\tDenied - MGM.", "type": "integer" }, "terminal_nsu": { "description": "Authorization code generated by the Issuer when the transaction is completed successfully.", "type": "string" }, "reason_message": { "description": "Brand return message.", "type": "string" }, "authorization_code": { "description": "Brand authorization code.", "type": "string" }, "order_id": { "description": "Order number.", "type": "string" }, "vlr_mdr_marketplace": { "format": "int64", "description": "Marketplace MDR value.", "type": "integer" }, "vlr_fee": { "format": "int64", "description": "Marketplace Fee value.", "type": "integer" }, "vlr_somaMdrFee": { "format": "int64", "description": "Sum value of marketplace MDR and platform FEE.", "type": "integer", "readOnly": true }, "perc_mdr_marketplace": { "format": "double", "description": "Percentage value of marketplace MDR.", "type": "number" }, "perc_fee": { "format": "double", "description": "Percentage value of platform Fee.", "type": "number" }, "perc_somaMdrFee": { "format": "double", "description": "Sum value of percentage of marketplace MDR and platform FEE.", "type": "number", "readOnly": true }, "product_id": { "format": "int32", "description": "Product Code. \r\n1\tMASTERCARD, \r\n2\tMAESTRO, \r\n3\tVISA, \r\n4\tVISA ELECTRON, \r\n5\tAMEX, \r\n11\tELO CREDIT, \r\n12\tELO DEBIT, \r\n13\tHIPER-HIPERCARD CREDIT, \r\n101\tBOLETO SANTANDER", "type": "integer" } } }, "CommissionStatement": { "description": "Commission", "type": "object", "properties": { "type_register": { "format": "int32", "description": "Record type | 3 - Commission.", "type": "integer" }, "bank": { "description": "Bank Domicile - Bank.", "type": "string" }, "agency": { "description": "Bank Domicile - Agency with digit.", "type": "string" }, "account_number": { "description": "Bank Domicile - Account number with digit.", "type": "string" }, "marketplace_schedule_id": { "format": "int64", "description": "NSU of the scheduling in the MGM system.", "type": "integer" }, "marketplace_subsellerid": { "description": "Marketplace own store code.", "type": "string" }, "nu_liquid": { "description": "Settlement.", "type": "string" }, "marketplace_transaction_id": { "format": "int64", "description": "NSU Marketplace Management.", "type": "integer" }, "transaction_date": { "format": "date-time", "description": "Transaction Date/Time.", "type": "string" }, "confirmation_date": { "format": "date-time", "description": "Transaction confirmation Date/Time.", "type": "string" }, "item_id": { "description": "Product code received in the order.", "type": "string" }, "number_installments": { "format": "int32", "description": "Total number of installments.", "type": "integer" }, "installment": { "format": "int32", "description": "Current installment number represented.", "type": "integer" }, "installment_date": { "format": "date-time", "description": "Installment Date/Time represented.", "type": "string" }, "installment_amount": { "format": "int64", "description": "Installment value in cents.", "type": "integer" }, "subseller_rate_amount": { "format": "int64", "description": "Commission value for the subseller (own store) in cents.", "type": "integer" }, "subseller_rate_percentage": { "format": "double", "description": "Percentage of subseller commission calculated by the system.", "type": "number" }, "mdr_rate_ammount": { "format": "int64", "description": "Value in cents of MDR fee charged from the seller.", "type": "integer" }, "mdr_rate_percentage": { "format": "double", "description": "Percentage of MDR fee charged from the seller.", "type": "number" }, "payment_date": { "format": "date-time", "description": "Payment date requested in confirmation.", "type": "string" }, "subseller_rate_closing_date": { "format": "date-time", "description": "Instant of Electronic Statement confirmation.", "type": "string" }, "subseller_rate_confirm_date": { "format": "date-time", "description": "Instant of bank confirmation return of store payment.", "type": "string" }, "cancel_custom_key": { "description": "Customer key used to identify a cancellation request.", "type": "string" }, "cancel_request_id": { "description": "Identifier of the cancellation request.", "type": "string" }, "transaction_sign": { "description": "'+' Credit, '-' Debit.", "type": "string" }, "item_id_mgm": { "description": "Order item id (Seql_PedidoItem).", "type": "string" }, "payment_id": { "format": "uuid", "description": "Payment identification code", "type": "string" }, "payment_tag": { "description": "Tag to identify parts of item payment in more than one card.", "type": "string" }, "item_split_tag": { "description": "Tag to identify parts of the item among the items in the list.", "type": "string" } } }, "DetailsStatement": { "description": "Details", "type": "object", "properties": { "type_register": { "format": "int32", "description": "Record type | 2 - Transaction detail.", "type": "integer" }, "bank": { "description": "Bank domicile - Bank.", "type": "string" }, "agency": { "description": "Bank domicile - Agency with digit.", "type": "string" }, "account_number": { "description": "Bank domicile - Account number with digit.", "type": "string" }, "marketplace_schedule_id": { "format": "int64", "description": "NSU of the scheduling in the MGM system.", "type": "integer" }, "marketplace_subsellerid": { "description": "Marketplace own store code.", "type": "string" }, "nu_liquid": { "description": "Settlement.", "type": "string" }, "release_status": { "description": "Indicates if the scheduling has already been released for payment Y/N.", "type": "string" }, "merchand_id": { "description": "Commercial establishment code.", "type": "string" }, "cpfcnpj_subseller": { "description": "CPF/CNPJ of the subseller.", "type": "string" }, "cancel_custom_key": { "description": "Customer key used to identify a cancellation request.", "type": "string" }, "cancel_request_id": { "description": "Identifier of the cancellation request. \r\nCurrently MGM is returning in this field the Payment_ID of the transaction (returned in the Payments response) and not the cancel_request_id (returned in the cancellation request).", "type": "string" }, "marketplace_transaction_id": { "format": "int64", "description": "NSU Marketplace Management.", "type": "integer" }, "cnpj_marketplace": { "description": "CNPJ of the marketplace.", "type": "string" }, "transaction_date": { "format": "date-time", "description": "Transaction Date/Time.", "type": "string" }, "confirmation_date": { "format": "date-time", "description": "Transaction confirmation Date/Time.", "type": "string" }, "item_id": { "description": "Product code received in the order.", "type": "string" }, "number_installments": { "format": "int32", "description": "Total number of installments.", "type": "integer" }, "installment": { "format": "int32", "description": "Current installment number represented.", "type": "integer" }, "installment_date": { "format": "date-time", "description": "Installment Date/Time represented.", "type": "string" }, "installment_amount": { "format": "int64", "description": "Installment value in cents.", "type": "integer" }, "subseller_rate_amount": { "format": "int64", "description": "Value of transfer to the subseller in cents.", "type": "integer" }, "subseller_rate_percentage": { "format": "double", "description": "Percentage charged from the subseller for MGM operation.", "type": "number" }, "payment_date": { "format": "date-time", "description": "Date calculated by the system for payment of the value to the subseller. This date can be changed at the moment of payment release for the item.", "type": "string" }, "subseller_rate_closing_date": { "format": "date-time", "description": "Date on which the payment record was sent to CIP.", "type": "string" }, "subseller_rate_confirm_date": { "format": "date-time", "description": "Date received in the 2nd CIP return file with confirmation of payment to be made by the bank.", "type": "string" }, "subseller_id": { "format": "int64", "description": "Store code.", "type": "integer" }, "seller_id": { "description": "Marketplace id (SellerId).", "type": "string" }, "transaction_sign": { "description": "'+' Credit, '-' Debit.", "type": "string" }, "item_id_mgm": { "description": "Order item id (Seql_PedidoItem).", "type": "string" }, "payment_id": { "format": "uuid", "description": "Payment identification code.", "type": "string" }, "payment_tag": { "description": "Tag to identify parts of item payment in more than one card.", "type": "string" }, "item_split_tag": { "description": "Tag to identify parts of the item among the items in the list.", "type": "string" } } }, "Error": { "description": "Error item.", "type": "object", "properties": { "cod_error": { "format": "int32", "description": "Error code.", "type": "integer" }, "message": { "description": "Message.", "type": "string" } } }, "ParamCheckStatusAdjustment": { "description": "API parameterization for querying the status of boleto adjustment.", "required": [ "market_place_id" ], "type": "object", "properties": { "market_place_id": { "description": "Marketplace id (Seller ID).", "type": "string" }, "merchant_id": { "description": "Client EC.", "type": "string" }, "nsu_adjustment": { "description": "Refund adjustment code generated in the adjustment request.", "type": "string" }, "order_id": { "description": "Order number.", "type": "string" }, "client_document": { "description": "Customer document number.", "type": "string" }, "subseller_id": { "description": "Store id in the system.", "type": "string" }, "initial_date": { "description": "Start date of the research period.", "type": "string" }, "final_date": { "description": "End date of the research period.", "type": "string" } } }, "ParamConfirmBoletoAdjustment": { "description": "API parameterization for boleto adjustment request.", "required": [ "market_place_id", "merchand_id", "subseller_id", "our_number", "bank_number", "order_id", "person_type", "client_name", "client_document", "client_type_document", "client_bank_number", "client_agency_number", "type_account", "client_account_number", "client_account_dg_number", "item_amount", "total_val_reversal" ], "type": "object", "properties": { "market_place_id": { "description": "Marketplace id (Seller ID)", "type": "string" }, "merchant_id": { "description": "Client EC.", "type": "string" }, "subseller_id": { "format": "int32", "description": "Subseller id.", "type": "integer" }, "our_number": { "description": "Boleto \"Our Number\" field.", "type": "string" }, "bank_number": { "description": "Bank Code Generator (Assignee) of the Boleto. \r\n

Rules:

Must contain between 1 and 3 numeric digits;
Inform according to the domain list available in: domains/banks.

", "type": "string" }, "order_id": { "description": "Order number.", "type": "string" }, "person_type": { "description": "Type of person (F = Individual / J = Legal Entity).", "type": "string" }, "client_name": { "description": "Customer name.", "type": "string" }, "client_document": { "description": "Customer document.", "type": "string" }, "client_type_document": { "description": "Type of customer document (CPF/CNPJ).", "type": "string" }, "client_bank_number": { "format": "int32", "description": "Bank code of the drawee.\r\n

Rules:

Must contain a minimum of 1 and a maximum of 3 numeric digits;
Inform according to the list of domains available at: domains/banks.

", "type": "integer" }, "client_agency_number": { "format": "int32", "description": "Agency number for Refund (Drawee) of the Boleto.\r\n

Rules: \r\nFor Checking (C) or Savings (P) type accounts, the completion must follow the following model:

Must contain a minimum of 1 and a maximum of 4 numeric digits.
Must be greater than 0 (zero);

For Payment type accounts (G), the completion must follow the following model:

Must contain 1 numeric digit;
Must send 0 (zero).

", "type": "integer" }, "type_account": { "description": "Customer account type \r\n

Rules: \r\nMust inform the value according to valid values:

C: for Checking Account;
G: for Payment Account;
P: for Savings Account.

", "type": "string" }, "client_account_number": { "format": "int32", "description": "Account number where the Refund (Drawee) of the Boleto will be made.\r\n

Rules: \r\nFor Checking (C) or Savings (P) type accounts, the completion must follow the following model:

Must contain only numeric digits;
For accounts domiciled at Caixa Econômica Federal, the completion must follow the following model: \r\n
- There are 3 digits for the account type, 8 digits for the account, the account types are as follows:\r\n
  - 001 – Checking Account for Individual;
  - 003 – Checking Account for Business;
  - 013 – Savings Account for Individual;
  - 022 – Savings Account for Business.
Example: in the account field, it will be necessary to enter the account type (without leading zeros) and the account number: 100000123.

For Payment type accounts (G), the completion must follow the following model:

Must contain a minimum of 1 and a maximum of 20 numeric digits;
Must send 0 (zero) in the agency number field.

", "type": "integer" }, "client_account_dg_number": { "description": "Account digit where the Refund (Drawee) of the Boleto will be made.\r\n

Rules:

Must contain 1 numeric digit;
If the account digit is X, replace it with 0.

", "type": "string" }, "item_amount": { "format": "double", "description": "Item value.", "type": "number" }, "total_val_reversal": { "format": "double", "description": "Total refund value.", "type": "number" } } }, "ParamRequestAdjustments": { "description": "Statement request parameters.", "required": [ "seller_id", "merchant_id", "subseller_id", "type_adjustment", "amount", "date_adjustment" ], "type": "object", "properties": { "seller_id": { "description": "Marketplace ID (SellerId).", "type": "string" }, "merchant_id": { "description": "Commercial establishment code.", "type": "string" }, "subseller_id": { "format": "int32", "description": "Subseller ID.", "type": "integer" }, "type_adjustment": { "format": "int32", "description": "Adjustment type. \r\n1 - Credit Adjustment; \r\n2 - Debit Adjustment.", "type": "integer" }, "amount": { "format": "int64", "description": "Total adjustment value.", "type": "integer" }, "date_adjustment": { "format": "date-time", "description": "Adjustment date.", "type": "string" }, "adjustment_motive_code": { "format": "int32", "description": "Adjustment reason/motive code (264). Available codes: 1 - Chargeback adjustment, 2 - Commission adjustment, 3 - Financial recovery, 4 - Sales through other payment methods, 5 - Refund, 6 - Order adjustment.", "type": "integer" }, "description": { "description": "Description.", "type": "string" } } }, "ParamResubmitBoletoAdjustment": { "description": "Parameterization of the boleto adjustment resend API.", "required": [ "market_place_id", "nsu_adjustment", "merchant_id", "subseller_id", "our_number", "bank_number", "order_id", "person_type", "client_name", "client_document", "client_type_document", "client_bank_number", "client_agency_number", "type_account", "client_account_number", "client_account_dg_number", "item_amount", "total_val_reversal" ], "type": "object", "properties": { "market_place_id": { "description": "MarketPlace ID (Seller ID)", "type": "string" }, "nsu_adjustment": { "description": "Request code (Send this parameter only in case of request resend)", "type": "string" }, "merchant_id": { "description": "Customer EC", "type": "string" }, "subseller_id": { "format": "int32", "description": "Subseller ID", "type": "integer" }, "our_number": { "description": "\"Our Number\" field of the boleto", "type": "string" }, "bank_number": { "description": "Bank code Issuer (Cedente) of the Boleto.\r\n

Rules:

Must contain a minimum of 1 and a maximum of 3 numeric digits;
Inform according to the list of domains available at: domains/banks.

", "type": "string" }, "order_id": { "description": "Order number", "type": "string" }, "person_type": { "description": "Type of person (F = Individual / J = Business)", "type": "string" }, "client_name": { "description": "Customer name", "type": "string" }, "client_document": { "description": "Customer document", "type": "string" }, "client_type_document": { "description": "Type of customer document (CPF/CNPJ)", "type": "string" }, "client_bank_number": { "format": "int32", "description": "Bank code of the drawee.\r\n

Rules:

Must contain a minimum of 1 and a maximum of 3 numeric digits;
Inform according to the list of domains available at: domains/banks.

", "type": "integer" }, "client_agency_number": { "format": "int32", "description": "Agency number for Refund (Drawee) of the Boleto.\r\n

Rules: \r\nFor Checking (C) or Savings (P) type accounts, the completion must follow the following model:

Must contain a minimum of 1 and a maximum of 4 numeric digits.
Must be greater than 0 (zero);

For Payment type accounts (G), the completion must follow the following model:

Must contain 1 numeric digit;
Must send 0 (zero).

", "type": "integer" }, "type_account": { "description": "Customer account type \r\n

Rules: \r\nMust inform the value according to valid values:

C: for Checking Account;
G: for Payment Account;
P: for Savings Account.

", "type": "string" }, "client_account_number": { "format": "int32", "description": "Account number where the Refund (Drawee) of the Boleto will be made.\r\n

Rules: \r\nFor Checking (C) or Savings (P) type accounts, the completion must follow the following model:

Must contain only numeric digits;
For accounts domiciled at Caixa Econômica Federal, the completion must follow the following model: \r\n
- There are 3 digits for the account type, 8 digits for the account, the account types are as follows:\r\n
  - 001 – Checking Account for Individual;
  - 003 – Checking Account for Business;
  - 013 – Savings Account for Individual;
  - 022 – Savings Account for Business.
Example: in the account field, it will be necessary to enter the account type (without leading zeros) and the account number: 100000123.

For Payment type accounts (G), the completion must follow the following model:

Must contain a minimum of 1 and a maximum of 20 numeric digits;
Must send 0 (zero) in the agency number field.

", "type": "integer" }, "client_account_dg_number": { "description": "Account digit where the Refund (Drawee) of the Boleto will be made.\r\n

Rules:

Must contain 1 numeric digit;
If the account digit is X, replace it with 0.

", "type": "string" }, "item_amount": { "format": "double", "description": "Item value", "type": "number" }, "total_val_reversal": { "format": "double", "description": "Total refund value", "type": "number" } } }, "PaymentAccount": { "description": "Bank domicile information.", "type": "object", "properties": { "Bank": { "format": "int32", "description": "Bank.", "type": "integer" }, "Agency": { "format": "int32", "description": "Agency.", "type": "integer" }, "AgencyDigit": { "description": "Agency digit.", "type": "string" }, "AccountNumber": { "description": "Account number.", "type": "string" }, "AccountDigit": { "description": "Account digit.", "type": "string" }, "AccountType": { "description": "Account type.", "type": "string" } } }, "PaymentSeller": { "description": "Information about the EC.", "type": "object", "properties": { "NumEC": { "description": "EC code for the Marketplace.", "type": "string" }, "Name": { "description": "EC name.", "type": "string" } } }, "PaymentSubseller": { "description": "Information about the Subseller.", "type": "object", "properties": { "Id": { "format": "int32", "description": "Subseller identification code.", "type": "integer" }, "Name": { "description": "Subseller name.", "type": "string" }, "Accounts": { "description": "Bank domicile information.", "type": "array", "items": { "$ref": "#/definitions/PaymentAccount" } } } }, "OrderDetails": { "description": "Order details", "type": "object", "properties": { "order_id": { "description": "Order number.", "type": "string" }, "nsu_adjustment": { "description": "Request code (send this parameter only in case of request resend).", "type": "string" }, "status_adjustment": { "description": "Adjustment / refund status", "type": "string" }, "total_val_adjustment": { "format": "double", "description": "", "type": "number" }, "client_document": { "description": "Customer document.", "type": "string" }, "client_name": { "description": "Customer name.", "type": "string" }, "client_bank_number": { "description": "Bank code Refund (Drawee) of the Boleto.", "type": "string" }, "client_agency_number": { "description": "Agency code Refund (Drawee) of the Boleto.", "type": "string" }, "client_agency_dg_number": { "description": "Agency digit Refund (Drawee) of the Boleto.", "type": "string" }, "client_account_number": { "description": "Account code Refund (Drawee) of the Boleto.", "type": "string" }, "client_account_dg_number": { "description": "Account digit Refund (Drawee) of the Boleto.", "type": "string" }, "transaction_type": { "description": "Transaction submission type: E - Submission / R - Resubmission.", "type": "string" }, "create_date": { "description": "Creation date.", "type": "string" }, "last_update": { "description": "Date of last update.", "type": "string" } } }, "ReturnCheckStatusAdjustment": { "description": "Response from boleto refund status query.", "type": "object", "properties": { "market_place_id": { "description": "Marketplace ID (Seller ID).", "type": "string" }, "list_subsellers": { "description": "List of subsellers of the informed marketplace.", "type": "array", "items": { "$ref": "#/definitions/Subseller" } } } }, "ReturnError": { "description": "Errors", "type": "object", "properties": { "errors": { "description": "List of errors.", "type": "array", "items": { "$ref": "#/definitions/Error" } } } }, "ReturnErrorPayment": { "description": "Error message.", "type": "object", "properties": { "Error": { "type": "array", "items": { "type": "string" } } } }, "ReturnRequestAdjustments": { "description": "Electronic posting.", "type": "object", "properties": { "adjustments_amount": { "format": "int64", "description": "Adjustment value in cents.", "type": "integer" }, "date_adjustment": { "format": "date-time", "description": "Adjustment date.", "type": "string" }, "type_adjustment": { "format": "int32", "description": "Adjustment type.", "type": "integer" }, "cod_ret": { "format": "int32", "description": "Return code.", "type": "integer" }, "msg_ret": { "description": "Return message.", "type": "string" }, "adjustment_entry_id": { "format": "int32", "description": "Record code.", "type": "integer" } } }, "ReturnRequestBoletoAdjust": { "description": "Response from adjustment request - boleto refund", "type": "object", "properties": { "nsu_adjustment": { "description": "NSU of the adjustment - generated in the adjustment request.", "type": "string" } } }, "ReturnRequestPaginatedStatement": { "description": "Electronic Statement", "type": "object", "properties": { "list_transactions": { "description": "List of transactions.", "type": "array", "items": { "$ref": "#/definitions/TransactionStatement" } }, "commission": { "description": "Commission.", "type": "array", "items": { "$ref": "#/definitions/CommissionStatement" } }, "adjustments": { "description": "Adjustments.", "type": "array", "items": { "$ref": "#/definitions/AdjustmentsStatement" } }, "chargeback": { "description": "Chargeback.", "type": "array", "items": { "$ref": "#/definitions/ChargebackStatement" } }, "page_amount": { "format": "int32", "description": "Number of pages in the paginated query.", "type": "integer" } } }, "ReturnRequestPayment": { "description": "Payment return", "type": "object", "properties": { "BrandId": { "format": "int32", "description": "Card brand.", "type": "integer" }, "ProductDescription": { "description": "Product description.", "type": "string" }, "LiquidationDate": { "format": "date-time", "description": "Settlement date.", "type": "string" }, "Value": { "format": "int32", "description": "Value.", "type": "integer" }, "Account": { "$ref": "#/definitions/PaymentAccount", "description": "Bank domicile information." }, "Seller": { "$ref": "#/definitions/PaymentSeller", "description": "EC information." }, "Subseller": { "$ref": "#/definitions/PaymentSubseller", "description": "Subseller information." }, "PaymentDate": { "format": "date-time", "description": "Payment date.", "type": "string" }, "RejectionDate": { "format": "date-time", "description": "Rejection date.", "type": "string" }, "Reason": { "description": "Reason for rejection.", "type": "string" }, "FirstAttemptDate": { "format": "date-time", "description": "Date of first attempt.", "type": "string" }, "LastAttemptDate": { "format": "date-time", "description": "Date of last attempt.", "type": "string" }, "Status": { "description": "Current situation.", "type": "string" } } }, "ReturnRequestPaymentArray": { "description": "List of payments", "type": "array", "items": { "$ref": "#/definitions/ReturnRequestPayment" } }, "ReturnRequestStatement": { "description": "Electronic statement.", "type": "object", "properties": { "list_transactions": { "description": "List of transactions.", "type": "array", "items": { "$ref": "#/definitions/TransactionStatement" } }, "commission": { "description": "Commission.", "type": "array", "items": { "$ref": "#/definitions/CommissionStatement" } }, "adjustments": { "description": "Adjustments.", "type": "array", "items": { "$ref": "#/definitions/AdjustmentsStatement" } }, "chargeback": { "description": "Chargeback.", "type": "array", "items": { "$ref": "#/definitions/ChargebackStatement" } } } }, "Subseller": { "description": "Subseller related to the informed marketplace.", "type": "object", "properties": { "subseller_id": { "description": "Store ID in the system.", "type": "string" }, "list_orders_details": { "description": "List of order details related to the subseller.", "type": "array", "items": { "$ref": "#/definitions/OrderDetails" } } } }, "SummaryStatement": { "description": "Summary", "type": "object", "properties": { "type_register": { "format": "int32", "description": "Record type | 1 - Transaction summary.", "type": "integer" }, "order_id": { "description": "Order number.", "type": "string" }, "seller_id": { "description": "Marketplace code.", "type": "string" }, "marketplace_subsellerid": { "description": "Marketplace own store code.", "type": "string" }, "merchand_id": { "description": "Commercial establishment code.", "type": "string" }, "cnpj_marketplace": { "description": "Marketplace CNPJ.", "type": "string" }, "marketplace_transaction_id": { "format": "int64", "description": "NSU Marketplace Management.", "type": "integer" }, "transaction_date": { "format": "date-time", "description": "Transaction date/time.", "type": "string" }, "confirmation_date": { "format": "date-time", "description": "Transaction confirmation date/time.", "type": "string" }, "product_id": { "format": "int32", "description": "Product code. \r\n1\tMASTERCARD, \r\n2\tMAESTRO, \r\n 3\tVISA, \r\n 4\tVISA ELECTRON, \r\n 5\tAMEX, \r\n 11\tELO CREDIT, \r\n 12\tELO DEBIT, \r\n 13\tHYPER-HIPERCARD CREDIT, \r\n101\tSANTANDER BOLETO.", "type": "integer" }, "transaction_type": { "format": "int32", "description": "Transaction type. \r\n1\tSpot credit, \r\n2\tStorekeeper installment credit, \r\n3\tAdministrator installment credit, \r\n4\tDebit, \r\n5\tCancellation, \r\n6\tChargeback, \r\n7\tBoleto.", "type": "integer" }, "number_installments": { "format": "int32", "description": "Total number of installments.", "type": "integer" }, "nsu_host": { "description": "Host NSU", "type": "string" }, "acquirer_transaction_id": { "description": "Acquirer transaction code.", "type": "string" }, "card_payment_amount": { "format": "int64", "description": "Transaction value on card or boleto in cents.", "type": "integer" }, "sum_details_card_payment_amount": { "format": "int64", "description": "Sum of the value listed in the details in cents listed in type 2 records.", "type": "integer" }, "marketplace_original_transaction_id": { "format": "int64", "description": "Original NSU Marketplace Management (only for Cancellation/Chargeback).", "type": "integer" }, "transaction_status_code": { "format": "int32", "description": "Transaction status code. \r\n0\tApproved, \r\n70\tAwaiting, \r\n77\tPending, \r\n78\tPayment pending, \r\n83\tTimeout, \r\n86\tVoided, \r\n90\tNon-existent, \r\n91\tDenied - Administrator, \r\n92\tRefunded, \r\n93\tRepeated, \r\n94\tRefunded reconciliation, \r\n98\tCanceled - Without confirmation, \r\n99\tDenied - MGM.", "type": "integer" }, "transaction_sign": { "description": "'+' Credit , '-' Debit.", "type": "string" }, "terminal_nsu": { "description": "Authorization code generated by the issuer when the transaction is completed successfully.", "type": "string" }, "reason_message": { "description": "Return message.", "type": "string" }, "authorization_code": { "description": "Credit authorization code.", "type": "string" }, "payment_id": { "format": "uuid", "description": "Payment identification code.", "type": "string" }, "terminal_identification": { "description": "Terminal identification (Store front).", "type": "string" }, "nsu_tef": { "description": "Tef NSU identification.", "type": "string" }, "entry_mode": { "description": "Transaction mode identification. \r\n001\tCollected through batch processing, \r\n011\tCard typed, \r\n021\tCard read. \r\n051\tCard ICC EMV. \r\n071\tContactless card with EMV data. \r\n091\tContactless card with magnetic stripe. \r\n801\tMagnetic fallback from ICC card. \r\n810\tE-commerce", "type": "string" }, "transaction_channel": { "description": "Transaction entry channel. \r\n1\tDigital, \r\n2\tPhysical\r\n///", "type": "string" }, "capture": { "description": "Transaction entry channel. \r\n10\tPOS\r\n13\tVERMELHINHA, \r\n15\tMODEM, \r\n20\tDialed TEF, \r\n30\tDedicated TEF, \r\n35\tWEB RECHARGE, \r\n40\tPIN PAD, \r\n45\tE-COMMERCE, \r\n50\tIVR, \r\n55\tWEB TOPAZIO, \r\n60\tEASY GOOD, \r\n63\tIATA, \r\n65\tFILE EXCHANGE, \r\n70\tMOBILE, \r\n71\tMOBILE GETNET, \r\n74\tSUPERGET MOBILE, \r\n75\tCHIP, \r\n80\tREADER, \r\n90\tAC READER, \r\n95\tATM, \r\n97\tTHIRD-PARTY EQUIPMENT, \r\n///", "type": "string" }, "payment_tag": { "description": "Tag to identify parts of item payment across more than one card.", "type": "string" } } }, "TransactionStatement": { "description": "Transaction", "type": "object", "properties": { "summary": { "$ref": "#/definitions/SummaryStatement", "description": "Transaction summary." }, "details": { "description": "Transaction detail.", "type": "array", "items": { "$ref": "#/definitions/DetailsStatement" } } } }, "AdjustmentDetailsViewModel": { "type": "object", "properties": { "subseller_id": { "type": "integer", "format": "int32", "description": "Store identifier." }, "marketplace_schedule_id": { "type": "integer", "format": "int64", "description": "NSU of scheduling in the MGM system." }, "subseller_document_number": { "type": "string", "description": "Document number: CPF/CNPJ of the subseller.", "maxLength": 14 }, "transaction_sign": { "type": "string", "description": "Transaction signal: '+' Credit , '-' Debit.", "maxLength": 1 }, "product_id_desc": { "type": "string", "description": "Product code \r\n1\tMASTERCARD / \r\n2\tMAESTRO / \r\n3\tVISA / \r\n4\tVISA ELECTRON / \r\n5\tAMEX / \r\n11\tELO CREDIT / \r\n12\tELO DEBIT / \r\n13\tHYPER-HIPERCARD CREDIT / \r\n101\tSANTANDER BOLETO", "maxLength": 30 }, "adjustment_type": { "type": "integer", "format": "int32", "description": "Adjustment type \r\n1 'Credit Adjustment',\r\n2 'Debit Adjustment',\r\n3 'Electronic Statement Cancellation',\r\n4 'Electronic Statement Chargeback',\r\n5 'Negative Settlement Balance',\r\n6 'Credit for Expired Negative',\r\n7 'Debit for Expired Negative',\r\n8 'Credit Adjustment ST Advance',\r\n9 'Debit Adjustment ST Advance',\r\n10 'Card Flag Penalty',\r\n11 'Debit Adjustment Store Boleto Refund',\r\n12 'Debit Adjustment Marketplace Boleto Refund',\r\n13 'ChargeBack MDR Acquirer',\r\n14 'ChargeBack MDR Marketplace',\r\n15 'ChargeBack Marketplace Platform Fee'\r\n16 'Debit Adjustment GN Advance'\r\n17 'Credit Adjustment GN Advance'\r\n18 'Debit Adjustment IF Advance'\r\n19 'Debit Adjustment NF Advance'\r\n20 'Credit Adjustment IF Advance'\r\n21 'Credit Adjustment NF Advance'\r\n22 'Residual Balance Adjustment Advance'" }, "adjustment_reason": { "type": "string", "description": "Adjustment description.", "maxLength": 50 }, "adjustment_date": { "type": "string", "description": "Date of adjustment effectiveness." }, "adjustment_amount": { "type": "number", "format": "double", "description": "Adjustment value." }, "interest_value": { "type": "number", "format": "double", "description": "Interest value applied per schedule." }, "ioc_value": { "type": "number", "format": "double", "description": "IOC value applied per schedule." }, "operation_type_code": { "type": "string", "description": "Operation type code." }, "operation_identifier_code": { "type": "string", "description": "Operation identification code." }, "payment_date": { "type": "string", "description": "Date calculated by the system for payment of the amount to the subseller." }, "subseller_rate_confirm_date": { "type": "string", "description": "Instant of bank confirmation return." } }, "description": "Adjustment details" }, "AdjustmentViewModel": { "type": "object", "properties": { "type_register": { "type": "integer", "description": "Record type | 4 - Adjustments", "format": "int32" }, "marketplace_subsellerid": { "type": "string", "description": "Marketplace own store code" }, "adjustment_origin": { "type": "string", "description": "- Origin of the listed adjustment: \r\nA : automatically generated by the system \r\nM : manually entered by the marketplace" }, "marketplace_schedule_id": { "type": "integer", "description": "NSU of scheduling in the MGM system", "format": "int64" }, "cpfcnpj_subseller": { "type": "string", "description": "CPF/CNPJ of the subseller" }, "adjustment_id": { "type": "integer", "description": "Adjustment ID", "format": "int32" }, "adjustment_type": { "type": "integer", "description": "Adjustment type \r\n1 'Credit Adjustment',\r\n2 'Debit Adjustment',\r\n3 'Electronic Statement Cancellation',\r\n4 'Electronic Statement Chargeback',\r\n5 'Negative Settlement Balance',\r\n6 'Credit for Expired Negative',\r\n7 'Debit for Expired Negative',\r\n8 'Credit Adjustment ST Advance',\r\n9 'Debit Adjustment ST Advance',\r\n10 'Card Flag Penalty',\r\n11 'Debit Adjustment Store Boleto Refund',\r\n12 'Debit Adjustment Marketplace Boleto Refund',\r\n13 'ChargeBack MDR Acquirer',\r\n14 'ChargeBack MDR Marketplace',\r\n15 'ChargeBack Marketplace Platform Fee'\r\n16 'Debit Adjustment GN Advance'\r\n17 'Credit Adjustment GN Advance'\r\n18 'Debit Adjustment IF Advance'\r\n19 'Debit Adjustment NF Advance'\r\n20 'Credit Adjustment IF Advance'\r\n21 'Credit Adjustment NF Advance'\r\n22 'Residual Balance Adjustment Advance'", "format": "int32" }, "adjustment_date": { "type": "string", "description": "Date of adjustment request", "format": "date-time" }, "adjustment_amount": { "type": "integer", "description": "Adjustment value in cents", "format": "int64" }, "subseller_rate_closing_date": { "type": "string", "description": "Instant of sending for payment of the amount", "format": "date-time" }, "payment_date": { "type": "string", "description": "Date calculated by the system for payment of the amount to the subseller", "format": "date-time" }, "transaction_sign": { "type": "string", "description": "'+' Credit , '-' Debit" }, "adjustment_reason": { "type": "string", "description": "Adjustment description" }, "order_id": { "type": "string", "description": "Order number (Num_Pedido) generated by the Marketplace" }, "product_id": { "type": "integer", "description": "Product code \r\n 1\tMASTERCARD,\r\n 2\tMAESTRO,\r\n 3\tVISA,\r\n 4\tVISA ELECTRON,\r\n 5\tAMEX,\r\n 11\tELO CREDIT,\r\n 12\tELO DEBIT,\r\n 13\tHYPER-HIPERCARD CREDIT\r\n 101 SANTANDER BOLETO", "format": "int32" }, "our_number": { "type": "string", "description": "Our Number field of the boleto" }, "nsu_boleto_adjustment": { "type": "string", "description": "NSU of the boleto refund" }, "reference_number": { "type": "integer", "description": "Payment reference number", "format": "int32" } }, "description": "Represents the adjustment block in the request response" }, "AnticipationDetailsViewModel": { "type": "object", "properties": { "seller_id": { "type": "string", "description": "Marketplace identifier.", "maxLength": 50 }, "subseller_id": { "type": "integer", "format": "int32", "description": "Store identifier." }, "request_channel": { "type": "string", "description": "Request channel:\r\nANT - Santander Automatic / \r\nCAC - Customer service center / \r\nIBK - Internet Banking / \r\nPOS - POS Terminal / \r\nUSE - Getnet loose advance system PAR / \r\nAUT - Getnet automatic advance system PAR / \r\nCIF - \"IF\" cessations held in the market / \r\nCNF - \"NIF\" cessations held in the market", "maxLength": 3 }, "legal_document_number": { "type": "string", "description": "Tax identifier of the commercial establishment. CNPJ (National Registry of Legal Entities) or CPF (Individual Registry).", "maxLength": 14 }, "total_effective_cost": { "type": "number", "format": "double", "description": "Effective Total Cost Rate - has 7 decimal places (Information returned in the Formalized file)." }, "gross_amount": { "type": "number", "format": "double", "description": "Gross value. Format: Decimal(13, 2) - two decimal places." }, "net_value": { "type": "number", "format": "double", "description": "Net value. Format: Decimal(13, 2) - two decimal places." }, "interest_rate": { "type": "number", "format": "double", "description": "Interest percentage. Format: Decimal(4, 7) - seven decimal places." }, "interest_value": { "type": "number", "format": "double", "description": "Interest value. Format: Decimal(13, 2) - two decimal places." }, "operation_rate": { "type": "number", "format": "double", "description": "Operation fee. Format: Decimal(13, 2) - two decimal places." }, "ioc_value": { "type": "number", "format": "double", "description": "IOC value. Format: Decimal(13, 2) - two decimal places." }, "average_term": { "type": "integer", "format": "int32", "description": "Average term of the operation." }, "request_date": { "type": "string", "description": "Request date." }, "bank_number": { "type": "string", "description": "Bank number.", "maxLength": 4 }, "agency": { "type": "string", "description": "Agency number.", "maxLength": 4 }, "account": { "type": "string", "description": "Account number.", "maxLength": 11 }, "account_type": { "type": "string", "description": "Account type of the bank domicile where the credit for the advance operation was made: \r\n\"CC\" (Checking Account) / \r\n\"CD\" (Deposit Account) / \r\n\"PG\" (Payment Account) / \r\n\"PP\" (Savings) / \r\nConditional: This field will be filled only in advance operations from the Getnet-Santander group (\"GN\" or \"ST\"), for operations originated in the market (\"IF\" or \"NF\"), this field will have no information.", "maxLength": 2 }, "negotiator_type": { "type": "string", "description": "Type of operation negotiator: \r\nIF - Financial institution / \r\nNF - Non-financial institution / \r\nST - Santander / \r\nGN - Getnet", "maxLength": 2 }, "negotiator_document_type": { "type": "string", "description": "Type of document of the transaction negotiator, which can be from \"Getnet\" itself (merchant advance), \"Santander\" (assignment advance) or any \"IF\" or \"NIF\" market participant.\r\nJ - CNPJ (Legal Entity) / \r\nF - CPF (Individual)", "maxLength": 1 }, "negotiator_document": { "type": "string", "description": "Document of the transaction negotiator (CNPJ).", "maxLength": 14 }, "negotiator_name": { "type": "string", "description": "Name of the transaction negotiator.", "maxLength": 50 }, "credit_date": { "type": "string", "description": "Credit date." }, "anticipation_status": { "type": "integer", "format": "int32", "description": "Advance status: \r\n1 – Requested / \r\n2 – Contracted / \r\n3 – Formalized - Bank Return / \r\n4 – Advance Update (underwent revocation or inclusion originated by the client) / \r\n5 – Rejected (Revocation)" } }, "description": "Advance Details." }, "BalanceBankInfoDetailsViewModel": { "type": "object", "properties": { "origin": { "type": "integer", "format": "int32", "description": "Origin: \r\n2 - SANTANDER" }, "bank_number": { "type": "string", "description": "Bank number", "maxLength": 4 }, "agency": { "type": "string", "description": "Branch number", "maxLength": 4 }, "account": { "type": "string", "description": "Account number", "maxLength": 11 }, "bank_name": { "type": "string", "description": "Bank name", "maxLength": 20 }, "client_id": { "type": "string", "description": "Customer identification at domicile/CNPJ. At SANTANDER it refers to PENUMPER", "maxLength": 11 }, "balances_amount": { "type": "integer", "format": "int32", "description": "Total of returned balances" }, "balances": { "type": "array", "description": "Collection of balances grouped by banking domiciles", "items": { "$ref": "#/definitions/BalanceDetailsViewModel" } } }, "description": "Represents the banking domicile information related to balances." }, "BalanceDetailsViewModel": { "type": "object", "properties": { "brand_id": { "type": "string", "description": "Flag Identifier: \r\n999 – All flags\r\n003 – MASTER\r\n004 – VISA\r\n008 – ELO\r\n006 - AMEX\r\n021 – HIPER", "maxLength": 3 }, "value": { "type": "number", "format": "double", "description": "Gross value associated with the flag. Format: Decimal(13, 2) - two decimal places." } }, "description": "Represents balance detail information." }, "ChargebackViewModel": { "type": "object", "properties": { "type_register": { "type": "integer", "description": "Record type | 5 - Chargeback", "format": "int32" }, "marketplace_schedule_id": { "type": "integer", "description": "NSU of the scheduling in the MGM system", "format": "int64" }, "marketplace_subsellerid": { "type": "string", "description": "Marketplace own store code" }, "release_status": { "type": "string", "description": "Indicates whether the scheduling has already been released for payment Y/N" }, "merchand_id": { "type": "string", "description": "Commercial establishment code" }, "marketplace_transaction_id": { "type": "integer", "description": "NSU Marketplace Management", "format": "int64" }, "transaction_date": { "type": "string", "description": "Transaction Date/Time", "format": "date-time" }, "installment_date": { "type": "string", "description": "Date/Time of the installment represented", "format": "date-time" }, "subseller_rate_confirm_date": { "type": "string", "description": "Date of payment confirmation return from the bank", "format": "date-time" }, "chargeback_amount": { "type": "integer", "description": "Installment value in cents.", "format": "int64" }, "transaction_sign": { "type": "string", "description": "'+' Credit , '-' Debit" }, "adjustment_id": { "type": "integer", "description": "Adjustment Id", "format": "int32" }, "adjustment_type": { "type": "integer", "description": "Adjustment Type \r\n1 'Credit Adjustment',\r\n2 'Debit Adjustment',\r\n3 'Electronic Statement Cancellation',\r\n4 'Electronic Statement Chargeback',\r\n5 'Negative Settlement Balance',\r\n6 'Credit for Expired Negative',\r\n7 'Debit for Expired Negative',\r\n8 'Credit Adjustment ST Advance',\r\n9 'Debit Adjustment ST Advance',\r\n10 'Flag Fine',\r\n11 'Debit Adjustment Store Boleto Reversal',\r\n12 'Debit Adjustment Marketplace Boleto Reversal',\r\n13 'Acquirer MDR ChargeBack',\r\n14 'Marketplace MDR ChargeBack',\r\n15 'Marketplace Platform Fee ChargeBack'\r\n16 'GN Advance Debit Adjustment'\r\n17 'GN Advance Credit Adjustment'\r\n18 'IF Advance Debit Adjustment'\r\n19 'NF Advance Debit Adjustment'\r\n20 'IF Advance Credit Adjustment'\r\n21 'NF Advance Credit Adjustment'\r\n22 'Residual Balance Adjustment Advance'", "format": "int32" }, "adjustment_date": { "type": "string", "description": "Date of adjustment request", "format": "date-time" }, "adjustment_amount": { "type": "integer", "description": "Adjustment value in cents", "format": "int64" }, "adjustment_origin": { "type": "string", "description": "- Origin of the listed adjustment: \r\nA : generated automatically by the system \r\nM : manually inserted by the marketplace" }, "adjustment_reason": { "type": "string", "description": "Adjustment Description" }, "acquirer_transaction_id": { "type": "string", "description": "Acquirer transaction code." }, "card_payment_amount": { "type": "integer", "description": "Card transaction value in cents", "format": "int64" }, "marketplace_original_transaction_id": { "type": "integer", "description": "Original NSU Marketplace Management (Only for Cancellation/Chargeback)", "format": "int64" }, "transaction_status_code": { "type": "integer", "description": "Transaction Status Code\r\n 0\tApproved ,\r\n70\tAwaiting,\r\n77\tPending,\r\n78\tPending Payment,\r\n83\tTimeout,\r\n86\tUndone,\r\n90\tNonexistent,\r\n91\tDenied - Administrator,\r\n92\tReversed,\r\n93\tRepeated,\r\n94\tReversal Reconciliation,\r\n98\tCanceled - Without Confirmation,\r\n99\tDenied - MGM,", "format": "int32" }, "terminal_nsu": { "type": "string", "description": "Authorization code generated by the Issuer when the transaction is completed successfully." }, "reason_message": { "type": "string", "description": "Return message from the flag" }, "authorization_code": { "type": "string", "description": "Flag authorization code" }, "order_id": { "type": "string", "description": "Order number" }, "vlr_mdr_marketplace": { "type": "integer", "description": "VALUE IN CENTS OF MARKETPLACE MDR", "format": "int64" }, "vlr_fee": { "type": "integer", "description": "VALUE IN CENTS OF PLATFORM FEE", "format": "int64" }, "vlr_somaMdrFee": { "type": "integer", "description": "VALUE IN CENTS OF MARKETPLACE MDR + PLATFORM FEE SUM", "format": "int64", "readOnly": true }, "perc_mdr_marketplace": { "type": "number", "description": "PERCENTAGE VALUE IN CENTS OF MARKETPLACE MDR", "format": "double" }, "perc_fee": { "type": "number", "description": "PERCENTAGE VALUE IN CENTS OF PLATFORM FEE", "format": "double" }, "perc_somaMdrFee": { "type": "number", "description": "PERCENTAGE VALUE IN CENTS OF MARKETPLACE MDR + PLATFORM FEE SUM", "format": "double", "readOnly": true }, "product_id": { "type": "integer", "description": "Product Code \r\n1\tMASTERCARD,\r\n2\tMAESTRO,\r\n3\tVISA,\r\n4\tVISA ELECTRON,\r\n5\tAMEX,\r\n11\tELO CREDIT,\r\n12\tELO DEBIT,\r\n13\tHYPER-HIPERCARD CREDIT\r\n101\tSANTANDER BOLETO", "format": "int32" }, "reference_number": { "type": "integer", "description": "Payment reference number", "format": "int32" } }, "description": "Represents the chargeback block in the request response" }, "CommissionViewModel": { "type": "object", "properties": { "type_register": { "type": "integer", "description": "Record type | 3 - Commission", "format": "int32" }, "list_transactions": { "type": "string", "description": "Marketplace Id (SellerId)" }, "marketplace_schedule_id": { "type": "integer", "description": "NSU of the scheduling in the MGM system", "format": "int64" }, "marketplace_subsellerid": { "type": "string", "description": "Marketplace own store code" }, "marketplace_transaction_id": { "type": "integer", "description": "NSU Marketplace Management", "format": "int64" }, "transaction_date": { "type": "string", "description": "Transaction Date/Time", "format": "date-time" }, "confirmation_date": { "type": "string", "description": "Transaction Confirmation Date/Time", "format": "date-time" }, "item_id": { "type": "string", "description": "Product code received in the order" }, "number_installments": { "type": "integer", "description": "Number of scheduled installments", "format": "int32" }, "installment": { "type": "integer", "description": "Current installment number represented", "format": "int32" }, "installment_date": { "type": "string", "description": "Date/Time of the installment represented", "format": "date-time" }, "installment_amount": { "type": "integer", "description": "Installment value in cents.", "format": "int64" }, "subseller_rate_amount": { "type": "integer", "description": "Commission value for the subseller (own store) in cents", "format": "int64" }, "subseller_rate_percentage": { "type": "number", "description": "Subseller commission percentage calculated by the system", "format": "double" }, "mdr_rate_ammount": { "type": "integer", "description": "Value in cents of the MDR rate charged from the seller", "format": "int64" }, "mdr_rate_percentage": { "type": "number", "description": "Percentage of the MDR rate charged from the seller", "format": "double" }, "payment_date": { "type": "string", "description": "Payment date requested in the confirmation", "format": "date-time" }, "subseller_rate_closing_date": { "type": "string", "description": "Instant of sending the store amount for payment", "format": "date-time" }, "cancel_custom_key": { "type": "string", "description": "Client key used to identify a cancellation request." }, "cancel_request_id": { "type": "string", "description": "Cancellation request identifier." }, "transaction_sign": { "type": "string", "description": "'+' Credit , '-' Debit" }, "item_id_mgm": { "type": "string", "description": "Order item Id (Seql_PedidoItem)" }, "payment_id": { "type": "string", "description": "Payment identification code", "format": "uuid" }, "payment_tag": { "type": "string", "description": "Tag to identify parts of item payment split across more than one card" }, "item_split_tag": { "type": "string", "description": "Tag to identify parts of the item among the items in the list" }, "payment_plan_name": { "type": "string", "description": "Payment plan name" }, "reference_number": { "type": "integer", "description": "Payment reference number", "format": "int32" } }, "description": "Represents the commission block in the request response" }, "ContentBalancesViewModel": { "type": "object", "properties": { "bank_info_amount": { "type": "integer", "format": "int32", "description": "Total banking domiciles returned." }, "bank_info_collection": { "type": "array", "description": "Collection of banking domiciles of available balances for advance. Maximum quantity: 50 occurrences.", "items": { "$ref": "#/definitions/BalanceBankInfoDetailsViewModel" } } }, "description": "Response for the request to consult available balances for advance." }, "ContentFormalizationViewModel": { "type": "object", "properties": { "operation_number": { "type": "string", "description": "Operation number.", "maxLength": 15 }, "operation_date": { "type": "string", "description": "Operation date.", "maxLength": 10 }, "average_term": { "type": "integer", "format": "int32", "description": "Average term" }, "last_due_date": { "type": "string", "description": "Last maturity. Format: YYYY-MM-DD", "maxLength": 10 }, "operation_rate": { "type": "number", "format": "double", "description": "Operation fee. Format: Decimal(13, 2) - two decimal places." }, "interest_rate": { "type": "number", "format": "double", "description": "Interest percentage. Format: Decimal(4, 7) - seven decimal places." }, "interest_value": { "type": "number", "format": "double", "description": "Interest value. Format: Decimal(13, 2) - two decimal places." }, "ioc_value": { "type": "number", "format": "double", "description": "IOC value. Format: Decimal(13, 2) - two decimal places." }, "gross_amount": { "type": "number", "format": "double", "description": "Gross value. Format: Decimal(13, 2) - two decimal places." }, "net_value": { "type": "number", "format": "double", "description": "Net value. Format: Decimal(13, 2) - two decimal places." } }, "description": "Response for the operation formalization request." }, "ContentReceivablesUnitsViewModel": { "type": "object", "properties": { "origin": { "type": "integer", "format": "int32", "description": "Origin: \r\n2 - SANTANDER" }, "getkey": { "type": "string", "description": "Query identifier", "maxLength": 15 }, "receivables_units_amount": { "type": "integer", "format": "int32", "description": "Total RUs returned" }, "receivables_units": { "type": "array", "description": "Receivable units", "items": { "$ref": "#/definitions/ReceivableUnitDetailsViewModel" } } }, "description": "Response for the query of receivable units." }, "ContentSearchViewModel": { "type": "object", "properties": { "records": { "type": "array", "description": "Collection of records related to advances.", "items": { "$ref": "#/definitions/RecordDataViewModel" } } }, "description": "Response for advance search." }, "ContentSimulationViewModel": { "type": "object", "properties": { "simulation_number": { "type": "string", "description": "Simulation number", "maxLength": 15 }, "simulation_date": { "type": "string", "description": "Simulation date. Format: YYYY-MM-DD", "maxLength": 10 }, "average_term": { "type": "integer", "format": "int32", "description": "Average term" }, "last_due_date": { "type": "string", "description": "Last maturity. Format: YYYY-MM-DD", "maxLength": 10 }, "operation_rate": { "type": "number", "format": "double", "description": "Operation fee. Format: Decimal(13, 2) - two decimal places." }, "interest_rate": { "type": "number", "format": "double", "description": "Interest percentage. Format: Decimal(4, 7) - seven decimal places." }, "interest_value": { "type": "number", "format": "double", "description": "Interest value. Format: Decimal(13, 2) - two decimal places." }, "ioc_value": { "type": "number", "format": "double", "description": "IOC value. Format: Decimal(13, 2) - two decimal places." }, "gross_amount": { "type": "number", "format": "double", "description": "Gross value. Format: Decimal(13, 2) - two decimal places." }, "net_value": { "type": "number", "format": "double", "description": "Net value. Format: Decimal(13, 2) - two decimal places." } }, "description": "Response for the simulation request." }, "ExtractStatusViewModel": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Boolean of success in execution" }, "status_code": { "maxLength": 4, "type": "string", "description": "Execution status code", "readOnly": true }, "message": { "maxLength": 128, "type": "string", "description": "Message associated with the status_code field.", "readOnly": true } }, "description": "Error class" }, "NotPaginatedExtractResponseViewModel": { "type": "object", "description": "Class for response of unpaginated electronic statement request", "properties": { "list_transactions": { "type": "array", "description": "Collection of transactions", "items": { "$ref": "#/definitions/TransactionViewModel" } }, "commissions": { "type": "array", "description": "Collection of commissions", "items": { "$ref": "#/definitions/CommissionViewModel" } }, "adjustments": { "type": "array", "description": "Collection of adjustments", "items": { "$ref": "#/definitions/AdjustmentViewModel" } }, "chargeback": { "type": "array", "description": "Collection of chargebacks", "items": { "$ref": "#/definitions/ChargebackViewModel" } }, "payment_summaries": { "type": "array", "description": "Collection of payment summaries.", "items": { "$ref": "#/definitions/PaymentSummaryViewModel" } }, "status": { "$ref": "#/definitions/ExtractStatusViewModel" } } }, "PaginatedExtractResponseViewModel": { "type": "object", "properties": { "list_transactions": { "type": "array", "description": "Collection of transactions", "items": { "$ref": "#/definitions/TransactionViewModel" } }, "commissions": { "type": "array", "description": "Collection of commissions", "items": { "$ref": "#/definitions/CommissionViewModel" } }, "adjustments": { "type": "array", "description": "Collection of adjustments", "items": { "$ref": "#/definitions/AdjustmentViewModel" } }, "chargeback": { "type": "array", "description": "Collection of chargebacks", "items": { "$ref": "#/definitions/ChargebackViewModel" } }, "payment_summaries": { "type": "array", "description": "Collection of payment summaries.", "items": { "$ref": "#/definitions/PaymentSummaryViewModel" } }, "status": { "$ref": "#/definitions/ExtractStatusViewModel" }, "page_amount": { "type": "integer", "description": "Number of pages in the paginated query", "format": "int32", "readOnly": true } }, "description": "Represents the response of the paginated electronic statement request" }, "PaymentSummaryViewModel": { "type": "object", "properties": { "type_register": { "type": "integer", "description": "Record type | 7 - Summary of payment for free RUs and those with liens", "format": "int32" }, "marketplace_schedule_id": { "type": "integer", "description": "NSU of the scheduling in the MGM system", "format": "int64" }, "cpfcnpj_subseller": { "type": "string", "description": "CPF/CNPJ of the subseller" }, "subseller_id": { "type": "integer", "description": "Store code", "format": "int32" }, "marketplace_subsellerid": { "type": "string", "description": "Marketplace own store code" }, "amount_paid": { "type": "integer", "description": "Amount paid in cents", "format": "int64" }, "contract_number": { "type": "integer", "description": "Contract number of the lien operation", "format": "int64" }, "operation_identifier_code": { "type": "string", "description": "Operation identification code" }, "nu_liquid": { "type": "string", "description": "NuLiquid code - reference field in the CIP return" }, "account_type": { "type": "string", "description": "Banking Domicile - Account type: \r\nC:\tCurrent Account\r\nG: Payment Account\r\nP: Savings Account" }, "beneficiary_document_number": { "type": "string", "description": "CPF/CNPJ of the payment recipient" }, "bank": { "type": "string", "description": "Banking Domicile - Bank" }, "agency": { "type": "string", "description": "Banking Domicile - Branch with digit" }, "account_number": { "type": "string", "description": "Banking Domicile - Account number with digit" }, "subseller_rate_confirm_date": { "type": "string", "description": "Date received in the 2nd CIP return file with confirmation of payment to be made by the Bank", "format": "date-time" }, "operation_type": { "type": "string", "description": "Type of negotiated operation" }, "reference_number": { "type": "integer", "description": "Payment reference number", "format": "int32" } }, "description": "Represents the payment summary block" }, "ExtractResponse": { "type": "object", "properties": { "list_transactions": { "type": "array", "items": { "$ref": "#/definitions/Transaction" }, "description": "Collection of transactions" }, "commissions": { "type": "array", "items": { "$ref": "#/definitions/Commission" }, "description": "Collection of commissions" }, "adjustments": { "type": "array", "items": { "$ref": "#/definitions/Adjustment" }, "description": "Collection of adjustments" }, "chargeback": { "type": "array", "items": { "$ref": "#/definitions/Chargeback" }, "description": "Collection of chargebacks" }, "payment_summaries": { "type": "array", "items": { "$ref": "#/definitions/PaymentSummary" }, "description": "Collection of payment summaries" }, "status": { "$ref": "#/definitions/ExtractStatus" } }, "description": "Statement content" }, "ExtractResponseV4": { "type": "object", "properties": { "transactions": { "type": "array", "items": { "$ref": "#/definitions/TransactionV4" }, "description": "Collection of transactions" }, "commissions": { "type": "array", "items": { "$ref": "#/definitions/CommissionV4" }, "description": "Collection of commissions" }, "adjustments": { "type": "array", "items": { "$ref": "#/definitions/AdjustmentV4" }, "description": "Collection of adjustments" }, "chargeback": { "type": "array", "items": { "$ref": "#/definitions/ChargebackV4" }, "description": "Collection of chargebacks" }, "status": { "$ref": "#/definitions/ExtractStatusV4" }, "page_amount": { "type": "integer", "description": "Number of pages in the paginated query", "format": "int32" } }, "description": "Statement content" }, "ExtractPaginatedResponse": { "type": "object", "properties": { "list_transactions": { "type": "array", "items": { "$ref": "#/definitions/Transaction" }, "description": "Collection of transactions" }, "commissions": { "type": "array", "items": { "$ref": "#/definitions/Commission" }, "description": "Collection of commissions" }, "adjustments": { "type": "array", "items": { "$ref": "#/definitions/Adjustment" }, "description": "Collection of adjustments" }, "chargeback": { "type": "array", "items": { "$ref": "#/definitions/Chargeback" }, "description": "Collection of chargebacks" }, "payment_summaries": { "type": "array", "items": { "$ref": "#/definitions/PaymentSummary" }, "description": "Collection of payment summaries" }, "status": { "$ref": "#/definitions/ExtractStatus" }, "page_amount": { "type": "integer", "description": "Number of pages in the paginated query", "format": "int32" } }, "description": "Statement content" }, "ExtractResponseStatus": { "type": "object", "properties": { "status": { "$ref": "#/definitions/ExtractStatus" } }, "description": "Status of a failed request." }, "Adjustment": { "type": "object", "properties": { "type_register": { "type": "integer", "description": "Record type | 4 - Adjustments", "format": "int32" }, "marketplace_subsellerid": { "type": "string", "description": "Own store code of the Anchor" }, "subseller_id": { "type": "integer", "description": "Store id", "format": "int32" }, "adjustment_origin": { "type": "string", "description": "Origin of the listed adjustment:\r\n\r\nA: generated automatically by the system \r\n\r\nM: manually inserted by the Anchor via adjustments API" }, "marketplace_schedule_id": { "type": "integer", "description": "Unique sequential number that represents the transaction scheduling", "format": "int64" }, "cpfcnpj_subseller": { "type": "string", "description": "CPF/CNPJ of the partner or own store" }, "adjustment_id": { "type": "integer", "description": "Adjustment identifier generated by Payment Split", "format": "int32" }, "adjustment_type": { "type": "integer", "description": "Adjustment Type:\r\n\r\n1 Credit Adjustment,\r\n \r\n2 Debit Adjustment,\r\n \r\n5 Negative Settlement Balance,\r\n \r\n6 Credit for Expired Negative,\r\n \r\n7 Debit for Expired Negative,\r\n \r\n8 Credit Adjustment ST Advance,\r\n \r\n9 Debit Adjustment ST Advance,\r\n \r\n10 Flag Fine,\r\n \r\n11 Debit Adjustment Store Boleto Reversal,\r\n \r\n12 Debit Adjustment Anchor Own Store Boleto Reversal,\r\n \r\n18 Debit Adjustment for IF Advance Assignment,\r\n \r\n19 Debit Adjustment for NF Advance Assignment,\r\n\r\n20 Credit Adjustment for IF Advance Assignment,\r\n\r\n21 Credit Adjustment for NF Advance Assignment", "format": "int32" }, "adjustment_date": { "type": "string", "description": "Date of adjustment creation", "format": "date-time" }, "adjustment_amount": { "type": "integer", "description": "Adjustment value in cents", "format": "int64" }, "subseller_rate_closing_date": { "type": "string", "description": "Date when the adjustment was compensated and sent for payment at Núclea", "format": "date-time" }, "payment_date": { "type": "string", "description": "Date calculated by the system for adjustment compensation", "format": "date-time" }, "transaction_sign": { "type": "string", "description": "'+' Credit\r\n\r\n'-' Debit" }, "adjustment_reason": { "type": "string", "description": "Adjustment description" }, "order_id": { "type": "string", "description": "Order number generated by the Anchor" }, "product_id": { "type": "integer", "description": "Product Code:\r\n\r\n1\tMASTERCARD,\r\n\r\n2\tMAESTRO,\r\n\r\n3\tVISA,\r\n\r\n4\tVISA ELECTRON,\r\n\r\n5\tAMEX,\r\n\r\n11\tELO CREDIT,\r\n\r\n12\tELO DEBIT,\r\n\r\n13\tHYPER-HIPERCARD CREDIT,\r\n\r\n101 SANTANDER BOLETO", "format": "int32" }, "our_number": { "type": "string", "description": "Our boleto number generated by Santander bank at the time of boleto generation" }, "nsu_boleto_adjustment": { "type": "string", "description": "Adjustment identification for boleto return" }, "operation_identifier_code": { "type": "string", "description": "Operation identification code" }, "reference_number": { "type": "integer", "description": "Payment reference number, it is unique and generated after balance compensation in the settlement process", "format": "int32" }, "subsellerid_ext": { "type": "string", "description": "External store code" } }, "description": "Adjustments" }, "Chargeback": { "type": "object", "properties": { "type_register": { "type": "integer", "description": "Record type | 5 - Chargeback", "format": "int32" }, "marketplace_schedule_id": { "type": "integer", "description": "Unique sequential number that represents the transaction scheduling", "format": "int64" }, "marketplace_subsellerid": { "type": "string", "description": "Own store code of the Anchor" }, "release_status": { "type": "string", "description": "Indicates whether the scheduling has already been released for payment:\r\n\r\nY - Yes\r\n\r\nN - No" }, "merchand_id": { "type": "string", "description": "Anchor establishment code" }, "transaction_date": { "type": "string", "description": "Date/Time of transaction creation", "format": "date-time" }, "installment_date": { "type": "string", "description": "Date/Time of the installment represented", "format": "date-time" }, "chargeback_amount": { "type": "integer", "description": "Installment value in cents", "format": "int64" }, "transaction_sign": { "type": "string", "description": "'+' Credit\r\n\r\n'-' Debit" }, "adjustment_id": { "type": "integer", "description": "Chargeback adjustment identifier generated by Payment Split", "format": "int32" }, "adjustment_type": { "type": "integer", "description": "Adjustment Type:\r\n\r\n4 - Chargeback Debit\r\n\r\n25 - Chargeback Reversal Credit", "format": "int32" }, "adjustment_date": { "type": "string", "description": "Date of Chargeback adjustment creation", "format": "date-time" }, "adjustment_amount": { "type": "integer", "description": "Adjustment value in cents", "format": "int64" }, "adjustment_origin": { "type": "string", "description": "Origin of the listed adjustment: \r\n\r\nA - generated automatically by the system" }, "adjustment_reason": { "type": "string", "description": "Adjustment Description" }, "acquirer_transaction_id": { "type": "string", "description": "Transaction identification number generated by the acquirer" }, "card_payment_amount": { "type": "integer", "description": "Original transaction value in cents", "format": "int64" }, "marketplace_original_transaction_id": { "type": "integer", "description": "Original transaction identification number generated by payment split. Filled only for chargeback adjustments.", "format": "int64" }, "transaction_status_code": { "type": "integer", "description": "Original transaction status code\r\n\r\n0 - Approved", "format": "int32" }, "terminal_nsu": { "type": "string", "description": "Authorization code of the original transaction generated by the issuer" }, "reason_message": { "type": "string", "description": "Return message from the flag" }, "authorization_code": { "type": "string", "description": "Credit authorization code" }, "order_id": { "type": "string", "description": "Order number generated by the Anchor" }, "vlr_mdr_marketplace": { "type": "number", "description": "Value in cents of MDR refund charged by Payment Split for chargeback debits or execution of a new MDR charge when it is a chargeback reversal", "format": "double" }, "vlr_fee": { "type": "number", "description": "Value in cents of FEE refund charged by Payment Split for chargeback debits or execution of a new FEE charge when it is a chargeback reversal", "format": "double" }, "vlr_somaMdrFee": { "type": "number", "description": "Value in cents of platform MDR + FEE sum", "format": "double" }, "perc_mdr_marketplace": { "type": "number", "description": "Percentage value in cents of MDR charged by Payment Split", "format": "double" }, "perc_fee": { "type": "number", "description": "Percentage value in cents of platform FEE charged by Payment Split", "format": "double" }, "perc_somaMdrFee": { "type": "number", "description": "Percentage value in cents of platform MDR + FEE sum", "format": "double" }, "product_id": { "type": "integer", "description": "Product code:\r\n\r\n1\tMASTERCARD,\r\n\r\n2\tMAESTRO,\r\n\r\n3\tVISA,\r\n\r\n4\tVISA ELECTRON,\r\n\r\n5\tAMEX,\r\n\r\n11\tELO CREDIT,\r\n\r\n12\tELO DEBIT,\r\n\r\n13\tHYPER-HIPERCARD CREDIT\r\n\r\n101\tSANTANDER BOLETO", "format": "int32" }, "payment_id": { "type": "string", "description": "Original transaction identifier sent or generated at the time of transaction creation" }, "reference_number": { "type": "integer", "description": "Payment reference number, it is unique and generated after balance compensation in the settlement process", "format": "int32" } }, "description": "Chargeback" }, "Commission": { "type": "object", "properties": { "type_register": { "type": "integer", "description": "Record type | 3 - Commission", "format": "int32" }, "marketplace_schedule_id": { "type": "integer", "description": "Unique sequential number that represents the transaction scheduling", "format": "int64" }, "marketplace_subsellerid": { "type": "string", "description": "Own store code of the Anchor" }, "marketplace_transaction_id": { "type": "integer", "description": "Transaction identification number generated by payment split", "format": "int64" }, "transaction_date": { "type": "string", "description": "Date/Time of transaction creation", "format": "date-time" }, "confirmation_date": { "type": "string", "description": "Date/Time of transaction confirmation", "format": "date-time" }, "item_id": { "type": "string", "description": "Product code received in the order generated by the Anchor" }, "number_installments": { "type": "integer", "description": "Total number of transaction installments scheduled", "format": "int32" }, "installment": { "type": "integer", "description": "Current installment number represented. In the case of RecebaJá plan, the total installment number is presented. Example: 12 installments of 12 Installments", "format": "int32" }, "installment_date": { "type": "string", "description": "Date/Time of the installment represented", "format": "date-time" }, "installment_amount": { "type": "integer", "description": "Installment value in cents.", "format": "int64" }, "subseller_id": { "type": "integer", "description": "Store id", "format": "int32" }, "subseller_rate_amount": { "type": "integer", "description": "Commission value for the Anchor own store in cents. Net value that the Anchor will receive. This field should consider the transaction sign.", "format": "int64" }, "subseller_rate_percentage": { "type": "number", "description": "Percentage applied to the Anchor commission", "format": "double" }, "mdr_rate_amount": { "type": "integer", "description": "Value in cents of the MDR rate (Merchant Discount Rate) charged from the Anchor", "format": "int64" }, "mdr_rate_percentage": { "type": "number", "description": "Percentage of the MDR rate (Merchant Discount Rate) charged from the Anchor", "format": "double" }, "payment_date": { "type": "string", "description": "Date calculated by the system for commission payment. \r\nThis date can be changed at the time of payment release of the partner item if the Anchor is configured as 'Awaits Release for payment of products and commission'.", "format": "date-time" }, "subseller_rate_closing_date": { "type": "string", "description": "Date when the commission was compensated and sent for payment at Núclea.", "format": "date-time" }, "cancel_custom_key": { "type": "string", "description": "Client key used to identify a cancellation request." }, "cancel_request_id": { "type": "string", "description": "Cancellation request identifier" }, "transaction_sign": { "type": "string", "description": "'+' Credit\r\n\r\n'-' Debit" }, "item_id_mgm": { "type": "string", "description": "Item sequential generated by Payment Split" }, "payment_id": { "type": "string", "description": "Transaction identifier sent or generated at the time of transaction creation", "format": "uuid" }, "payment_tag": { "type": "string", "description": "Tag to identify parts of item payment whose sale was split across more than one card" }, "item_split_tag": { "type": "string", "description": "Tag to identify parts of the item among the items in the list" }, "payment_plan_name": { "type": "string", "description": "Payment plan name. Example: RecebaJá 10 days" }, "reference_number": { "type": "integer", "description": "Payment reference number, it is unique and generated after balance compensation in the settlement process", "format": "int32" }, "subsellerid_ext": { "type": "string", "description": "External store code" } }, "description": "Represents the commission block" }, "ExtractError": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code" }, "message": { "type": "string", "description": "Error message" } }, "description": "Represents error information" }, "ExtractStatus": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Boolean indicating successful execution" }, "status_code": { "maxLength": 4, "type": "string", "description": "Execution status code" }, "message": { "maxLength": 128, "type": "string", "description": "Message associated with the StatusCode field." }, "errors": { "type": "array", "items": { "$ref": "#/definitions/ExtractError" }, "description": "Collection of possible request or processing errors." } }, "description": "Error class" }, "PaymentSummary": { "type": "object", "properties": { "type_register": { "type": "integer", "description": "Record type | 7 - Summary of payment of free and encumbered URs", "format": "int32" }, "cpfcnpj_subseller": { "type": "string", "description": "CPF/CNPJ of partner registered below the Anchor" }, "subseller_id": { "type": "integer", "description": "Partner code generated by Payment Split", "format": "int32" }, "marketplace_subsellerid": { "type": "string", "description": "Anchor's own store code" }, "amount_paid": { "type": "integer", "description": "Amount paid in cents", "format": "int64" }, "contract_number": { "type": "integer", "description": "Contract number of the encumbrance operation", "format": "int64" }, "nu_liquid": { "type": "string", "description": "Settlement identification code generated by Núclea" }, "account_type": { "type": "string", "description": "Account type:\r\n\r\nC:\tChecking Account\r\n\r\nG: Payment Account\r\n\r\nP: Savings Account" }, "beneficiary_document_number": { "type": "string", "description": "CPF/CNPJ of payment recipient" }, "bank": { "type": "string", "description": "Bank of payment recipient" }, "agency": { "type": "string", "description": "Agency of payment recipient" }, "account_number": { "type": "string", "description": "Account number with digit of payment recipient" }, "subseller_rate_confirm_date": { "type": "string", "description": "Date of payment confirmation that the bank responded to GETNET", "format": "date-time" }, "operation_type": { "type": "string", "description": "Type of transaction negotiated:\r\n\r\nFree UR settlement\r\n\r\nEncumbered UR settlement\r\n\r\nAssignment settlement" }, "product_id": { "type": "string", "description": "Last flag cleared which the payment was made" }, "reference_number": { "type": "integer", "description": "Payment reference number, unique and generated after balance compensation of the settlement process", "format": "int32" } }, "description": "Represents the payment summary block" }, "Transaction": { "type": "object", "properties": { "summary": { "$ref": "#/definitions/TransactionSummary" }, "details": { "type": "array", "items": { "$ref": "#/definitions/TransactionDetails" }, "description": "Transaction Detail" } }, "description": "Represents the transaction block" }, "TransactionDetails": { "type": "object", "properties": { "type_register": { "type": "integer", "description": "Record type | 2 - Transaction detail", "format": "int32" }, "marketplace_schedule_id": { "type": "integer", "description": "Unique sequential number representing transaction scheduling", "format": "int64" }, "marketplace_subsellerid": { "type": "string", "description": "Anchor's own store code (subsellerid)" }, "release_status": { "type": "string", "description": "Indicates if scheduling has already been released for payment \r\n\r\nY - Yes\r\n\r\nN - No" }, "cpfcnpj_subseller": { "type": "string", "description": "CPF/CNPJ of partner registered below the Anchor" }, "cancel_custom_key": { "type": "string", "description": "Client key used to identify a cancellation request" }, "cancel_request_id": { "type": "string", "description": "Cancellation request identifier" }, "marketplace_transaction_id": { "type": "integer", "description": "Transaction identification number generated by payment split", "format": "int64" }, "transaction_date": { "type": "string", "description": "Transaction creation date/time", "format": "date-time" }, "confirmation_date": { "type": "string", "description": "Transaction confirmation date/time", "format": "date-time" }, "item_id": { "type": "string", "description": "Product code received in order generated by Anchor" }, "number_installments": { "type": "integer", "description": "Total number of installments of the transaction", "format": "int32" }, "installment": { "type": "integer", "description": "Current installment number represented. In case of RecebaJá plan, the total installment number is displayed. Example: 12 installments of 12 Installments.", "format": "int32" }, "installment_date": { "type": "string", "description": "Date/time of the represented installment", "format": "date-time" }, "installment_amount": { "type": "integer", "description": "Installment amount in cents", "format": "int64" }, "subseller_rate_amount": { "type": "integer", "description": "Amount passed to partner in cents", "format": "int64" }, "subseller_rate_percentage": { "type": "number", "description": "Percentage charged by Anchor on partner's item", "format": "double" }, "payment_date": { "type": "string", "description": "Date calculated by the system for payment of value to partner. This date can be changed at the time of item payment release.", "format": "date-time" }, "subseller_rate_closing_date": { "type": "string", "description": "Date when the item was compensated and sent for payment at Núclea. In case of PIX, payment is made directly by Santander bank.", "format": "date-time" }, "subseller_id": { "type": "integer", "description": "Partner code generated by Payment Split", "format": "int64" }, "seller_id": { "type": "string", "description": "Anchor access key (SellerId)" }, "transaction_sign": { "type": "string", "description": "'+' Credit\r\n\r\n'-' Debit" }, "item_id_mgm": { "type": "string", "description": "Item sequential generated by Payment Split" }, "payment_id": { "type": "string", "description": "Transaction identifier sent or generated at the time of transaction creation", "format": "uuid" }, "payment_tag": { "type": "string", "description": "Tag to identify payment parts of item whose sale was divided into more than one card" }, "item_split_tag": { "type": "string", "description": "Tag to identify item parts among list items" }, "payment_plan_name": { "type": "string", "description": "Name of payment plan. Example: RecebaJá 10 days" }, "boleto_id": { "type": "string", "description": "Boleto identification number", "format": "uuid" }, "our_number": { "type": "integer", "description": "Our boleto number generated by Santander bank at the time of boleto generation", "format": "int64" }, "boleto_payment_date": { "type": "string", "description": "Boleto payment date", "format": "date-time" }, "reference_number": { "type": "integer", "description": "Payment reference number, unique and generated after balance compensation of the settlement process", "format": "int32" }, "subsellerid_ext": { "type": "string", "description": "External store code" } }, "description": "Transaction details" }, "TransactionSummary": { "type": "object", "properties": { "type_register": { "type": "integer", "description": "Record type | 1 - Transaction summary", "format": "int32" }, "order_id": { "type": "string", "description": "Order number generated by anchor" }, "marketplace_subsellerid": { "type": "string", "description": "Anchor's own store code" }, "marketplace_transaction_id": { "type": "integer", "description": "Transaction identification number generated by payment split", "format": "int64" }, "transaction_date": { "type": "string", "description": "Transaction date/time", "format": "date-time" }, "confirmation_date": { "type": "string", "description": "Transaction confirmation date/time", "format": "date-time" }, "product_id": { "type": "integer", "description": "Product code:\r\n\r\n1 - MASTERCARD, \r\n\r\n2 - MAESTRO,\r\n \r\n3 - VISA,\r\n\r\n4 - VISA ELECTRON,\r\n\r\n5 - AMEX,\r\n\r\n11 - ELO CREDIT,\r\n\r\n12 - ELO DEBIT,\r\n\r\n13 - HIPER-HIPERCARD CREDIT,\r\n\r\n101 - BOLETO SANTANDER,\r\n\r\n14 - PIX", "format": "int32" }, "transaction_type": { "type": "integer", "description": "Transaction type:\r\n\r\n1 - Spot credit,\r\n\r\n2 - Store installment credit,\r\n\r\n3 - Administrator installment credit,\r\n\r\n4 - Debit,\r\n\r\n5 - Cancellation,\r\n\r\n7 - Boleto,\r\n\r\n8 - PIX", "format": "int32" }, "number_installments": { "type": "integer", "description": "Total number of installments", "format": "int32" }, "nsu_host": { "type": "string", "description": "Authorization code generated by issuer" }, "acquirer_transaction_id": { "type": "string", "description": "Transaction identification number generated by acquirer" }, "card_payment_amount": { "type": "integer", "description": "Transaction value in cents", "format": "int64" }, "sum_details_card_payment_amount": { "type": "integer", "description": "Sum of listed value in details in cents listed in type 2 records", "format": "int64" }, "marketplace_original_transaction_id": { "type": "integer", "description": "Original transaction identification number generated by payment split. Filled only for cancellation transactions.", "format": "int64" }, "transaction_status_code": { "type": "integer", "description": "Transaction status code\r\n 0\tApproved ,\r\n \r\n70\tAwaiting,\r\n\r\n77\tPending,\r\n\r\n78 Pending Payment,\r\n\r\n83\tTimeout,\r\n\r\n86\tUndone,\r\n\r\n90\tNon-existent,\r\n\r\n91\tDenied - Administrator,\r\n\r\n92\tReversed,\r\n\r\n93\tDuplicate,\r\n\r\n94\tReversed Reconciliation,\r\n\r\n98\tCancelled - No Confirmation,\r\n\r\n99\tDenied - MGM", "format": "int32" }, "transaction_sign": { "type": "string", "description": "'+' Credit\r\n\r\n'-' Debit" }, "terminal_nsu": { "type": "string", "description": "Transaction identification number generated by terminal" }, "reason_message": { "type": "string", "description": "Transaction status return message" }, "authorization_code": { "type": "string", "description": "Credit authorization code" }, "payment_id": { "type": "string", "description": "Transaction identifier sent or generated at the time of transaction creation", "format": "uuid" }, "terminal_identification": { "type": "string", "description": "Terminal identification number" }, "nsu_tef": { "type": "string", "description": "Transaction identification number generated by physical terminal" }, "entry_mode": { "type": "string", "description": "Transaction mode identification \r\n\r\n001\tCollected through batch processing\r\n\r\n011\tCard entered manually\r\n\r\n021\tCard read\r\n\r\n051\tCard ICC EMV\r\n\r\n071\tContactless card with EMV data\r\n\r\n091\tContactless card with magnetic stripe\r\n\r\n801\tMagnetic fallback of ICC card\r\n\r\n810\tE-commerce" }, "transaction_channel": { "type": "string", "description": "Transaction entry channel\r\n\r\n1\tDigital (E-COMMERCE) \r\n\r\n2\tPhysical (POS and TEF)\r\n///" }, "capture": { "type": "string", "description": "Transaction entry technology\r\n\r\n10\tPOS\r\n\r\n13\tVERMELHINHA\r\n\r\n15\tMODEM\r\n\r\n20\tDialed TEF\r\n\r\n30\tDedicated TEF\r\n\r\n35\tWEB RECARGA\r\n\r\n40\tPIN PAD\r\n\r\n45\tE-COMMERCE\r\n\r\n50\tURA\r\n\r\n55\tWEB TOPAZIO\r\n\r\n60\tEASY GOOD\r\n\r\n63\tIATA\r\n\r\n65\tFILE EXCHANGE\r\n\r\n70\tMOBILE\r\n\r\n71\tMOBILE GETNET\r\n\r\n74\tSUPERGET MOBILE\r\n\r\n75\tCHIP\r\n\r\n80\tREADER\r\n\r\n90\tREADER AC\r\n\r\n95\tATM\r\n\r\n97\tTHIRD PARTY EQUIPMENT" }, "payment_tag": { "type": "string", "description": "Tag to identify payment parts of item whose sale was divided into more than one card" }, "truncated_card_number": { "type": "string", "description": "Truncated card number" }, "prepaid_card": { "type": "string", "description": "Indicates if the transaction was performed with a prepaid card: Y/N" }, "tx_id": { "type": "string", "description": "Pix transaction identification code" } }, "description": "Transaction summary" }, "TransactionV4": { "type": "object", "properties": { "summary": { "$ref": "#/definitions/TransactionSummaryV4" }, "details": { "type": "array", "items": { "$ref": "#/definitions/TransactionDetailsV4" }, "description": "Transaction Detail" } }, "description": "Represents the transaction block" }, "TransactionSummaryV4": { "type": "object", "properties": { "type_register": { "type": "integer", "description": "Record type | 1 - Transaction summary", "format": "int32" }, "order_id": { "type": "string", "description": "Order number generated by anchor" }, "marketplace_document_number": { "type": "number", "description": "Anchor's CNPJ/CPF document number", "format": "double" }, "marketplace_subsellerid": { "type": "string", "description": "Anchor's own store code" }, "marketplace_transaction_id": { "type": "integer", "description": "Transaction identification number generated by payment split", "format": "int64" }, "transaction_date": { "type": "string", "description": "Transaction date/time", "format": "date-time" }, "confirmation_date": { "type": "string", "description": "Transaction confirmation date/time", "format": "date-time" }, "product_id": { "type": "integer", "description": "Product code:\r\n\r\n1 - MASTERCARD, \r\n\r\n2 - MAESTRO,\r\n \r\n3 - VISA,\r\n\r\n4 - VISA ELECTRON,\r\n\r\n5 - AMEX,\r\n\r\n11 - ELO CREDIT,\r\n\r\n12 - ELO DEBIT,\r\n\r\n13 - HIPER-HIPERCARD CREDIT,\r\n\r\n101 - BOLETO SANTANDER,\r\n\r\n14 - PIX", "format": "int32" }, "product_name": { "type": "string", "description": "Product description" }, "transaction_type": { "type": "integer", "description": "Transaction type:\r\n\r\n1 - Spot credit,\r\n\r\n2 - Store installment credit,\r\n\r\n3 - Administrator installment credit,\r\n\r\n4 - Debit,\r\n\r\n5 - Cancellation,\r\n\r\n7 - Boleto,\r\n\r\n8 - PIX", "format": "int32" }, "number_installments": { "type": "integer", "description": "Total number of installments", "format": "int32" }, "nsu_host": { "type": "string", "description": "Authorization code generated by issuer" }, "acquirer_transaction_id": { "type": "string", "description": "Transaction identification number generated by acquirer" }, "card_payment_amount": { "type": "integer", "description": "Transaction value in cents. This value will be presented with a negative sign in case of a cancellation transaction.", "format": "int64" }, "sum_details_card_payment_amount": { "type": "integer", "description": "Sum of value listed in details in cents listed in type 2 records", "format": "int64" }, "marketplace_original_transaction_id": { "type": "integer", "description": "Original transaction identification number generated by payment split. Filled only for cancellation transactions.", "format": "int64" }, "marketplace_original_transaction_date": { "type": "string", "description": "Original transaction creation date generated by payment split. Filled only for cancellation transactions.", "format": "date-time" }, "transaction_status_code": { "type": "integer", "description": "Transaction status code\r\n \r\n 0\tApproved ,\r\n \r\n70\tAwaiting,\r\n\r\n77\tPending,\r\n\r\n78 Pending Payment,\r\n\r\n83\tTimeout,\r\n\r\n86\tUndone,\r\n\r\n90\tNon-existent,\r\n\r\n91\tDenied - Administrator,\r\n\r\n92\tReversed,\r\n\r\n93\tDuplicate,\r\n\r\n94\tReversed Reconciliation,\r\n\r\n98\tCancelled - No Confirmation,\r\n\r\n99\tDenied - MGM", "format": "int32" }, "terminal_nsu": { "type": "string", "description": "Transaction identification number generated by terminal" }, "reason_message": { "type": "string", "description": "Transaction status return message" }, "authorization_code": { "type": "string", "description": "Credit authorization code" }, "payment_id": { "type": "string", "description": "Transaction identifier sent or generated at the time of transaction creation", "format": "uuid" }, "terminal_identification": { "type": "string", "description": "Terminal identification number" }, "nsu_tef": { "type": "string", "description": "Transaction identification number generated by physical terminal" }, "entry_mode_code": { "type": "string", "description": "Transaction mode identification code.\r\n\r\n001\tCollected through batch processing\r\n\r\n011\tCard entered manually\r\n\r\n021\tCard read\r\n\r\n051\tCard ICC EMV\r\n\r\n071\tContactless card with EMV data\r\n\r\n091\tContactless card with magnetic stripe\r\n\r\n801\tMagnetic fallback of ICC card\r\n\r\n810\tE-commerce" }, "entry_mode": { "type": "string", "description": "Transaction mode identification" }, "transaction_channel_code": { "type": "integer", "description": "Transaction Entry Channel Code\r\n\r\n1 Digital (E-COMMERCE) \r\n\r\n2 Physical (POS and TEF)", "format": "int32" }, "transaction_channel": { "type": "string", "description": "Transaction Entry Channel" }, "capture_code": { "type": "integer", "description": "Transaction Entry Technology Code\r\n\r\n10\tPOS\r\n\r\n13\tVERMELHINHA\r\n\r\n15\tMODEM\r\n\r\n20\tDialed TEF\r\n\r\n30\tDedicated TEF\r\n\r\n35\tWEB RECARGA\r\n\r\n40\tPIN PAD\r\n\r\n45\tE-COMMERCE\r\n\r\n50\tURA\r\n\r\n55\tWEB TOPAZIO\r\n\r\n60\tEASY GOOD\r\n\r\n63\tIATA\r\n\r\n65\tFILE EXCHANGE\r\n\r\n70\tMOBILE\r\n\r\n71\tMOBILE GETNET\r\n\r\n74\tSUPERGET MOBILE\r\n\r\n75\tCHIP\r\n\r\n80\tREADER\r\n\r\n90\tREADER AC\r\n\r\n95\tATM\r\n\r\n97\tTHIRD PARTY EQUIPMENT", "format": "int32" }, "capture": { "type": "string", "description": "Transaction entry technology" }, "payment_tag": { "type": "string", "description": "Tag to identify payment parts of item whose sale was divided into more than one card" }, "truncated_card_number": { "type": "string", "description": "Truncated card number" }, "prepaid_card": { "type": "string", "description": "Indicates if the transaction was performed with a prepaid card: Y/N" }, "tx_id": { "type": "string", "description": "Pix transaction identification code" } }, "description": "Transaction summary" }, "TransactionDetailsV4": { "type": "object", "properties": { "type_register": { "type": "integer", "description": "Record type | 2 - Transaction detail", "format": "int32" }, "marketplace_schedule_id": { "type": "integer", "description": "Unique sequential number representing transaction scheduling", "format": "int64" }, "marketplace_subsellerid": { "type": "string", "description": "Anchor's own store code (subsellerid)" }, "release_status": { "type": "string", "description": "Indicates if scheduling has already been released for payment \r\n\r\nY - Yes\r\n\r\nN - No" }, "cpfcnpj_subseller": { "type": "string", "description": "CPF/CNPJ of partner registered below the Anchor" }, "cancel_custom_key": { "type": "string", "description": "Client key used to identify a cancellation request" }, "cancel_request_id": { "type": "string", "description": "Cancellation request identifier" }, "marketplace_transaction_id": { "type": "integer", "description": "Transaction identification number generated by payment split", "format": "int64" }, "transaction_date": { "type": "string", "description": "Transaction creation date/time", "format": "date-time" }, "confirmation_date": { "type": "string", "description": "Transaction confirmation date/time", "format": "date-time" }, "item_id": { "type": "string", "description": "Product code received in order generated by Anchor" }, "item_amount": { "type": "integer", "description": "Item gross value", "format": "int64" }, "number_installments": { "type": "integer", "description": "Total number of installments of the transaction", "format": "int32" }, "installment": { "type": "integer", "description": "Current installment number represented. \r\n\r\nIn case of RecebaJá plan, the total installment number is displayed. Example: 12 installments of 12 Installments.", "format": "int32" }, "installment_date": { "type": "string", "description": "Date/time of the represented installment", "format": "date-time" }, "installment_amount": { "type": "integer", "description": "Installment amount in cents", "format": "int64" }, "subseller_rate_amount": { "type": "integer", "description": "Net value passed to partner in cents. This value will be presented with a negative sign in case of a cancellation transaction.", "format": "int64" }, "subseller_rate_percentage": { "type": "number", "description": "Percentage charged by Anchor on partner's item", "format": "double" }, "payment_date": { "type": "string", "description": "Date calculated by the system for payment of value to partner.\r\n\r\nThis date can be changed at the time of item payment release.", "format": "date-time" }, "subseller_rate_closing_date": { "type": "string", "description": "Date when the item was compensated and sent for payment at Núclea. In case of PIX, payment is made directly by Santander bank.", "format": "date-time" }, "subseller_id": { "type": "integer", "description": "Partner code generated by Payment Split", "format": "int64" }, "seller_id": { "type": "string", "description": "Anchor access key (SellerId)" }, "item_id_mgm": { "type": "string", "description": "Item sequential generated by Payment Split" }, "payment_id": { "type": "string", "description": "Transaction identifier sent or generated at the time of transaction creation", "format": "uuid" }, "payment_tag": { "type": "string", "description": "Tag to identify payment parts of item whose sale was divided into more than one card" }, "item_split_tag": { "type": "string", "description": "Tag to identify item parts among list items" }, "payment_plan_code": { "type": "integer", "description": "Payment plan code.\r\n\r\n1\tNormal payment flow\r\n\r\n2\tRecebaJá 20 days\r\n\r\n3\tRecebaJá 2 days\r\n\r\n4\tRecebaJá 10 days\r\n\r\n5\tRecebaJá 30 days\r\n\r\n6\tRecebaJá 40 days\r\n\r\n7\tRecebaJá 5 days\r\n\r\n8\tRecebaJá 15 days\r\n\r\n9\tRecebaJá 7 days\r\n\r\n10\tRecebaJá 31 days\r\n\r\n11\tRecebaJá 0 days", "format": "int32" }, "payment_plan_name": { "type": "string", "description": "Name of payment plan. Example: RecebaJá 10 days" }, "boleto_id": { "type": "string", "description": "Boleto identification number", "format": "uuid" }, "our_number": { "type": "integer", "description": "Our boleto number generated by Santander bank at the time of boleto generation", "format": "int64" }, "boleto_payment_date": { "type": "string", "description": "Boleto payment date", "format": "date-time" }, "reference_number": { "type": "integer", "description": "Payment reference number.\r\n\r\nUnique and generated after balance compensation of the settlement process.", "format": "int32" }, "subsellerid_ext": { "type": "string", "description": "External store code" }, "payments": { "type": "array", "items": { "$ref": "#/definitions/PaymentV4" }, "description": "Collection of payment details" } }, "description": "Transaction details" }, "CommissionV4": { "type": "object", "properties": { "type_register": { "type": "integer", "description": "Record type | 3 - Commission", "format": "int32" }, "marketplace_schedule_id": { "type": "integer", "description": "Unique sequential number representing transaction scheduling", "format": "int64" }, "marketplace_subsellerid": { "type": "string", "description": "Anchor's own store code" }, "marketplace_transaction_id": { "type": "integer", "description": "Transaction identification number generated by payment split", "format": "int64" }, "transaction_date": { "type": "string", "description": "Transaction creation date/time", "format": "date-time" }, "confirmation_date": { "type": "string", "description": "Transaction confirmation date/time", "format": "date-time" }, "item_id": { "type": "string", "description": "Product code received in order generated by Anchor" }, "number_installments": { "type": "integer", "description": "Total number of scheduled transaction installments", "format": "int32" }, "installment": { "type": "integer", "description": "Current installment number represented. \r\n\r\nIn case of RecebaJá plan, the total installment number is displayed. Example: 12 installments of 12 Installments", "format": "int32" }, "installment_date": { "type": "string", "description": "Date/time of the represented installment", "format": "date-time" }, "installment_amount": { "type": "integer", "description": "Installment amount in cents.", "format": "int64" }, "subseller_id": { "type": "integer", "description": "Partner code generated by Payment Split", "format": "int32" }, "subseller_rate_amount": { "type": "integer", "description": "Commission value for Anchor's own store in cents", "format": "int64" }, "subseller_rate_percentage": { "type": "number", "description": "Percentage applied to Anchor's commission", "format": "double" }, "mdr_fee_total_amount": { "type": "integer", "description": "Value in cents of MDR fee (Merchant Discount Rate) plus FEE of the Split solution charged from Anchor", "format": "int64" }, "mdr_fee_total_percentage": { "type": "number", "description": "Percentage of MDR fee (Merchant Discount Rate) plus percentage of FEE of the Split solution charged from Anchor", "format": "double" }, "payment_date": { "type": "string", "description": "Date calculated by the system for payment of commission value. \r\n\r\nThis date can be changed at the time of partner item payment release if the \r\nAnchor is configured as 'Awaits Release for payment of products and commission'.", "format": "date-time" }, "subseller_rate_closing_date": { "type": "string", "description": "Date when the commission was compensated and sent for payment at Núclea.", "format": "date-time" }, "cancel_custom_key": { "type": "string", "description": "Client key used to identify a cancellation request." }, "cancel_request_id": { "type": "string", "description": "Cancellation request identifier" }, "item_id_mgm": { "type": "string", "description": "Item sequential generated by Payment Split" }, "payment_id": { "type": "string", "description": "Transaction identifier sent or generated at the time of transaction creation", "format": "uuid" }, "payment_tag": { "type": "string", "description": "Tag to identify payment parts of item whose sale was divided into more than one card" }, "item_split_tag": { "type": "string", "description": "Tag to identify item parts among list items" }, "payment_plan_code": { "type": "integer", "description": "Payment plan code.\r\n\r\n1\tNormal payment flow\r\n\r\n2\tRecebaJá 20 days\r\n\r\n3\tRecebaJá 2 days\r\n\r\n4\tRecebaJá 10 days\r\n\r\n5\tRecebaJá 30 days\r\n\r\n6\tRecebaJá 40 days\r\n\r\n7\tRecebaJá 5 days\r\n\r\n8\tRecebaJá 15 days\r\n\r\n9\tRecebaJá 7 days\r\n\r\n10\tRecebaJá 31 days\r\n\r\n11\tRecebaJá 0 days", "format": "int32" }, "payment_plan_name": { "type": "string", "description": "Name of payment plan. Example: RecebaJá 10 days" }, "fee_percentage": { "type": "number", "description": "Fee value charged for using the Payment Split solution", "format": "double" }, "fee_value": { "type": "number", "description": "Fee value charged for using the Payment Split solution", "format": "double" }, "mdr_percentage": { "type": "number", "description": "Percentage of MDR fee (Merchant Discount Rate)", "format": "double" }, "mdr_value": { "type": "number", "description": "Value of MDR fee (Merchant Discount Rate)", "format": "double" }, "reference_number": { "type": "integer", "description": "Payment reference number.\r\n\r\nUnique and generated after balance compensation of the settlement process.", "format": "int32" }, "subsellerid_ext": { "type": "string", "description": "External store code" }, "payments": { "type": "array", "items": { "$ref": "#/definitions/PaymentV4" }, "description": "Collection of payment details" } }, "description": "Represents the commission block" }, "AdjustmentV4": { "type": "object", "properties": { "type_register": { "type": "integer", "description": "Record type | 4 - Adjustment", "format": "int32" }, "marketplace_subsellerid": { "type": "string", "description": "Anchor's own store code" }, "subseller_id": { "type": "integer", "description": "Partner code generated by Payment Split", "format": "int32" }, "adjustment_origin": { "type": "string", "description": "Adjustment origin listed:\r\n\r\nA: generated automatically by the system \r\n\r\nM: inserted manually by Anchor via adjustments API" }, "marketplace_schedule_id": { "type": "integer", "description": "Unique sequential number representing transaction scheduling", "format": "int64" }, "cpfcnpj_subseller": { "type": "string", "description": "CPF/CNPJ of partner or own store" }, "adjustment_id": { "type": "integer", "description": "Adjustment identifier generated by Payment Split", "format": "int32" }, "adjustment_type": { "type": "integer", "description": "Adjustment Type:\r\n\r\n1 Credit Adjustment,\r\n \r\n2 Debit Adjustment,\r\n \r\n5 Negative Settlement Balance,\r\n \r\n6 Credit for Expired Negative,\r\n \r\n7 Debit for Expired Negative,\r\n \r\n8 Credit Adjustment Early Settlement ST,\r\n \r\n9 Debit Adjustment Early Settlement ST,\r\n \r\n10 Flag Fee,\r\n \r\n11 Debit Adjustment Reversal of Store Boleto,\r\n \r\n12 Debit Adjustment Reversal of Own Store Boleto Anchor,\r\n \r\n18 Debit adjustment for early settlement assignment IF,\r\n \r\n19 Debit adjustment for early settlement assignment NF,\r\n\r\n20 Credit adjustment for early settlement assignment IF,\r\n\r\n21 Credit adjustment for early settlement assignment NF", "format": "int32" }, "adjustment_date": { "type": "string", "description": "Adjustment creation date", "format": "date-time" }, "adjustment_amount": { "type": "integer", "description": "Adjustment value in cents", "format": "int64" }, "subseller_rate_closing_date": { "type": "string", "description": "Date when the adjustment was settled and sent for payment at Núclea", "format": "date-time" }, "payment_date": { "type": "string", "description": "Date calculated by the system for adjustment settlement", "format": "date-time" }, "adjustment_reason": { "type": "string", "description": "Adjustment description" }, "order_id": { "type": "string", "description": "Order number generated by Anchor" }, "product_id": { "type": "integer", "description": "Product Code:\r\n\r\n1\tMASTERCARD,\r\n\r\n2\tMAESTRO,\r\n\r\n3\tVISA,\r\n\r\n4\tVISA ELECTRON,\r\n\r\n5\tAMEX,\r\n\r\n11\tELO CREDITO,\r\n\r\n12\tELO DEBITO,\r\n\r\n13\tHIPER-HIPERCARD CREDITO,\r\n\r\n101 BOLETO SANTANDER", "format": "int32" }, "product_name": { "type": "string", "description": "Product description" }, "our_number": { "type": "string", "description": "Our boleto number generated by Santander bank at the time of boleto generation" }, "nsu_boleto_adjustment": { "type": "string", "description": "Adjustment identification for boleto return" }, "operation_identifier_code": { "type": "string", "description": "Operation identifier code" }, "reference_number": { "type": "integer", "description": "Payment reference number.\r\n\r\nIt is unique and generated after settlement balance compensation of the settlement process.", "format": "int32" }, "subsellerid_ext": { "type": "string", "description": "External store code" }, "payments": { "type": "array", "items": { "$ref": "#/definitions/PaymentV4" }, "description": "Collection of payment details" } }, "description": "Adjustments" }, "ChargebackV4": { "type": "object", "properties": { "type_register": { "type": "integer", "description": "Record type | 5 - Chargeback", "format": "int32" }, "marketplace_schedule_id": { "type": "integer", "description": "Unique sequential number representing the transaction scheduling", "format": "int64" }, "marketplace_subsellerid": { "type": "string", "description": "Anchor's own store code" }, "release_status": { "type": "string", "description": "Indicates whether the schedule has already been released for payment:\r\n\r\nY - Yes\r\n\r\nN - No" }, "merchand_id": { "type": "string", "description": "Anchor's Establishment Code" }, "transaction_date": { "type": "string", "description": "Date/Time of transaction creation", "format": "date-time" }, "installment_date": { "type": "string", "description": "Date/Time of the represented installment", "format": "date-time" }, "chargeback_amount": { "type": "integer", "description": "Installment value in cents", "format": "int64" }, "adjustment_id": { "type": "integer", "description": "Chargeback adjustment identifier generated by Payment Split", "format": "int32" }, "adjustment_type": { "type": "integer", "description": "Adjustment Type:\r\n\r\n4 - Chargeback Debit\r\n\r\n25 - Chargeback Reversal Credit", "format": "int32" }, "adjustment_date": { "type": "string", "description": "Chargeback adjustment creation date", "format": "date-time" }, "adjustment_amount": { "type": "integer", "description": "Adjustment Value in cents", "format": "int64" }, "adjustment_origin": { "type": "string", "description": "Origin of the listed adjustment: \r\n\r\nA - generated automatically by the system" }, "adjustment_reason": { "type": "string", "description": "Adjustment Description" }, "acquirer_transaction_id": { "type": "string", "description": "Transaction identification number generated by the acquirer" }, "card_payment_amount": { "type": "integer", "description": "Original transaction value in cents", "format": "int64" }, "marketplace_original_transaction_id": { "type": "integer", "description": "Original transaction identification number generated by payment split. Filled only for chargeback adjustments.", "format": "int64" }, "transaction_status_code": { "type": "integer", "description": "Original transaction status code\r\n\r\n0 - Approved", "format": "int32" }, "terminal_nsu": { "type": "string", "description": "Original transaction authorization code generated by the issuer" }, "reason_message": { "type": "string", "description": "Flag return message" }, "authorization_code": { "type": "string", "description": "Credit authorization code" }, "order_id": { "type": "string", "description": "Order number generated by Anchor" }, "vlr_mdr_marketplace": { "type": "number", "description": "Value in cents of MDR refund charged by Payment Split for chargeback debits or execution of a new MDR debit in case of chargeback reversal", "format": "double" }, "vlr_fee": { "type": "number", "description": "Value in cents of FEE refund charged by Payment Split for chargeback debits or execution of a new FEE debit in case of chargeback reversal", "format": "double" }, "vlr_somaMdrFee": { "type": "number", "description": "Value in cents of the sum of platform MDR + FEE", "format": "double" }, "perc_mdr_marketplace": { "type": "number", "description": "Percentage value in cents of MDR charged by Payment Split", "format": "double" }, "perc_fee": { "type": "number", "description": "Percentage value in cents of platform FEE charged by Payment Split", "format": "double" }, "perc_somaMdrFee": { "type": "number", "description": "Percentage value in cents of the sum of platform MDR + FEE", "format": "double" }, "product_id": { "type": "integer", "description": "Product code:\r\n\r\n1\tMASTERCARD,\r\n\r\n2\tMAESTRO,\r\n\r\n3\tVISA,\r\n\r\n4\tVISA ELECTRON,\r\n\r\n5\tAMEX,\r\n\r\n11\tELO CREDITO,\r\n\r\n12\tELO DEBITO,\r\n\r\n13\tHIPER-HIPERCARD CREDITO\r\n\r\n101\tBOLETO SANTANDER", "format": "int32" }, "product_name": { "type": "string", "description": "Product description" }, "payment_id": { "type": "string", "description": "Original transaction identifier sent or generated at the time of transaction creation" }, "reference_number": { "type": "integer", "description": "Payment reference number.\r\n\r\nIt is unique and generated after settlement balance compensation of the settlement process.", "format": "int32" }, "payments": { "type": "array", "items": { "$ref": "#/definitions/PaymentV4" }, "description": "Collection of payment details" } }, "description": "Chargeback" }, "PaymentV4": { "type": "object", "properties": { "prorated_payment": { "type": "number", "description": "Amount Paid in cents. This field represents the proportional amount paid when there is application of a lien contract or total amount paid of the item without application of the contract (Settlement only).", "format": "double" }, "contract_number": { "type": "integer", "description": "Operation lien contract number", "format": "int64" }, "nu_liquid": { "type": "string", "description": "Settlement identification code generated by Núclea" }, "account_type": { "type": "string", "description": "Account type:\r\n\r\nC:\tCurrent Account\r\n\r\nG: Payment Account\r\n\r\nP: Savings Account" }, "beneficiary_document_number": { "type": "string", "description": "CPF/CNPJ of the payment recipient" }, "bank": { "type": "string", "description": "Bank of the payment recipient" }, "agency": { "type": "string", "description": "Agency of the payment recipient" }, "account_number": { "type": "string", "description": "Account number with digit of the payment recipient" }, "subseller_rate_confirm_date": { "type": "string", "description": "Date of payment confirmation that the home bank responded to GETNET", "format": "date-time" }, "operation_type": { "type": "string", "description": "Type of negotiated operation:\r\n\r\nSettlement of \"UR\" value free\r\n\r\nSettlement of liened UR\r\n\r\nSettlement assignment" }, "product_id": { "type": "integer", "description": "Code of the last settled flag to which payment was made\r\n\r\n1\tMASTERCARD,\r\n\r\n2\tMAESTRO,\r\n\r\n3\tVISA,\r\n\r\n4\tVISA ELECTRON,\r\n\r\n5\tAMEX,\r\n\r\n11\tELO CREDITO,\r\n\r\n12\tELO DEBITO,\r\n\r\n13\tHIPER-HIPERCARD CREDITO\r\n\r\n101\tBOLETO SANTANDER\r\n\r\n14 PIX", "format": "int32" }, "product_name": { "type": "string", "description": "Description of the last settled flag" } }, "description": "Represents the payment summary block" }, "ExtractStatusV4": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Boolean for successful execution" }, "status_code": { "maxLength": 4, "type": "string", "description": "Execution status code" }, "message": { "maxLength": 128, "type": "string", "description": "Message associated with the StatusCode field." }, "errors": { "type": "array", "items": { "$ref": "#/definitions/ExtractErrorV4" }, "description": "Collection of possible request or processing errors." } }, "description": "Error class" }, "ExtractErrorV4": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code" }, "message": { "type": "string", "description": "Error message" } }, "description": "Represents error information" }, "ReceivableUnitDetailsViewModel": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier", "maxLength": 4 }, "date": { "type": "string", "description": "UR date. Format YYYY-MM-DD.", "maxLength": 10 }, "value": { "type": "number", "format": "double", "description": "Gross value associated with the flag. Format: Decimal(13, 2) - two decimal places." }, "brand_id": { "type": "string", "description": "Flag Identifier: \r\n999 – All flags\r\n003 – MASTER\r\n004 – VISA\r\n008 – ELO\r\n006 - AMEX\r\n021 – HIPER", "maxLength": 3 } }, "description": "Represents information on details of receivable units." }, "RecordDataViewModel": { "type": "object", "properties": { "simulation_number": { "type": "string", "description": "Early Settlement Simulation Number. \r\nThis will be the identifier number of the early settlement simulation request made via the Receivables Early Settlement API.\r\nFormatting: 15 numeric digits filled with zeros to the left of the simulation number.", "maxLength": 15 }, "operation_number": { "type": "string", "description": "Early Settlement Proposal Number. \r\nThis will be the number of the early settlement proposal, which the merchant establishment had access to when requesting the operation. \r\nValid only for early settlement operations carried out within the Getnet-Santander group(\"GN\" or \"ST\"). \r\nFor operations originated in the market( \"IF\" or \"NF\" ), this field will come with no information. \r\nFormatting: 15 numeric digits filled with zeros to the left of the proposal number.", "maxLength": 15 }, "anticipation": { "description": "Early settlement data to be returned in the search.", "$ref": "#/definitions/AnticipationDetailsViewModel" }, "adjustments": { "type": "array", "description": "Collection of adjustments to be returned in the search.", "items": { "$ref": "#/definitions/AdjustmentDetailsViewModel" } }, "updates": { "type": "array", "description": "Collection of updates (inclusions and revocations) to be returned in the search.", "items": { "$ref": "#/definitions/UpdateDetailsViewModel" } } }, "description": "Early settlement simulation request and formalization registration data" }, "RequestFormalizationViewModel": { "type": "object", "required": [ "account", "agency", "bank_number", "client_id", "document_number", "document_type", "origin", "simulation_number" ], "properties": { "simulation_number": { "type": "string", "description": "Simulation number.", "maxLength": 15 }, "origin": { "type": "integer", "format": "int32", "description": "Origin: \r\n2 - SANTANDER" }, "bank_number": { "type": "string", "description": "Bank number", "maxLength": 4, "pattern": "^[0-9]{1,12}$" }, "agency": { "type": "string", "description": "Agency number", "maxLength": 4, "pattern": "^[0-9]{1,12}$" }, "account": { "type": "string", "description": "Account number", "maxLength": 11 }, "client_id": { "type": "string", "description": "Customer identification at home/CNPJ. At SANTANDER it refers to PENUMPER", "maxLength": 11 }, "document_number": { "type": "string", "description": "Document number.", "minLength": 11, "maxLength": 14, "pattern": "^[0-9]{1,100}$" }, "document_type": { "type": "integer", "format": "int32", "description": "Document type: \r\n1 - CPF \r\n2 - CNPJ", "minimum": 1, "maximum": 2 } }, "description": "Parameterization for operation formalization request." }, "RequestSimulationByRUViewModel": { "type": "object", "required": [ "account", "agency", "bank_number", "client_id", "document_number", "document_type", "getkey", "origin", "receivables_units_amount", "receivables_units_ids" ], "properties": { "getkey": { "type": "string", "description": "Query identifier", "maxLength": 15 }, "receivables_units_amount": { "type": "integer", "format": "int32", "description": "Total URs to simulate" }, "receivables_units_ids": { "type": "array", "description": "Receivable Units Ids", "items": { "type": "string" } }, "origin": { "type": "integer", "format": "int32", "description": "Origin: \r\n2 - SANTANDER" }, "bank_number": { "type": "string", "description": "Bank number", "maxLength": 4, "pattern": "^[0-9]{1,12}$" }, "agency": { "type": "string", "description": "Agency number", "maxLength": 4, "pattern": "^[0-9]{1,12}$" }, "account": { "type": "string", "description": "Account number", "maxLength": 11 }, "client_id": { "type": "string", "description": "Customer identification at home/CNPJ. At SANTANDER it refers to PENUMPER", "maxLength": 11 }, "document_number": { "type": "string", "description": "Document number.", "minLength": 11, "maxLength": 14, "pattern": "^[0-9]{1,100}$" }, "document_type": { "type": "integer", "format": "int32", "description": "Document type: \r\n1 - CPF \r\n2 - CNPJ", "minimum": 1, "maximum": 2 } }, "description": "Parameterization for early settlement simulation request per receivable unit." }, "RequestSimulationByValueViewModel": { "type": "object", "required": [ "account", "agency", "bank_number", "brand_id", "client_id", "document_number", "document_type", "origin", "value" ], "properties": { "value": { "type": "number", "format": "double", "description": "Simulation value. Format: Decimal(13, 2) - two decimal places." }, "brand_id": { "type": "string", "description": "Flag Identifier: \r\n999 – All flags / \r\n003 – MASTER / \r\n004 – VISA / \r\n008 – ELO / \r\n006 - AMEX / \r\n021 – HIPER", "maxLength": 3, "pattern": "^[0-9]{1,10}$" }, "origin": { "type": "integer", "format": "int32", "description": "Origin: \r\n2 - SANTANDER" }, "bank_number": { "type": "string", "description": "Bank number", "maxLength": 4, "pattern": "^[0-9]{1,12}$" }, "agency": { "type": "string", "description": "Agency number", "maxLength": 4, "pattern": "^[0-9]{1,12}$" }, "account": { "type": "string", "description": "Account number", "maxLength": 11 }, "client_id": { "type": "string", "description": "Customer identification at home/CNPJ. At SANTANDER it refers to PENUMPER", "maxLength": 11 }, "document_number": { "type": "string", "description": "Document number.", "minLength": 11, "maxLength": 14, "pattern": "^[0-9]{1,100}$" }, "document_type": { "type": "integer", "format": "int32", "description": "Document type: \r\n1 - CPF \r\n2 - CNPJ", "minimum": 1, "maximum": 2 } }, "description": "Parameterization for early settlement simulation request by value." }, "ResponseBalancesViewModel": { "type": "object", "properties": { "response": { "description": "Response content", "$ref": "#/definitions/ContentBalancesViewModel" }, "status": { "description": "Response status", "$ref": "#/definitions/ResponseStatusViewModel" } }, "description": "Response class for balances endpoint" }, "ResponseFormalizationViewModel": { "type": "object", "properties": { "response": { "description": "Response content", "$ref": "#/definitions/ContentFormalizationViewModel" }, "status": { "description": "Response status", "$ref": "#/definitions/ResponseStatusViewModel" } }, "description": "Response class for formalize-operation endpoint" }, "ResponseReceivablesUnitsViewModel": { "type": "object", "properties": { "response": { "description": "Response content", "$ref": "#/definitions/ContentReceivablesUnitsViewModel" }, "status": { "description": "Response status", "$ref": "#/definitions/ResponseStatusViewModel" } }, "description": "Response class for receivables-units endpoint" }, "ResponseSearchViewModel": { "type": "object", "properties": { "response": { "description": "Response content", "$ref": "#/definitions/ContentSearchViewModel" }, "status": { "description": "Response status", "$ref": "#/definitions/ResponseStatusViewModel" } }, "description": "Response class for search endpoint" }, "ResponseSimulationViewModel": { "type": "object", "properties": { "response": { "description": "Response content", "$ref": "#/definitions/ContentSimulationViewModel" }, "status": { "description": "Response status", "$ref": "#/definitions/ResponseStatusViewModel" } }, "description": "Response class for simulation endpoints" }, "ResponseStatusViewModel": { "type": "object", "properties": { "status_code": { "type": "string", "description": "Status code. \r\n0000 – Execution successfully completed.", "maxLength": 4 }, "message": { "type": "string", "description": "Message associated with the StatusCode field.", "maxLength": 128 } }, "description": "Request Status class;" }, "TransactionDetailsViewModel": { "type": "object", "properties": { "type_register": { "type": "integer", "description": "Record type | 2 - Transaction detail", "format": "int32" }, "marketplace_schedule_id": { "type": "integer", "description": "Scheduling NSU in the MGM system", "format": "int64" }, "marketplace_subsellerid": { "type": "string", "description": "Marketplace's own store code" }, "release_status": { "type": "string", "description": "Indicates whether the schedule has already been released for payment Y/N" }, "cpfcnpj_subseller": { "type": "string", "description": "Subseller CPF/CNPJ" }, "cancel_custom_key": { "type": "string", "description": "Client key used to identify a cancellation request." }, "cancel_request_id": { "type": "string", "description": "Cancellation request identifier.\r\nCurrently MGM is returning in this field the Payment_ID of the transaction (returned in the Payments response) and not the cancel_request_id (returned in the cancellation request)" }, "marketplace_transaction_id": { "type": "integer", "description": "Marketplace Management NSU", "format": "int64" }, "transaction_date": { "type": "string", "description": "Date/Time of Transaction", "format": "date-time" }, "confirmation_date": { "type": "string", "description": "Date/Time of Transaction Confirmation", "format": "date-time" }, "item_id": { "type": "string", "description": "Product code received in the order" }, "number_installments": { "type": "integer", "description": "Total Number of Installments of the Transaction", "format": "int32" }, "installment": { "type": "integer", "description": "Number of current installment represented", "format": "int32" }, "installment_date": { "type": "string", "description": "Date/Time of the represented installment", "format": "date-time" }, "installment_amount": { "type": "integer", "description": "Installment value in cents.", "format": "int64" }, "subseller_rate_amount": { "type": "integer", "description": "Value of transfer to the subseller in cents.", "format": "int64" }, "subseller_rate_percentage": { "type": "number", "description": "Percentage charged from the subseller for the MGM operation", "format": "double" }, "payment_date": { "type": "string", "description": "Date calculated by the system for payment of the amount to the subseller. This date may be changed at the time of payment release for the item", "format": "date-time" }, "subseller_rate_closing_date": { "type": "string", "description": "Date when the schedule was settled and sent to CIP", "format": "date-time" }, "subseller_id": { "type": "integer", "description": "Store Code", "format": "int64" }, "seller_id": { "type": "string", "description": "Marketplace Id (SellerId)" }, "transaction_sign": { "type": "string", "description": "'+' Credit , '-' Debit" }, "item_id_mgm": { "type": "string", "description": "Order Item Id (Seql_PedidoItem)" }, "payment_id": { "type": "string", "description": "Payment identification code", "format": "uuid" }, "payment_tag": { "type": "string", "description": "Tag to identify payment parts of the item on more than one card" }, "item_split_tag": { "type": "string", "description": "Tag to identify parts of the item among the items in the list" }, "payment_plan_name": { "type": "string", "description": "Payment plan name" }, "boleto_id": { "type": "string", "description": "Boleto identification number", "format": "uuid" }, "our_number": { "type": "integer", "description": "Boleto our number", "format": "int64" }, "boleto_payment_date": { "type": "string", "description": "Boleto payment date", "format": "date-time" }, "reference_number": { "type": "integer", "description": "Payment reference number", "format": "int32" } }, "description": "Represents the transaction detail block in the response of the request" }, "TransactionSummaryViewModel": { "type": "object", "properties": { "type_register": { "type": "integer", "description": "Record type | 1 - Transaction summary", "format": "int32" }, "order_id": { "type": "string", "description": "Order number" }, "marketplace_subsellerid": { "type": "string", "description": "Marketplace's own store code" }, "marketplace_transaction_id": { "type": "integer", "description": "Marketplace Management NSU", "format": "int64" }, "transaction_date": { "type": "string", "description": "Date/Time of Transaction", "format": "date-time" }, "confirmation_date": { "type": "string", "description": "Date/Time of transaction confirmation", "format": "date-time" }, "product_id": { "type": "integer", "description": "Product Code \r\n1\tMASTERCARD,\r\n2\tMAESTRO,\r\n3\tVISA,\r\n4\tVISA ELECTRON,\r\n5\tAMEX,\r\n11\tELO CREDITO,\r\n12\tELO DEBITO,\r\n13\tHIPER-HIPERCARD CREDITO\r\n101\tBOLETO SANTANDER", "format": "int32" }, "transaction_type": { "type": "integer", "description": "Transaction Type\r\n1\tSpot Credit,\r\n2\tStorekeeper Installment Credit,\r\n3\tAdministrator Installment Credit,\r\n4\tDebit,\r\n5\tCancellation,\r\n6\tChargeback\r\n7 Boleto", "format": "int32" }, "number_installments": { "type": "integer", "description": "Total number of installments", "format": "int32" }, "acquirer_transaction_id": { "type": "string", "description": "Acquirer transaction code." }, "card_payment_amount": { "type": "integer", "description": "Transaction value on card or boleto in cents", "format": "int64" }, "sum_details_card_payment_amount": { "type": "integer", "description": "Sum of the value listed in the details in cents listed in type 2 records.", "format": "int64" }, "marketplace_original_transaction_id": { "type": "integer", "description": "Original Marketplace Management NSU (Only for Cancellation/Chargeback)", "format": "int64" }, "transaction_status_code": { "type": "integer", "description": " Transaction Status Code\r\n 0\tApproved ,\r\n70\tAwaiting,\r\n77\tPending,\r\n78 Pending Payment,\r\n83\tTimeout,\r\n86\tUndone,\r\n90\tNon-existent,\r\n91\tDenied - Administrator,\r\n92\tReversed,\r\n93\tRepeated,\r\n94\tReversed Reconciliation,\r\n98\tCanceled - Without Confirmation,\r\n99\tDenied - MGM,", "format": "int32" }, "transaction_sign": { "type": "string", "description": "'+' Credit , '-' Debit" }, "terminal_nsu": { "type": "string", "description": "Authorization code generated by the Issuer when the transaction is successfully completed." }, "reason_message": { "type": "string", "description": "Return message." }, "authorization_code": { "type": "string", "description": "Credit authorization code" }, "payment_id": { "type": "string", "description": "Payment identification code", "format": "uuid" }, "terminal_identification": { "type": "string", "description": "Terminal Identification (Store Front)" }, "nsu_tef": { "type": "string", "description": "Tef NSU Identification" }, "entry_mode": { "type": "string", "description": "Transaction mode identification\r\n001\tCollected through batch processing\r\n011\tCard typed\r\n021\tCard read\r\n051\tCard ICC EMV\r\n071\tContactless card with EMV data\r\n091\tContactless card with Magnetic Track\r\n801\tMagnetic fallback from ICC card\r\n810\tE-commerce" }, "transaction_channel": { "type": "string", "description": "Transaction Entry Channel\r\n1\tDigital \r\n2\tPhysical\r\n///" }, "capture": { "type": "string", "description": "Transaction Entry Channel\r\n10\tPOS\r\n13\tVERMELHINHA\r\n15\tMODEM\r\n20\tDialed TEF\r\n30\tDedicated TEF\r\n35\tWEB RECHARGE\r\n40\tPIN PAD\r\n45\tE-COMMERCE\r\n50\tIVR\r\n55\tWEB TOPAZIO\r\n60\tEASY GOOD\r\n63\tIATA\r\n65\tFILE EXCHANGE\r\n70\tMOBILE\r\n71\tMOBILE GETNET\r\n74\tSUPERGET MOBILE\r\n75\tCHIP\r\n80\tREADER\r\n90\tAC READER\r\n95\tATM\r\n97\tTHIRD PARTY EQUIP" }, "payment_tag": { "type": "string", "description": "Tag to identify payment parts of the item on more than one card" }, "truncated_card_number": { "type": "string", "description": "Truncated card number" } }, "description": "Represents the transaction summary block" }, "TransactionViewModel": { "type": "object", "properties": { "summary": { "$ref": "#/definitions/TransactionSummaryViewModel" }, "details": { "type": "array", "description": "Transaction Detail", "items": { "$ref": "#/definitions/TransactionDetailsViewModel" } } }, "description": "Represents the transaction block in the response" }, "UpdateDetailsViewModel": { "type": "object", "properties": { "seller_id": { "type": "string", "description": "Marketplace identifier.", "maxLength": 50 }, "subseller_id": { "type": "integer", "format": "int32", "description": "Store identifier." }, "request_channel": { "type": "string", "description": "Request channel:\r\nANT - Automatic Santander / \r\nCAC - Customer Service Center / \r\nIBK - Internet Banking / \r\nPOS - POS Terminal / \r\nUSE - Getnet single early settlement PAR system / \r\nAUT - Getnet automatic early settlement PAR system / \r\nCIF - Assignments of \"IF's\" conducted in the market / \r\nCNF - Assignments of \"NIF's\" conducted in the market", "maxLength": 3 }, "legal_document_number": { "type": "string", "description": "Fiscal identifier of the merchant establishment. CNPJ (National Registry of Legal Entities) or CPF (Registry of Natural Persons).", "maxLength": 14 }, "update_value": { "type": "number", "format": "double", "description": "Update value. Format: Decimal(13, 2) - two decimal places." }, "interest_value": { "type": "number", "format": "double", "description": "Interest value. Format: Decimal(13, 2) - two decimal places." }, "ioc_value": { "type": "number", "format": "double", "description": "IOC value. Format: Decimal(13, 2) - two decimal places." }, "rejection_date": { "type": "string", "description": "Rejection date: D+1 of formalization." }, "bank_number": { "type": "string", "description": "Bank number.", "maxLength": 4 }, "agency": { "type": "string", "description": "Agency number.", "maxLength": 4 }, "account": { "type": "string", "description": "Account number.", "maxLength": 11 }, "account_type": { "type": "string", "description": "Account Type of the Bank Domicile Where the Early Settlement Operation Credit Was Made: \r\nCC - Current Account / \r\nCD - Deposit Account / \r\nPG - Payment Account / \r\nPP - Savings / \r\nConditional: This field will be filled only in early settlement operations of the Getnet-Santander group (\"GN\" or \"ST\"), for operations originated in the market(\"IF\" or \"NF\"), this field will come with no information.", "maxLength": 2 }, "negotiator_type": { "type": "string", "description": "Type of Operation Negotiator: \r\nIF - Financial Institution / \r\nNF - Non-Financial Institution / \r\nST - Santander / \r\nGN - Getnet", "maxLength": 2 }, "negotiator_document_type": { "type": "string", "description": "Operation negotiator document type, which may be from \"Getnet\" itself (credentialing early settlement), \r\n\"Santander\" (early settlement by assignment) or any \"IF\" or \"NIF\" participant in the market.\r\nJ - CNPJ (Legal Entity) / \r\nF - CPF (Natural Person)" }, "negotiator_document": { "type": "string", "description": "Operation negotiator document (CNPJ).", "maxLength": 14 }, "negotiator_name": { "type": "string", "description": "Operation negotiator name.", "maxLength": 50 }, "recomposition_type": { "type": "string", "description": "Type of recomposition: \r\nI - Flow inclusion / \r\nR - Flow revocation", "maxLength": 1 }, "contract_situation": { "type": "string", "description": "Contract Situation: \r\nA - Contract remains active / \r\nC - Contract canceled / \r\nR - Contract renegotiated", "maxLength": 1 }, "product_id_desc": { "type": "string", "description": "Product Code \r\n1\tMASTERCARD / \r\n2\tMAESTRO / \r\n3\tVISA / \r\n4\tVISA ELECTRON / \r\n5\tAMEX / \r\n11\tELO CREDITO / \r\n12\tELO DEBITO / \r\n13\tHIPER-HIPERCARD CREDITO / \r\n101\tBOLETO SANTANDER", "maxLength": 30 }, "operation_type_code": { "type": "string", "description": "Operation type code." }, "operation_identifier_code": { "type": "string", "description": "Operation identification code." }, "payment_date": { "type": "string", "description": "Date calculated by the system for payment of the amount to the subseller." }, "flow_update_request_date": { "type": "string", "description": "Date of flow update request." } }, "description": "Update Details (Inclusion or Revocation)" }, "ConsultReturn": { "description": "Response object from the registry status consultation", "type": "object", "properties": { "bandeira": { "description": "Flag for which the Opt-in/out request was made.", "type": "string" }, "descricaoSituacao": { "description": "Description of the Opt-in record status.", "type": "string" }, "docFinanciador": { "format": "int64", "description": "Financing document (IF or NIF).", "type": "integer" }, "dataInicioVigencia": { "format": "date-time", "description": "Start date of Opt-in validity", "type": "string" }, "dataFimVigencia": { "format": "date-time", "description": "End date of Opt-out validity", "type": "string" }, "codRecusa": { "description": "Opt-in / Opt-out registration refusal error code", "type": "string" }, "descRecusa": { "description": "Description of the Opt-in registration refusal code at the registry", "type": "string" } } }, "ResponseMessagesOPTINOUT": { "description": "Response Class", "type": "object", "properties": { "messages": { "description": "List of messages", "uniqueItems": false, "type": "array", "items": { "type": "string" } } } }, "ResponseErrorsOPTINOUT": { "description": "Response Class", "type": "object", "properties": { "errors": { "description": "List of errors", "uniqueItems": false, "type": "array", "items": { "type": "string" } } } }, "PaymentReturn": { "type": "object", "properties": { "BrandId": { "type": "integer", "description": "Card brand code.", "format": "int32" }, "ProductDescription": { "type": "string", "description": "Product description." }, "LiquidationDate": { "type": "string", "description": "Settlement date.", "format": "date-time" }, "Value": { "type": "number", "description": "Amount.", "format": "double" }, "PaymentSummaries": { "type": "array", "items": { "$ref": "#/definitions/PaymentSummaryReturn" }, "description": "Payment summary." }, "Seller": { "$ref": "#/definitions/SellerReturn" }, "Subseller": { "$ref": "#/definitions/PaymentSubsellerReturn" } }, "description": "Payment details." }, "PaymentSubsellerReturn": { "type": "object", "properties": { "Id": { "type": "integer", "description": "Identification number.", "format": "int64" }, "externalId": { "type": "string", "description": "External subseller code (VTEX)." }, "Name": { "type": "string", "description": "Subseller name." } }, "description": "Subseller." }, "PaymentSummaryReturn": { "type": "object", "properties": { "ContractNumber": { "type": "string", "description": "Contract number." }, "ReferenceNumber": { "type": "integer", "description": "Reference number.", "format": "int32" }, "Bank": { "type": "string", "description": "Bank CIP code." }, "Agency": { "type": "string", "description": "Branch number." }, "AccountNumber": { "type": "string", "description": "Account number." }, "OperationType": { "type": "string", "description": "Operation type." }, "PaymentDate": { "type": "string", "description": "Payment date.", "format": "date-time" }, "RejectionDate": { "type": "string", "description": "Rejection date.", "format": "date-time" }, "Reason": { "type": "string", "description": "Reason." }, "FirstAttemptDate": { "type": "string", "description": "First attempt date.", "format": "date-time" }, "LastAttemptDate": { "type": "string", "description": "Last attempt date.", "format": "date-time" }, "Status": { "type": "string", "description": "Settlement status." } }, "description": "Payment Summary." }, "SellerReturn": { "type": "object", "properties": { "NumEC": { "type": "string", "description": "Anchor EC number." }, "Name": { "type": "string", "description": "Anchor name." } }, "description": "Anchor." }, "GetPaymentsErrorResponse": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "type": "string" }, "description": "List of errors" } } }, "ResponseBalanceViewModel": { "description": "Response Class for search endpoint", "type": "object", "properties": { "status": { "$ref": "#/definitions/ResponseStatusViewModel", "description": "Response status" }, "balances": { "$ref": "#/definitions/ResponseBalanceSummaryViewModel" } } }, "ResponseBalanceSummaryViewModel": { "description": "Response Class for balances endpoint", "type": "object", "properties": { "expired_balance": { "description": "This block presents the accumulated expired balance. What composes this accumulated expired balance is the sum of unreleased items and commissions as well as the sum of all blocked schedules. All information displayed in this block shows what happened with this type of balance (blocked or expired) until the current date (the date on which the balance query was made). Even if a future date is provided in the query, by definition, only information up to the current date will be displayed.", "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/UnreleasedBalancesSummaryViewModel" } }, "current_balances": { "description": "This block presents the balance sent for payment with payment confirmation. This block displays the amounts that made up the sum of the settlement values. All information displayed in this block shows what happened with this type of balance (current) until the current date (the date on which the balance query was made). Even if a future date is provided in the query, by definition, only information up to the current date will be displayed.", "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/CurrentBalanceSummaryViewModel" } }, "future_balances": { "description": "This block presents the future balance, therefore, that has not yet been sent for payment. This block returns schedules above D+2, schedules with D-1 or D+1 view can be viewed in the Current Balance block, as they are already in settlement flow, or if they are expired/blocked they can be viewed in the Expired Balance block.", "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/FutureBalanceSummaryViewModel" } } } }, "UnreleasedBalancesSummaryViewModel": { "description": "Class responsible for presenting the sum of unreleased balance.", "type": "object", "properties": { "balances": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/UnreleasedBalancesViewModel" } } } }, "CurrentBalanceSummaryViewModel": { "description": "Class responsible for presenting the sum of current balance.", "type": "object", "properties": { "balances": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/CurrentBalanceViewModel" } } } }, "FutureBalanceSummaryViewModel": { "description": "Class responsible for presenting the sum of future balance.", "type": "object", "properties": { "balances": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/FutureBalanceViewModel" } }, "total_amount_paid_future_period": { "format": "double", "description": "Forecast of total amount to be paid in the period.", "type": "number", "readOnly": true } } }, "UnreleasedBalancesViewModel": { "description": "Class responsible for presenting unreleased balance.", "type": "object", "properties": { "merchant_id": { "description": "EC number.", "type": "string" }, "subseller_id": { "format": "int64", "description": "Store identifier. If filled, maximum allowed period = 30 days. If not filled, maximum allowed period = 2 days.", "type": "integer" }, "unreleased_amount": { "format": "double", "description": "Unreleased amount.", "type": "number" }, "unreleased_amount_pix": { "type": "number", "description": "Total amount not yet released for the Pix brand.", "format": "double" }, "unreleased_amount_boleto": { "type": "number", "description": "Total amount not yet released for the Boleto modality.", "format": "double" }, "blocked_amount": { "type": "number", "description": "Blocked amount", "format": "double" }, "balance_date": { "type": "string", "description": "Balance date", "format": "date-time" } } }, "CurrentBalanceViewModel": { "description": "Represents the details of the current balance.", "type": "object", "properties": { "amount_paid": { "type": "number", "description": "Sum of paid or negative balance amount in the last settlement", "format": "double" }, "rejected_payment_value": { "type": "number", "description": "Sum of rejected payment amount in the last settlement", "format": "double" }, "rejected_payment_value_pix": { "type": "number", "description": "Total amount of rejected Pix settlements.", "format": "double" }, "rejected_payment_value_boleto": { "type": "number", "description": "Total amount of rejected Boleto settlements.", "format": "double" }, "liquidation_process_value": { "type": "number", "description": "Sum of amount in settlement process (sent)", "format": "double" }, "liquidation_process_value_pix": { "type": "number", "description": "Total amount of paid Pix settlements.", "format": "double" }, "liquidation_process_value_boleto": { "type": "number", "description": "Total amount of paid Boleto settlements.", "format": "double" }, "total_amount": { "type": "number", "description": "Sum of all values in the detailed sub-block \"released_balances\"", "format": "double" }, "merchant_id": { "type": "string", "description": "EC code" }, "balance_date": { "type": "string", "description": "Balance date" }, "subseller_id": { "type": "integer", "description": "Partner code", "format": "int64" }, "released_balances": { "$ref": "#/definitions/ReleaseBalanceCurrentViewModel" } } }, "FutureBalanceViewModel": { "description": "Represents the details of the future balance.", "type": "object", "properties": { "total_amount": { "format": "double", "description": "Total amount.", "type": "number" }, "unreleased_value": { "format": "double", "description": "Unreleased amount.", "type": "number" }, "merchant_id": { "description": "EC number", "type": "string" }, "balance_date": { "description": "Balance date.", "type": "string" }, "subseller_id": { "format": "int64", "description": "Store identification.", "type": "integer" }, "released_balances": { "$ref": "#/definitions/ReleaseBalanceFutureViewModel" } } }, "ReleaseBalanceCurrentViewModel": { "description": "Represents the details of the current balance.", "type": "object", "properties": { "other_adjustments_value": { "type": "number", "description": "Sum of amount referring to other adjustments posted via BackOffice. Example: card brand fine", "format": "double" }, "commission": { "type": "number", "description": "Sum of commission amount. This field is filled only when it is a balance of an own store", "format": "double" }, "commission_pix": { "type": "number", "description": "Total amount of commissions associated with the Pix brand. This field is filled only for balances of own stores.", "format": "double" }, "commission_boleto": { "type": "number", "description": "Total amount of commissions associated with the Boleto modality. This field is filled only for balances of own stores.", "format": "double" }, "sale_value": { "type": "number", "description": "Sum of sales amount", "format": "double" }, "sale_value_pix": { "type": "number", "description": "Total amount of Pix sales, calculated by the sum of the Pix schedule items.", "format": "double" }, "sale_value_boleto": { "type": "number", "description": "Total amount of Boleto sales, calculated by the sum of the Boleto schedule items.", "format": "double" }, "cancelled_value": { "type": "number", "description": "Sum of canceled sales amount", "format": "double" }, "cancelled_value_pix": { "type": "number", "description": "Total amount of canceled Pix items in the schedule.", "format": "double" }, "chargeBack_value": { "type": "number", "description": "Sum of chargebacks received in the schedule (credit and debit). This field is filled only when it is a balance of an own store", "format": "double" }, "mdr_fee_chargeBack_value": { "type": "number", "description": "Sum of transaction fees charged, returned after chargeback processing", "format": "double" }, "if_anticipation_value": { "type": "number", "description": "Sum of anticipation contracts (credit and debit) from Financial Institutions distributed in the schedule", "format": "double" }, "nf_anticipation_value": { "type": "number", "description": "Sum of anticipation contracts (credit and debit) from Non-Financial Institutions distributed in the schedule", "format": "double" }, "subseller_debit_adjustment_boleto_value": { "type": "number", "description": "Sum of debit adjustments generated to ensure refund of a reversed bank slip amount to the buyer", "format": "double" }, "marketplace_adjustment_entry_value": { "type": "number", "description": "Sum of postings generated for the EC. This field is filled only when it is a balance of an own store", "format": "double" }, "subseller_adjustment_entry_value": { "type": "number", "description": "Sum of postings generated for the partner by the EC. This field is filled only when it is a partner balance", "format": "double" }, "negative_schedule_value": { "type": "number", "description": "Sum of negative schedule amount", "format": "double" }, "negative_shcedule_reversal_value": { "type": "number", "description": "Sum of negative schedule reversal amount. This field is filled only when it is a balance of an own store", "format": "double" } } }, "ReleaseBalanceFutureViewModel": { "type": "object", "properties": { "other_adjustments_value": { "type": "number", "description": "Sum of amount referring to other adjustments posted via BackOffice. Example: card brand fine", "format": "double" }, "commission": { "type": "number", "description": "Sum of commission amount. This field is filled only when it is a balance of an own store", "format": "double" }, "commission_pix": { "type": "number", "description": "Total amount of commissions associated with the Pix brand. This field is filled only for balances of own stores.", "format": "double" }, "commission_boleto": { "type": "number", "description": "Total amount of commissions associated with the Boleto modality. This field is filled only for balances of own stores.", "format": "double" }, "sale_value": { "type": "number", "description": "Sum of sales amount", "format": "double" }, "sale_value_pix": { "type": "number", "description": "Total amount of Pix sales, calculated by the sum of the Pix schedule items.", "format": "double" }, "sale_value_boleto": { "type": "number", "description": "Total amount of Boleto sales, calculated by the sum of the Boleto schedule items.", "format": "double" }, "cancelled_value": { "type": "number", "description": "Sum of canceled sales amount", "format": "double" }, "cancelled_value_pix": { "type": "number", "description": "Total amount of canceled Pix items in the schedule.", "format": "double" }, "chargeBack_value": { "type": "number", "description": "Sum of chargebacks received in the schedule (credit and debit). This field is filled only when it is a balance of an own store", "format": "double" }, "mdr_fee_chargeBack_value": { "type": "number", "description": "Sum of transaction fees charged, returned after chargeback processing", "format": "double" }, "if_anticipation_value": { "type": "number", "description": "Sum of anticipation contracts (credit and debit) from Financial Institutions distributed in the schedule", "format": "double" }, "nf_anticipation_value": { "type": "number", "description": "Sum of anticipation contracts (credit and debit) from Non-Financial Institutions distributed in the schedule", "format": "double" }, "subseller_debit_adjustment_boleto_value": { "type": "number", "description": "Sum of debit adjustments generated to ensure refund of a reversed bank slip amount to the buyer", "format": "double" }, "marketplace_adjustment_entry_value": { "type": "number", "description": "Sum of postings generated for the EC. This field is filled only when it is a balance of an own store", "format": "double" }, "subseller_adjustment_entry_value": { "type": "number", "description": "Sum of postings generated for the partner by the EC. This field is filled only when it is a partner balance", "format": "double" } } }, "ReturnGetAdjustmentEntries": { "description": "Return object of the posting status query request", "type": "object", "properties": { "seller_id": { "description": "MarketPlace Id (SellerId)", "type": "string" }, "seller_total_amount_credit": { "format": "double", "description": "Total amount of credit postings by the Seller", "type": "number", "readOnly": true }, "seller_total_amount_debt": { "format": "double", "description": "Total amount of debit postings by the Seller", "type": "number", "readOnly": true }, "subsellers": { "description": "List of subsellers with adjustments made", "type": "array", "items": { "$ref": "#/definitions/SubsellerAdjustmentEntry" } }, "status": { "$ref": "#/definitions/AdjustmentStatus", "description": "Adjustment Status" } } }, "SubsellerAdjustmentEntry": { "description": "Object representing a subseller posting", "type": "object", "properties": { "subseller_id": { "format": "int32", "description": "Subseller id", "type": "integer" }, "subseller_total_amount_credit": { "format": "double", "description": "Total amount of subseller credits", "type": "number", "readOnly": true }, "subseller_total_amount_debt": { "format": "double", "description": "Total amount of subseller debits", "type": "number", "readOnly": true }, "adjustment_entries": { "description": "List of postings", "type": "array", "items": { "$ref": "#/definitions/AdjustmentEntry" } } } }, "AdjustmentStatus": { "description": "Status class", "type": "object", "properties": { "success": { "description": "Boolean of successful execution", "type": "boolean" }, "status_code": { "description": "Execution status code", "maxLength": 4, "type": "string" }, "message": { "description": "Message associated with the status_code field.", "maxLength": 128, "type": "string" } } }, "AdjustmentEntry": { "description": "Represents a posting", "type": "object", "properties": { "adjustment_entry_id": { "format": "int32", "description": "Posting id", "type": "integer" }, "adjustment_description": { "description": "Posting description", "type": "string" }, "adjustment_type": { "description": "Posting type name", "type": "string", "readOnly": true }, "adjustment_status": { "description": "Posting status name", "type": "string", "readOnly": true }, "adjustment_value": { "format": "double", "description": "Posting amount", "type": "number" }, "adjustment_creation_instant": { "format": "date-time", "description": "Posting creation instant", "type": "string" }, "adjustment_date": { "format": "date-time", "description": "Posting date", "type": "string" } } }, "BrandCard": { "enum": [ 1, 2, 3, 4, 5, 11, 12, 13, 14, 101 ], "description": "Card brand code
* 1 - MASTERCARD
* 2 - MAESTRO
* 3 - VISA
* 4 - VISA ELECTRON
* 5 - AMEX
* 11 - ELO CREDITO
* 12 - ELO DEBITO
* 13 - HIPER-HIPERCARD CREDITO
* 14 – PIX
* 101 - BOLETO SANTANDER
", "type": "integer", "format": "int32" }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "description": "Identifies the type of the problem." }, "title": { "type": "string", "description": "A short and readable summary of the problem type." }, "status": { "type": "integer", "format": "int32", "description": "The HTTP status code generated by the origin server for this occurrence of the problem." }, "detail": { "type": "string", "description": "Problem detail." }, "instance": { "type": "string", "description": "A URI reference that identifies the specific occurrence of the problem." } } }, "ResponseCancelPermission": { "type": "object", "properties": { "justification": { "type": "string", "description": "Description of whether the reported amount can be canceled or not" }, "cancelPermission": { "type": "boolean", "description": "Validation of the returned description. If it can be canceled it comes as true, if not, false" } }, "additionalProperties": false }, "ResponseSummary": { "type": "object", "properties": { "sellerId": { "type": "string", "format": "uuid", "description": "Anchor access key (SellerId)." }, "subSellerId": { "type": "integer", "format": "int64", "description": "Partner code generated by Payment Split." }, "startDate": { "type": "string", "format": "date-time", "description": "Start Date informed in the query" }, "endDate": { "type": "string", "format": "date-time", "description": "End Date informed in the query" }, "merchantId": { "type": "integer", "format": "int64", "description": "Anchor NumEC" }, "summaryBrandCardDay": { "type": "array", "items": { "$ref": "#/definitions/SummaryBrandCardDay" }, "description": "Summary of the Receivable Unit of the day by card brand" }, "summaryDay": { "type": "array", "items": { "$ref": "#/definitions/SummaryDay" }, "description": "Summary of values by day. Here it is not shown which card brand is and therefore you cannot consider receivable unit" } } }, "SummaryBrandCardDay": { "type": "object", "properties": { "brandCard": { "$ref": "#/definitions/BrandCard" }, "date": { "type": "string", "format": "date-time", "description": "Receivable Unit date" }, "gravameAmount": { "type": "number", "format": "double", "description": "Sum of encumbered (locked) amounts that were granted as collateral in negotiations" }, "anticipationAmount": { "type": "number", "format": "double", "description": "Sum of advanced amounts that belong to credit anticipation assignment contracts" }, "freeTotalAmount": { "type": "number", "format": "double", "description": "Sum of total free amount available for deductions of cancellations, postings and adjustments. Postings are made via Adjustments API (https://developers.getnet.com.br/backoffice#operation/V1AdjustmentsRequestAdjustmentsPost)" } }, "additionalProperties": false }, "SummaryDay": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "Date" }, "gravameAmount": { "type": "number", "format": "double", "description": "Sum of encumbered (locked) amounts that were granted as collateral in negotiations for this date." }, "anticipationAmount": { "type": "number", "format": "double", "description": "Sum of advanced amounts that belong to credit anticipation assignment contracts for this date." }, "freeTotalAmount": { "type": "number", "format": "double", "description": "Sum of total free amount available for deductions of cancellations, postings and adjustments for this date. Postings are made via Adjustments API (https://developers.getnet.com.br/backoffice#operation/V1AdjustmentsRequestAdjustmentsPost)" } }, "additionalProperties": false }, "ESimNao": { "enum": [ "S", "N" ], "type": "string", "description": "Valid values: \"S\" (true), \"N\" (false)" }, "RequestBankAccountCustomViewModel": { "required": [ "account", "account_digit", "account_type", "agency", "bank", "brand" ], "type": "object", "properties": { "brand": { "$ref": "#/definitions/eBandeiraProduto" }, "account_type": { "$ref": "#/definitions/eTipoConta" }, "bank": { "type": "integer", "description": "Required\r\n\r\nBank code where the money from sales will be deposited.
\r\n

\r\n Rules:\r\n

\r\n

Must contain a minimum of 1 and a maximum of 3 numeric digits;
Inform according to the list of domains available at: `domains/banks`.

", "format": "int32" }, "agency": { "type": "integer", "description": "Required\r\n\r\nBank branch number where the money from sales will be deposited.
\r\n

\r\n Rules: \r\n For Current (C) or Savings (P) accounts, the filling must follow the following model:

\r\n

Must contain a minimum of 1 and a maximum of 4 numeric digits.
Must be greater than 0 (zero);

\r\n

For Payment (G) type accounts, the filling must follow the following model:

\r\n

Must contain 1 numeric digit;
Must be sent 0 (zero).

", "format": "int32" }, "agency_digit": { "type": "string", "description": "Branch digit" }, "account": { "type": "number", "description": "Required\r\n\r\nAccount number where the money from sales will be deposited.
\r\n

\r\n Rules: \r\n For Current (C) or Savings (P) accounts, the filling must follow the following model:

\r\n

Must contain only numeric digits;
For accounts domiciled at Caixa Econômica Federal, the filling must follow the following model: \r\n
- 4 digits for the account type, 8 digits for the account, the account types are as follows:\r\n
  - 001 – Current Account for Individual;
  - 003 – Current Account for Legal Entity;
  - 006 – Current Account for Public Entity;
  - 013 – Savings Account for Individual;
  - 022 – Savings Account for Legal Entity;
  - 1288 – Savings Account for Individual;
Example: See below how to register an account with number 12345 with different account types (without leading zeros).\r\n
- 001 – Incorrect example: 00100012345, Correct example: 100012345;
- 003 – Incorrect example: 00300012345, Correct example: 300012345;
- 006 – Incorrect example: 00600012345, Correct example: 600012345;
- 013 – Incorrect example: 01300012345, Correct example: 1300012345;
- 022 – Incorrect example: 02200012345, Correct example: 2200012345;
- 1288 – Incorrect example: 128800012345, Correct example: 1288000012345.

\r\n

For Payment (G) type accounts, the filling must follow the following model:

\r\n

Must contain a minimum of 1 and a maximum of 20 numeric digits;
Must be sent 0 (zero) in the branch number field.

", "format": "double" }, "account_digit": { "minLength": 1, "type": "string", "description": "Required\r\n\r\nAccount digit number where the money from sales will be deposited.
\r\n

\r\n Rules:\r\n

\r\n

Must contain 1 numeric digit;
If the account digit is X, replace with 0.

" } }, "additionalProperties": false, "description": "Bank domicile by card brand." }, "RequestBankAccountSubSellerViewModel": { "required": [ "type_accounts" ], "type": "object", "properties": { "type_accounts": { "$ref": "#/definitions/eTipoDomicilioBancario" }, "unique_account": { "$ref": "#/definitions/RequestBankAccountViewModel" }, "custom_accounts": { "type": "array", "items": { "$ref": "#/definitions/RequestBankAccountCustomViewModel" }, "description": "Bank Domicile by card brand. \r\n

Rules:

Send only if type_accounts = \"custom\";
Must provide a bank domicile per available card brand;
Inform bank domicile for all available card brands.

" } }, "additionalProperties": false, "description": "Bank Domicile(s).\r\n

If informed: Payments will only be made to bank domiciles with the same holder as the document (CPF or CNPJ) registered with Getnet. Must be informed following the internal rules of the bank domicile object.

" }, "RequestBankAccountViewModel": { "required": [ "account", "account_digit", "account_type", "agency", "bank" ], "type": "object", "properties": { "account_type": { "$ref": "#/definitions/eTipoConta" }, "bank": { "type": "integer", "description": "Required\r\n\r\nBank code where the money from sales will be deposited.
\r\n

\r\n Rules:\r\n

\r\n

Must contain a minimum of 1 and a maximum of 3 numeric digits;
Inform according to the list of domains available at: `domains/banks`.

", "format": "int32" }, "agency": { "type": "integer", "description": "Required\r\n\r\nBank branch number where the money from sales will be deposited.
\r\n

\r\n Rules: \r\n For Current (C) or Savings (P) accounts, the filling must follow the following model:

\r\n

Must contain a minimum of 1 and a maximum of 4 numeric digits.
Must be greater than 0 (zero);

\r\n

For Payment (G) type accounts, the filling must follow the following model:

\r\n

Must contain 1 numeric digit;
Must be sent 0 (zero).

\r\n Rules: \r\n For Checking (C) or Savings (P) account types, the completion must follow the following model:

\r\n

Must contain only numeric digits;
For accounts with domicile at Caixa Econômica Federal, the completion must follow the following model: \r\n
- 4 digits for account type, 8 digits for the account, the account types are as follows:\r\n
  - 001 – Checking Account for Individual;
  - 003 – Checking Account for Business;
  - 006 – Checking Account for Public Entity;
  - 013 – Savings Account for Individual;
  - 022 – Savings Account for Business;
  - 1288 – Savings Account for Individual;
Example: See below how to register an account with number 12345 with different account types (without leading zeros).\r\n
- 001 – Incorrect example: 00100012345, Correct example: 100012345;
- 003 – Incorrect example: 00300012345, Correct example: 300012345;
- 006 – Incorrect example: 00600012345, Correct example: 600012345;
- 013 – Incorrect example: 01300012345, Correct example: 1300012345;
- 022 – Incorrect example: 02200012345, Correct example: 2200012345;
- 1288 – Incorrect example: 128800012345, Correct example: 1288000012345.

\r\n

For Payment account types (G), the completion must follow the following model:

\r\n

Must contain a minimum of 1 and a maximum of 20 numeric digits;
Must send 0 (zero) in the branch number field.

", "format": "double" }, "account_digit": { "minLength": 1, "type": "string", "description": "Required\r\n\r\nAccount digit number where sales money will be deposited.
\r\n

\r\n Rules:\r\n

\r\n

Must contain 1 numeric digit;
If the account digit is X, replace it with 0.

" } }, "additionalProperties": false, "description": "Unique bank domicile. \r\n

The bank domicile provided will be used for all available card brands.

Rules:

Send only if type_accounts = \"unique\".

" }, "RequestBasicAddressUpdateViewModel": { "required": [ "city", "district", "postal_code", "state", "street" ], "type": "object", "properties": { "street": { "minLength": 1, "type": "string", "description": "Street address \r\n

Rules:

Cannot be empty or null;
We recommend sending this information without special characters;
Should contain the type of street address and name of street address (Example: AVENIDA BORGES DE MEDEIROS).

" }, "number": { "type": "integer", "description": "Street number\r\n

Rules:

If provided, must contain only numeric digits;
For addresses without number, enter null or 0 (zero);
If the value provided is null, the system will understand it is an address without a number and will use 0 (zero) as the default value.

", "format": "int32" }, "district": { "minLength": 1, "type": "string", "description": "Neighborhood name\r\n

Rules:

Cannot be empty or null;
We recommend sending this information without special characters (Incorrect example: SANTO ANDRÉ, Correct example: SANTO ANDRE).

" }, "city": { "minLength": 1, "type": "string", "description": "City name\r\n

Rules:

Cannot be empty or null;
We recommend sending this information without special characters (Incorrect example: SANTO ANDRÉ, Correct example: SANTO ANDRE).

" }, "state": { "minLength": 1, "type": "string", "description": "State code\r\n

Rules:

List of accepted states: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

" }, "postal_code": { "type": "integer", "description": "ZIP code\r\n

Rules:

Must contain only numeric digits;
Must contain a maximum of 8 digits;
Must be valid in the postal ZIP code registry.

", "format": "int32" }, "suite": { "type": "string", "description": "Complement/Reference point\r\n

Rules:

We recommend sending this information without special accented characters;
We do not recommend sending this information containing only numbers (Incorrect example: 406, Correct examples: APT 406, CASA 123).

" } }, "additionalProperties": false, "description": "Address\r\n

If provided:

Must follow the internal rules of the address object.

Mandatory for Anticipation - Required field for receivables anticipation.

" }, "RequestBasicAddressViewModel": { "required": [ "city", "district", "postal_code", "state", "street" ], "type": "object", "properties": { "street": { "minLength": 1, "type": "string", "description": "Street address \r\n

Rules:

Cannot be empty or null;
We recommend sending this information without special characters;
Should contain the type of street address and name of street address (Example: AVENIDA BORGES DE MEDEIROS).

" }, "number": { "type": "integer", "description": "Street number\r\n

Rules:

If provided, must contain only numeric digits;
For addresses without number, enter null or 0 (zero);
If the value provided is null, the system will understand it is an address without a number and will use 0 (zero) as the default value.

", "format": "int32" }, "district": { "minLength": 1, "type": "string", "description": "Neighborhood name\r\n

Rules:

Cannot be empty or null;
We recommend sending this information without special characters (Incorrect example: SANTO ANDRÉ, Correct example: SANTO ANDRE).

" }, "city": { "minLength": 1, "type": "string", "description": "City name\r\n

Rules:

Cannot be empty or null;
We recommend sending this information without special characters (Incorrect example: SANTO ANDRÉ, Correct example: SANTO ANDRE).

" }, "state": { "minLength": 1, "type": "string", "description": "State code\r\n

Rules:

List of accepted states: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

" }, "postal_code": { "type": "integer", "description": "ZIP code\r\n

Rules:

Must contain only numeric digits;
Must contain a maximum of 8 digits;
Must be valid in the postal ZIP code registry.

", "format": "int32" }, "suite": { "type": "string", "description": "Complement/Reference point\r\n

Rules:

We recommend sending this information without special accented characters;
We do not recommend sending this information containing only numbers (Incorrect example: 406, Correct examples: APT 406, CASA 123).

" } }, "additionalProperties": false, "description": "Address\r\n

If provided:

Must follow the internal rules of the address object.

" }, "RequestCellPhoneUpdateViewModel": { "required": [ "area_code", "phone_number" ], "type": "object", "properties": { "area_code": { "type": "integer", "description": "Mobile phone area code\r\n

Rules:

Must be registered in the ANATEL list: 11, 12, 13, 14, 15, 16, 17, 18, 19, 21, 22, 24, 27, 28, 31, 32, 33, 34, 35, 37, 38, 41, 42, 43, 44, 45, 46, 47, 48, 49, 51, 53, 54, 55, 61, 62, 63, 64, 65, 66, 69, 67, 68, 71, 73, 74, 75, 77, 79, 81, 87, 82, 83, 84, 85, 88, 86, 89, 91, 93, 94, 92, 97, 95, 96, 98, 99.

", "format": "int32" }, "phone_number": { "type": "integer", "description": "Mobile phone number\r\n

Rules:

Must have 9 digits;
Must comply with ANATEL rules for mobile phone numbers;
For the following area codes the first digit must be = 9: 11, 12, 13, 14, 15, 16, 17, 18, 19, 21, 22, 24, 27, 28, 31, 32, 33, 34, 35, 37, 38, 41, 42, 43, 44, 45, 68, 71, 73, 74, 75, 77, 79, 81, 87, 82, 83, 84, 85, 88, 86, 89, 91, 93, 94, 92, 97, 95, 96, 98, 99;
For the following area codes the first digit must be = 9 and the second can be: 9, 8 or 7 and the total digits = 9: 41, 46, 47, 48, 49, 51, 53, 54, 55, 61, 62, 64, 65, 66, 67, 69, 68\"

", "format": "int32" } }, "additionalProperties": false, "description": "Mobile phone\r\n

If provided:

Must follow the internal rules of the object.
If a mobile phone is already registered, it will be changed.
If it does not exist, a mobile phone will be registered.

Mandatory for Anticipation - Required field for receivables anticipation.

" }, "RequestCellPhoneViewModel": { "required": [ "area_code", "phone_number" ], "type": "object", "properties": { "area_code": { "type": "integer", "description": "Mobile phone area code\r\n

Rules:

Must be registered in the ANATEL list: 11, 12, 13, 14, 15, 16, 17, 18, 19, 21, 22, 24, 27, 28, 31, 32, 33, 34, 35, 37, 38, 41, 42, 43, 44, 45, 46, 47, 48, 49, 51, 53, 54, 55, 61, 62, 63, 64, 65, 66, 69, 67, 68, 71, 73, 74, 75, 77, 79, 81, 87, 82, 83, 84, 85, 88, 86, 89, 91, 93, 94, 92, 97, 95, 96, 98, 99.

", "format": "int32" }, "phone_number": { "type": "integer", "description": "Mobile phone number\r\n

Rules:

Must have 9 digits;
Must comply with ANATEL rules for mobile phone numbers;
For the following area codes the first digit must be = 9: 11, 12, 13, 14, 15, 16, 17, 18, 19, 21, 22, 24, 27, 28, 31, 32, 33, 34, 35, 37, 38, 41, 42, 43, 44, 45, 68, 71, 73, 74, 75, 77, 79, 81, 87, 82, 83, 84, 85, 88, 86, 89, 91, 93, 94, 92, 97, 95, 96, 98, 99;
For the following area codes the first digit must be = 9 and the second can be: 9, 8 or 7 and the total digits = 9: 41, 46, 47, 48, 49, 51, 53, 54, 55, 61, 62, 64, 65, 66, 67, 69, 68\"

", "format": "int32" } }, "additionalProperties": false, "description": "Mobile phone.\r\n

Rules:

This field is required if \"phone\" is not provided;
If \"phone\" is provided, this field is optional;
If a mobile phone is already registered, it will be changed;
If it does not exist, a mobile phone will be registered.

Mandatory for Anticipation - Required field for receivables anticipation.

" }, "RequestCommissionViewModel": { "required": [ "brand", "payment_plan", "product" ], "type": "object", "properties": { "brand": { "$ref": "#/definitions/eBandeiraProduto" }, "product": { "$ref": "#/definitions/ePlanoVenda" }, "payment_plan": { "type": "integer", "description": "Payment plan.\r\n

Rules:

Must contain only numeric digits;
Send according to the list available in: `domains/paymentplans/{merchant_id}`.

", "format": "int32" }, "commission_percentage": { "type": "number", "description": "Percentage value of fee/commission (%)\r\n

Rules: \r\nThis field is required if \"commission_value\" is not provided;\r\nIf \"commission_value\" is greater than zero, \"commission_percentage\" must be \"null\" or zero;\r\nMust contain only numeric digits and a decimal separator (.); \r\nMust have two decimal places; \r\nValue must be between 0.00 and 100.00 .

", "format": "double" }, "commission_value": { "type": "number", "description": "Fixed fee/commission value\r\n

Rules: \r\nThis field is required if \"commission_percentage\" is not provided;\r\nIf \"commission_percentage\" is greater than zero, \"commission_value\" must be \"null\" or zero;\r\nMust contain only numeric digits and a decimal separator (.); \r\nMust have two decimal places; \r\nValue must be greater than or equal to 0.00.

", "format": "double" } }, "additionalProperties": false, "description": "Fee/Commission by Card Brand and Sales Plan" }, "RequestCompleteAddressViewModel": { "required": [ "city", "district", "postal_code", "residential_address_equals", "state", "street" ], "type": "object", "properties": { "residential_address_equals": { "$ref": "#/definitions/eSimNao" }, "street": { "minLength": 1, "type": "string", "description": "Street address \r\n

Rules:

Cannot be empty or null;
We recommend sending this information without special characters;
Should contain the type of street address and name of street address (Example: AVENIDA BORGES DE MEDEIROS).

" }, "number": { "type": "integer", "description": "Street number\r\n

Rules:

If provided, must contain only numeric digits;
For addresses without number, enter null or 0 (zero);
If the value provided is null, the system will understand it is an address without a number and will use 0 (zero) as the default value.

", "format": "int32" }, "district": { "minLength": 1, "type": "string", "description": "Neighborhood name\r\n

Rules:

Cannot be empty or null;
We recommend sending this information without special characters (Incorrect example: SANTO ANDRÉ, Correct example: SANTO ANDRE).

" }, "city": { "minLength": 1, "type": "string", "description": "City name\r\n

Rules:

Cannot be empty or null;
We recommend sending this information without special characters (Incorrect example: SANTO ANDRÉ, Correct example: SANTO ANDRE).

" }, "state": { "minLength": 1, "type": "string", "description": "State code\r\n

Rules:

List of accepted states: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

" }, "postal_code": { "type": "integer", "description": "ZIP code\r\n

Rules:

Must contain only numeric digits;
Must contain a maximum of 8 digits;
Must be valid in the postal ZIP code registry.

", "format": "int32" }, "suite": { "type": "string", "description": "Complement/Reference point\r\n

Rules:

We recommend sending this information without special accented characters;
We do not recommend sending this information containing only numbers (Incorrect example: 406, Correct examples: APT 406, CASA 123).

" } }, "additionalProperties": false, "description": "Commercial address\r\n

If provided:

Must follow the internal rules of the complete address object.

" }, "RequestDocumentPFUpdateViewModel": { "required": [ "document_issue_date", "document_issuer", "document_issuer_state", "document_number", "document_type" ], "type": "object", "properties": { "document_type": { "$ref": "#/definitions/eTipoDocumentoPF" }, "document_number": { "type": "number", "description": "Identification document number.", "format": "double" }, "document_issue_date": { "type": "string", "description": "Identification document issuance/expedition date.", "format": "date-time" }, "document_issuer": { "minLength": 1, "type": "string", "description": "Identification document issuing body." }, "document_issuer_state": { "minLength": 1, "type": "string", "description": "State issuing the identification document.\r\n

Rules:

List of accepted states: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

" }, "document_expiration_date": { "type": "string", "description": "Identification document expiration date.", "format": "date-time" } }, "additionalProperties": false, "description": "Document (Send RG for Individual)\r\n

If provided:

Must follow the internal rules of the object.

Mandatory for Anticipation - Required field for receivables anticipation.

" }, "RequestDocumentPFViewModel": { "required": [ "document_issue_date", "document_issuer", "document_issuer_state", "document_number", "document_type" ], "type": "object", "properties": { "document_type": { "$ref": "#/definitions/eTipoDocumentoPF" }, "document_number": { "type": "number", "description": "Identification document number.", "format": "double" }, "document_issue_date": { "type": "string", "description": "Identification document issuance/expedition date.", "format": "date-time" }, "document_issuer": { "minLength": 1, "type": "string", "description": "Identification document issuing body." }, "document_issuer_state": { "minLength": 1, "type": "string", "description": "State issuing the identification document.\r\n

Rules:

List of accepted states: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

If provided:

Must follow the internal rules of the object.

" }, "RequestDocumentPJUpdateViewModel": { "required": [ "document_issuer_state", "document_number", "document_type" ], "type": "object", "properties": { "document_type": { "$ref": "#/definitions/eTipoDocumentoPJ" }, "document_number": { "type": "number", "description": "Identification document number.", "format": "double" }, "document_issuer_state": { "minLength": 1, "type": "string", "description": "State issuing the identification document.\r\n

Rules:

List of accepted states: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

" } }, "additionalProperties": false, "description": "Document (Send NIRE for Business)\r\n

If provided:

Must follow the internal rules of the object.

" }, "RequestDocumentPJViewModel": { "required": [ "document_issuer_state", "document_number", "document_type" ], "type": "object", "properties": { "document_type": { "$ref": "#/definitions/eTipoDocumentoPJ" }, "document_number": { "type": "number", "description": "Identification document number.", "format": "double" }, "document_issuer_state": { "minLength": 1, "type": "string", "description": "State issuing the identification document.\r\n

Rules:

List of accepted states: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

" } }, "additionalProperties": false, "description": "Document (Send NIRE for Business)\r\n

If provided:

Must follow the internal rules of the object.

" }, "RequestPartnerLegalDataViewModel": { "required": [ "fiscal_type", "initial_involvement_date", "legal_document_number", "participation_percentage" ], "type": "object", "properties": { "fiscal_type": { "$ref": "#/definitions/eTipoFiscal" }, "legal_document_number": { "type": "string", "description": "Fiscal identifier of the partner from the perspective of the responsible government agency, normally the tax authority. \r\n

Rules:

Must be informed for both individual and legal entity partners.
For individual partner: \r\n
- Send CPF (Individual Taxpayer Registry);
- Must have a maximum of 11 numeric digits (CPF digit calculation will be performed);
- The CPF number must be valid with the Brazilian Federal Tax Authority and be in `REGULAR` status.
For legal entity partner: \r\n
- Send CNPJ (National Registry of Legal Entities);
- Must have 14 characters (CNPJ check digit calculation will be performed): either the legacy purely numeric format, or, as of July 2026, the alphanumeric format (first 8 and next 4 characters alphanumeric, last 2 numeric check digits, letters normalized to UPPERCASE);
- The CNPJ number must be valid with the Brazilian Federal Tax Authority and be in `ACTIVE` status.

" }, "participation_percentage": { "type": "number", "description": "Percentage of equity participation.\r\n

Rules:

Must be informed for both individual and legal entity partners.
Must be informed a value greater than '0' and less than or equal to '100'.

", "format": "double" }, "initial_involvement_date": { "type": "string", "description": "Relationship start date.", "format": "date-time" }, "partner_data (PF)": { "$ref": "#/definitions/RequestPartnerPFViewModel" }, "partner_data (PJ)": { "$ref": "#/definitions/RequestPartnerPJViewModel" } }, "additionalProperties": false, "description": "Partner\r\n

If informed: \r\nMust follow the internal rules of the partner object.

" }, "RequestPartnerPFViewModel": { "required": [ "birth_date", "mothers_name", "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string", "description": "Full name. \r\n

If informed:

Must have at least two names (e.g: Mario Silveira);
We recommend sending this information without special characters, accents or abbreviations;
The full name of the CPF must be informed as registered with the Federal Tax Authority.

" }, "birth_date": { "type": "string", "description": "Date of Birth.\r\n

If informed:

Must be older than 18 years;
The date of birth must correspond to the CPF informed.

", "format": "date-time" }, "sex": { "$ref": "#/definitions/eSexo" }, "nationality": { "type": "string", "description": "Nationality.\r\n

If informed:

Must have 2 characters;
Must inform the country code according to ISO-3166.

" }, "phone": { "$ref": "#/definitions/RequestPhoneBusinessViewModel" }, "cellphone": { "$ref": "#/definitions/RequestCellPhoneViewModel" }, "ppe_indication": { "$ref": "#/definitions/ePPE" }, "ppe_description": { "type": "string", "description": "PEP description.\r\n

If informed:

If the value of the \"ppe_indication\" field equals \"not_applied\", inform \"NAO APLICADO\";
If the value of the \"ppe_indication\" field differs from \"not_applied\", inform the name of the politically exposed person.

", "default": "NAO APLICADO" }, "mothers_name": { "minLength": 1, "type": "string", "description": "Mother's Name.\r\n

If informed:

Must have at least two names (e.g: Maria Silveira);
We recommend sending this information without special characters, accents or abbreviations;
Inform the full name of the mother as shown in an identification document.

" }, "gross_equity": { "type": "number", "description": "Asset value.\r\n

If informed:

Must contain only numeric digits and decimal separator (.);
If there are decimal places, up to two decimal digits will be considered;

", "format": "double" }, "monthly_gross_income": { "type": "number", "description": "Monthly income value \r\n\r\nMandatory submission for individual partner (F)", "format": "double" }, "identification_document": { "$ref": "#/definitions/RequestDocumentPFViewModel" } }, "additionalProperties": false, "description": "Regulatory data for individual\r\n

If informed:

Must follow the internal rules of the individual partner object.

" }, "RequestPartnerPJViewModel": { "required": [ "founding_date", "legal_name" ], "type": "object", "properties": { "legal_name": { "minLength": 1, "type": "string", "description": "Legal name.\r\n

Rules:

We recommend sending this information without special characters, accents or abbreviations;
The complete legal name must be informed as registered with the Federal Tax Authority.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "founding_date": { "type": "string", "description": "CNPJ foundation date as registered with the Federal Tax Authority.\r\n

Rules:

Must be greater than 01/01/1900;
Cannot be greater than the current date.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "format": "date-time" }, "phone": { "$ref": "#/definitions/RequestPhoneBusinessViewModel" }, "cellphone": { "$ref": "#/definitions/RequestCellPhoneUpdateViewModel" }, "identification_document": { "$ref": "#/definitions/RequestDocumentPJViewModel" } }, "additionalProperties": false, "description": " Regulatory data for legal entity\r\n

If informed:

Must follow the internal rules of the legal entity partner object.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "RequestPhoneBusinessViewModel": { "required": [ "area_code", "phone_number" ], "type": "object", "properties": { "area_code": { "type": "integer", "description": "Landline Phone Area Code\r\n

Rules:

Must be registered in the ANATEL list: 11, 12, 13, 14, 15, 16, 17, 18, 19, 21, 22, 24, 27, 28, 31, 32, 33, 34, 35, 37, 38, 41, 42, 43, 44, 45, 46, 47, 48, 49, 51, 53, 54, 55, 61, 62, 63, 64, 65, 66, 69, 67, 68, 71, 73, 74, 75, 77, 79, 81, 87, 82, 83, 84, 85, 88, 86, 89, 91, 93, 94, 92, 97, 95, 96, 98, 99.

", "format": "int32" }, "phone_number": { "type": "integer", "description": "Landline Phone Number\r\n

Rules:

Must comply with ANATEL's landline phone number rule;
The first digit can only be: 2 or 3 or 4 or 5;
The total number of digits must be = 8 (eight).

", "format": "int32" } }, "additionalProperties": false, "description": "Residential Phone\r\n

Rules:

This field is mandatory if \"cellphone\" is not informed;
If \"cellphone\" is informed this field is optional;
If a residential phone is already registered, it will be updated;
If it does not exist, a residential phone will be registered.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "RequestPhoneResidentialUpdateViewModel": { "required": [ "area_code", "phone_number" ], "type": "object", "properties": { "area_code": { "type": "integer", "description": "Landline Phone Area Code\r\n

Rules:

Must be registered in the ANATEL list: 11, 12, 13, 14, 15, 16, 17, 18, 19, 21, 22, 24, 27, 28, 31, 32, 33, 34, 35, 37, 38, 41, 42, 43, 44, 45, 46, 47, 48, 49, 51, 53, 54, 55, 61, 62, 63, 64, 65, 66, 69, 67, 68, 71, 73, 74, 75, 77, 79, 81, 87, 82, 83, 84, 85, 88, 86, 89, 91, 93, 94, 92, 97, 95, 96, 98, 99.

", "format": "int32" }, "phone_number": { "type": "integer", "description": "Landline Phone Number\r\n

Rules:

Must comply with ANATEL's landline phone number rule;
The first digit can only be: 2 or 3 or 4 or 5;
The total number of digits must be = 8 (eight).

", "format": "int32" } }, "additionalProperties": false, "description": "Residential Phone\r\n

If informed:

Must follow the internal rules of the object.
If a residential phone is already registered, it will be updated.
If it does not exist, a residential phone will be registered.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "RequestPhoneResidentialViewModel": { "required": [ "area_code", "phone_number" ], "type": "object", "properties": { "area_code": { "type": "integer", "description": "Landline Phone Area Code\r\n

Rules:

Must be registered in the ANATEL list: 11, 12, 13, 14, 15, 16, 17, 18, 19, 21, 22, 24, 27, 28, 31, 32, 33, 34, 35, 37, 38, 41, 42, 43, 44, 45, 46, 47, 48, 49, 51, 53, 54, 55, 61, 62, 63, 64, 65, 66, 69, 67, 68, 71, 73, 74, 75, 77, 79, 81, 87, 82, 83, 84, 85, 88, 86, 89, 91, 93, 94, 92, 97, 95, 96, 98, 99.

", "format": "int32" }, "phone_number": { "type": "integer", "description": "Landline Phone Number\r\n

Rules:

Must comply with ANATEL's landline phone number rule;
The first digit can only be: 2 or 3 or 4 or 5;
The total number of digits must be = 8 (eight).

", "format": "int32" } }, "additionalProperties": false, "description": "Residential Phone\r\n

Rules:

This field is mandatory if \"cellphone\" is not informed.
If \"cellphone\" is informed this field is optional.

" }, "RequestPreSubSellerPFIncludeViewModel": { "required": [ "accepted_contract", "bank_accounts", "birth_date", "business_address", "email", "legal_document_number", "legal_name", "merchant_id", "occupation", "payment_plan" ], "type": "object", "properties": { "merchant_id": { "minLength": 1, "type": "string", "description": "Identification number (EC) of the Marketplace in GETNET.\r\n

Rules:

Must contain only numeric digits.

" }, "legal_document_number": { "type": "integer", "description": "CPF number (Individual Taxpayer Registry).\r\n

Rules:

Must have a maximum of 11 numeric digits (CPF digit calculation will be performed);
The CPF number must be valid with the Brazilian Federal Tax Authority and be in `REGULAR` status.

", "format": "int64" }, "legal_name": { "minLength": 1, "type": "string", "description": "Full name. \r\n

Rules:

Must have at least two names (e.g: Mario Silveira);
We recommend sending this information without special characters, accents or abbreviations;
The full name of the CPF must be informed as registered with the Federal Tax Authority.

" }, "birth_date": { "type": "string", "description": "Date of Birth.\r\n

Rules:

Must be older than 18 years;
The date of birth must correspond to the CPF informed.

", "format": "date-time" }, "mothers_name": { "type": "string", "description": "Mother's Name.\r\n

Rules:

Must have at least two names (e.g: Maria Silveira);
We recommend sending this information without special characters, accents or abbreviations;
Inform the full name of the mother of the CPF as shown in an identification document.

" }, "occupation": { "minLength": 1, "type": "string", "description": "Profession / Business Activity.\r\n

If informed:

We recommend sending this information without special characters (Incorrect example: MÉDICO, Correct example: MEDICO).

" }, "subsellerid_ext": { "type": "string", "description": "Unique identifier of the External SubSeller.\r\n

Return: The return value contains up to 50 characters;

" }, "monthly_gross_income": { "type": "number", "description": "Income value of the CPF informed. \r\n

Rules:

Must be greater than zero.

", "format": "double" }, "gross_equity": { "type": "number", "description": "Asset value.\r\n

Rules:

Mandatory submission for individual (F).
Must be greater than 0.

", "format": "double" }, "business_address": { "$ref": "#/definitions/RequestCompleteAddressViewModel" }, "residential_address": { "$ref": "#/definitions/RequestResidentialAddressViewModel" }, "phone": { "$ref": "#/definitions/RequestPhoneResidentialViewModel" }, "cellphone": { "$ref": "#/definitions/RequestCellPhoneViewModel" }, "email": { "minLength": 1, "type": "string", "description": "Email.\r\n

Rules:

Must have a valid email format (Example: name@domain.com);
Cannot contain accents or special characters;
The domain cannot be @getnet or @santander.

" }, "identification_document": { "$ref": "#/definitions/RequestDocumentPFUpdateViewModel" }, "bank_accounts": { "$ref": "#/definitions/RequestBankAccountSubSellerViewModel" }, "list_commissions": { "type": "array", "items": { "$ref": "#/definitions/RequestCommissionViewModel" }, "description": "List of commissions by brand and product.\r\n

If informed:

Must follow the internal rules of the commission object.

" }, "payment_plan": { "type": "integer", "description": "SubSeller Payment Plan.\r\n

Rules:

Must contain only numeric digits;
Inform according to the list available at: `domains/paymentplans/{merchant_id}`.

", "format": "int32" }, "accepted_contract": { "$ref": "#/definitions/ESimNao", "description": "SubSeller acceptance of Getnet Acquiring settlement services.\r\n

Rules: \r\nMust be \"S\". Although the field accepts \"N\", the registration only proceeds with \"S\"; \"N\" is rejected.

" }, "marketplace_store": { "$ref": "#/definitions/eSimNao" }, "automatic_anticipation": { "$ref": "#/definitions/eSimNao" }, "list_centralizer": { "type": "array", "items": { "type": "string" }, "description": "List of Centralized EC.\r\n

Rules:

The numbers of the EC's (Anchors) that will receive the replication of the store registration through a single registration must be informed;
These EC's must be configured in the system as centralized by a Centralizing EC (this one, informed in the 'merchant_id' field).

" } }, "additionalProperties": false, "description": "Data model used for inclusion and update of Individual SubSeller" }, "RequestPreSubSellerPFUpdateViewModel": { "required": [ "legal_document_number", "merchant_id", "subseller_id" ], "type": "object", "properties": { "merchant_id": { "minLength": 1, "type": "string", "description": "Identification number (EC) of the Marketplace in GETNET.\r\n

Rules:

Must contain only numeric digits.

" }, "subseller_id": { "type": "integer", "description": "Unique identifier of the SubSeller.\r\n

Rules:

Must contain only numeric digits;
Must contain a maximum of 9 digits.

", "format": "int32" }, "legal_document_number": { "type": "integer", "description": "CPF number (Individual Taxpayer Registry).\r\n

Rules:

Must have a maximum of 11 numeric digits (CPF digit calculation will be performed);
The CPF number must be valid with the Brazilian Federal Tax Authority and be in `REGULAR` status.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "format": "int64" }, "legal_name": { "type": "string", "description": "Full name. \r\n

Rules: \r\nThis attribute is optional during additional registration;\r\nIf informed:

Must have at least two names (e.g: Mario Silveira);
We recommend sending this information without special characters, accents or abbreviations;
The full name of the CPF must be informed as registered with the Federal Tax Authority.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "date": { "type": "string", "description": "Date of Birth.\r\n

Rules:

Must be older than 18 years;
The date of birth must correspond to the CPF informed.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "format": "date-time" }, "sex": { "$ref": "#/definitions/eSexo" }, "mothers_name": { "type": "string", "description": "Mother's Name.\r\n

If informed:

Must have at least two names (e.g: Maria Silveira);
We recommend sending this information without special characters, accents or abbreviations;
Inform the full name of the mother as shown in an identification document.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "fathers_name": { "type": "string", "description": "Father's full name.\r\n

If informed:

Must have at least two names (e.g: Mario Silveira);
We recommend sending this information without special characters, accents or abbreviations;
Inform the full name of the father as shown in an identification document.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "gross_equity": { "type": "number", "description": "Asset value.\r\n

If informed:

Must contain only numeric digits and decimal separator (.);
If there are decimal places, up to two decimal digits will be considered;

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "format": "double" }, "monthly_gross_income": { "type": "number", "description": "Income value of the CPF informed. \r\n

If informed:

Must contain only numeric digits and decimal separator (.);
If there are decimal places, up to two decimal digits will be considered;
Must be greater than or equal to 100.00.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "format": "double" }, "business_address": { "$ref": "#/definitions/RequestBasicAddressUpdateViewModel" }, "residential_address": { "$ref": "#/definitions/RequestBasicAddressUpdateViewModel" }, "birth_city": { "type": "string", "description": "City of birth.\r\n

If informed:

We recommend sending this information without special characters (Incorrect example: SANTO ANDRÉ, Correct example: SANTO ANDRE).

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "birth_state": { "type": "string", "description": "State of birth.\r\n

If informed:

List of accepted states: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "identification_document": { "$ref": "#/definitions/RequestDocumentPFUpdateViewModel" }, "phone": { "$ref": "#/definitions/RequestPhoneResidentialUpdateViewModel" }, "cellphone": { "$ref": "#/definitions/RequestCellPhoneViewModel" }, "nationality": { "type": "string", "description": "Nationality.\r\n

Rules:

Must have 2 characters;
Must inform the country code according to ISO-3166.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "ppe_indication": { "$ref": "#/definitions/ePPE" }, "ppe_description": { "type": "string", "description": "PEP description.\r\n

If informed:

If the value of the \"ppe_indication\" field equals \"not_applied\", inform \"NAO APLICADO\";
If the value of the \"ppe_indication\" field differs from \"not_applied\", inform the name of the politically exposed person.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "email": { "type": "string", "description": "Email.\r\n

Rules:

Must have a valid email format (Example: name@domain.com);
Cannot contain accents or special characters;
The domain cannot be @getnet or @santander.

Mandatory for Anticipation - Required field for receivables anticipation.

" }, "occupation": { "type": "string", "description": "Profession / Business Activity.\r\n

If provided:

We recommend sending this information without special characters (Incorrect example: MÉDICO, Correct example: MEDICO).

Mandatory for Anticipation - Required field for receivables anticipation.

" }, "automatic_anticipation": { "$ref": "#/definitions/eSimNao" }, "marketplace_store": { "$ref": "#/definitions/eSimNao" }, "payment_plan": { "type": "integer", "description": "SubSeller Payment Plan.\r\n

Rules:

Must contain only numeric digits;
Inform according to the list available at: `domains/paymentplans/{merchant_id}`

", "format": "int32" }, "bank_accounts": { "$ref": "#/definitions/RequestBankAccountSubSellerViewModel" }, "list_commissions": { "type": "array", "items": { "$ref": "#/definitions/RequestCommissionViewModel" }, "description": "List of commissions by card brand and product.\r\n

If provided:

Must follow the internal rules of the commission object.

" }, "subsellerid_ext": { "type": "string", "description": "Unique identifier of the External SubSeller." }, "list_centralizer": { "type": "array", "items": { "type": "string" }, "description": "List of Centralized EC." } }, "additionalProperties": false, "description": "Registration class for complementary information PF" }, "RequestPreSubSellerPJIncludeViewModel": { "required": [ "accepted_contract", "bank_accounts", "business_address", "email", "legal_document_number", "legal_name", "merchant_id", "payment_plan", "state_fiscal_document_number", "trade_name" ], "type": "object", "properties": { "merchant_id": { "minLength": 1, "type": "string", "description": "Identification number (EC) of the Marketplace at GETNET.\r\n

Rules:

Must contain only numeric digits.

" }, "legal_document_number": { "minLength": 14, "maxLength": 14, "type": "string", "description": "CNPJ number (National Register of Legal Entities).\r\n

Rules:

Must have 14 characters (CNPJ check digit calculation will be performed);
The CNPJ number must be valid with the Brazilian tax authority and be in `ACTIVE` status.
As of July 2026, CNPJ format is alphanumeric: the first 8 characters must be alphanumeric (letters and numbers), the next 4 characters must also be alphanumeric, and the last 2 characters must be numeric (check digits); letters are automatically normalized to UPPERCASE.
The purely numeric CNPJ format issued before July 2026 remains valid.
The relationship between headquarters (matriz) and branches (filiais) is maintained through the CNPJ's root/radical, in both the alphanumeric and purely numeric formats.

" }, "legal_name": { "minLength": 1, "type": "string", "description": "SubSeller business name.\r\n

Rules:

We recommend sending this information without special characters, accents or abbreviations;
The full business name must be informed as registered with the tax authority.

" }, "trade_name": { "minLength": 1, "type": "string", "description": "SubSeller trade name.\r\n

Rules:

Cannot be empty;
We recommend sending this information without special accent characters.

" }, "subsellerid_ext": { "type": "string", "description": "Unique identifier of the External SubSeller.\r\n

Return: The return value contains up to 50 characters;

" }, "state_fiscal_document_number": { "minLength": 1, "type": "string", "description": "State Registration of the SubSeller.\r\n

Rules:

Cannot be empty;
Can be text (\"EXEMPT\") or only numeric digits;
When the company is required to register state registration, only numeric digits must be provided;
When it does not have it, inform \"EXEMPT\".

" }, "email": { "minLength": 1, "type": "string", "description": "Email.\r\n

Rules:

Must have a valid email format (Example: name@domain.com);
Cannot contain accents or special characters;
The domain cannot be @getnet or @santander.

" }, "phone": { "$ref": "#/definitions/RequestPhoneBusinessViewModel" }, "cellphone": { "$ref": "#/definitions/RequestCellPhoneViewModel" }, "business_address": { "$ref": "#/definitions/RequestBasicAddressViewModel" }, "bank_accounts": { "$ref": "#/definitions/RequestBankAccountSubSellerViewModel" }, "list_commissions": { "type": "array", "items": { "$ref": "#/definitions/RequestCommissionViewModel" }, "description": "List of commissions by card brand and product.\r\n

If provided:

Must follow the internal rules of the commission object.

" }, "accepted_contract": { "$ref": "#/definitions/eSimNao", "description": "SubSeller acceptance of Getnet Acquiring settlement services.\r\n

Rules: \r\nMust be \"S\". Although the field accepts \"N\", the registration only proceeds with \"S\"; \"N\" is rejected.

" }, "marketplace_store": { "$ref": "#/definitions/eSimNao" }, "automatic_anticipation": { "$ref": "#/definitions/eSimNao" }, "payment_plan": { "type": "integer", "description": "SubSeller Payment Plan.\r\n

Rules:

Must contain only numeric digits;
Inform according to the list available at: `domains/paymentplans/{merchant_id}`

", "format": "int32" }, "business_entity_type": { "type": "integer", "description": "Inform the code of the legal nature of the company as shown on the CNPJ card\r\n

Rules:

Must contain only numeric digits;
Must have 4 numeric digits.

", "format": "int32" }, "economic_activity_classification_code": { "type": "integer", "description": " Inform the primary CNAE of the company as shown on the CNPJ card\r\n

Rules:

Must contain only numeric digits;
Must have 6 or 7 numeric digits.

", "format": "int32" }, "monthly_gross_income": { "type": "number", "description": " Inform the monthly revenue of the company. If the company does not have one year of registration, the projected revenue must be provided.\r\n

Rules:

Must contain only numeric digits;
Must be greater than R$100.00.

", "format": "double" }, "billing_value": { "type": "number", "description": " Inform the annual revenue of the company. If the company does not have one year of registration, the projected revenue must be provided.\r\n

Rules:

Must contain only numeric digits;
Must be greater than R$100.00.

Mandatory for Anticipation - Required field for receivables anticipation.

", "format": "double" }, "billing_date": { "type": "string", "description": "Revenue date.", "format": "date-time" }, "federal_registration_status": { "$ref": "#/definitions/eStatusReceita" }, "founding_date": { "type": "string", "description": "CNPJ founding date as recorded with the tax authority.\r\n

Rules:

Must be greater than 01/01/1900;
Cannot be greater than the current date.

", "format": "date-time" }, "identification_document": { "$ref": "#/definitions/RequestDocumentPJUpdateViewModel" }, "legal_representative": { "$ref": "#/definitions/RequestRepresentanteLegalViewModel" }, "shareholders": { "type": "array", "items": { "$ref": "#/definitions/RequestPartnerLegalDataViewModel" }, "description": "List of SubSeller Partners." }, "list_centralizer": { "type": "array", "items": { "type": "string" }, "description": "List of Centralized EC.\r\n

Rules:

Must inform the EC numbers (Anchors) that will receive the replication of the store registration through a single registration;
These ECs must be configured in the system as centralized by a Centralizing EC (this one, informed in the 'merchant_id' field).

" } }, "additionalProperties": false, "description": "Data model used for including and updating PJ SubSeller" }, "RequestPreSubSellerPJUpdateViewModel": { "required": [ "legal_document_number", "merchant_id", "subseller_id" ], "type": "object", "properties": { "merchant_id": { "minLength": 1, "type": "string", "description": "Identification number (EC) of the Marketplace at GETNET.\r\n

Rules:

Must contain only numeric digits.

" }, "subseller_id": { "type": "integer", "description": "Unique identifier of the SubSeller.\r\n

Rules:

Must contain only numeric digits;
Must contain a maximum of 9 digits.

", "format": "int32" }, "subsellerid_ext": { "type": "string", "description": "Unique identifier of the External SubSeller.\r\n

Return: The return value contains up to 50 characters;

" }, "legal_document_number": { "type": "integer", "description": "CNPJ number (National Register of Legal Entities).\r\n

Rules:

Must have a maximum of 14 numeric digits (CNPJ digit calculation will be performed);
The CNPJ number must be valid with the Brazilian tax authority and be in `ACTIVE` status.

Mandatory for Anticipation - Required field for receivables anticipation.

", "format": "int64" }, "legal_name": { "type": "string", "description": "Business name.\r\n

Rules:

Cannot contain special characters, accents or abbreviations;
The full business name must be informed as registered with the tax authority.

Mandatory for Anticipation - Required field for receivables anticipation.

" }, "trade_name": { "type": "string", "description": "SubSeller trade name.\r\n

Rules:

Cannot be empty;
We recommend sending this information without special accent characters.

Mandatory for Anticipation - Required field for receivables anticipation.

" }, "founding_date": { "type": "string", "description": "CNPJ founding date as recorded with the tax authority.\r\n

Rules:

Must be greater than 01/01/1900;
Cannot be greater than the current date.

Mandatory for Anticipation - Required field for receivables anticipation.

", "format": "date-time" }, "business_entity_type": { "type": "integer", "description": "Inform the code of the legal nature of the company as shown on the CNPJ card\r\n

Rules:

Must contain only numeric digits;
Must have 4 numeric digits.

Mandatory for Anticipation - Required field for receivables anticipation.

Rules:

Must contain only numeric digits;
Must be greater than R$100.00.

Mandatory for Anticipation - Required field for receivables anticipation.

Rules:

Must contain only numeric digits;
Must be greater than R$100.00.

Mandatory for Anticipation - Required field for receivables anticipation.

", "format": "double" }, "billing_date": { "type": "string", "description": "Revenue date.\r\n

Mandatory for Anticipation - Required field for receivables anticipation.

", "format": "date-time" }, "phone": { "$ref": "#/definitions/RequestPhoneBusinessViewModel" }, "cellphone": { "$ref": "#/definitions/RequestCellPhoneViewModel" }, "business_address": { "$ref": "#/definitions/RequestBasicAddressUpdateViewModel" }, "economic_activity_classification_code": { "type": "integer", "description": " Inform the primary CNAE of the company as shown on the CNPJ card\r\n

Rules:

Must contain only numeric digits;
Must have 6 or 7 numeric digits.

Mandatory for Anticipation - Required field for receivables anticipation.

", "format": "int32" }, "federal_registration_status": { "$ref": "#/definitions/eStatusReceita" }, "federal_registration_status_date": { "type": "string", "description": "Date of the SubSeller's status with the Federal Tax Authority.\r\n

Mandatory for Anticipation - Required field for receivables anticipation.

", "format": "date-time" }, "state_fiscal_document_number": { "type": "string", "description": "State Registration of the SubSeller.\r\n

Rules:

Cannot be empty;
Can be text (\"EXEMPT\") or only numeric digits;
When the company is required to register state registration, only numeric digits must be provided;
When it does not have it, inform \"EXEMPT\".

Mandatory for Anticipation - Required field for receivables anticipation.

" }, "email": { "type": "string", "description": "Email.\r\n

If provided:

Must have a valid email format (Example: name@domain.com);
Cannot contain accents or special characters;
The domain cannot be @getnet or @santander.

Mandatory for Anticipation - Required field for receivables anticipation.

" }, "identification_document": { "$ref": "#/definitions/RequestDocumentPJUpdateViewModel" }, "legal_representative": { "$ref": "#/definitions/RequestRepresentanteLegalUpdateViewModel" }, "shareholders": { "type": "array", "items": { "$ref": "#/definitions/RequestPartnerLegalDataViewModel" }, "description": "List of Partners.\r\n

Mandatory for Anticipation - Required field for receivables anticipation.

If provided:

Must contain only numeric digits;
Inform according to the list available at: `domains/paymentplans/{merchant_id}`

", "format": "int32" }, "block_payments": { "$ref": "#/definitions/eSimNao" }, "block_transactions": { "$ref": "#/definitions/eSimNao" }, "bank_accounts": { "$ref": "#/definitions/RequestBankAccountSubSellerViewModel" }, "list_commissions": { "type": "array", "items": { "$ref": "#/definitions/RequestCommissionViewModel" }, "description": "List of commissions by card brand and product.\r\n

If provided: \r\nMust follow the internal rules of the commission object.

" }, "list_centralizer": { "type": "array", "items": { "type": "string" }, "description": "List of Centralized EC." } }, "additionalProperties": false, "description": "Registration class for complementary information PJ" }, "RequestRepresentanteLegalUpdateViewModel": { "required": [ "legal_document_number" ], "type": "object", "properties": { "legal_document_number": { "type": "integer", "description": "CPF number (Individual Taxpayer Registry).\r\n

Rules:

Must have a maximum of 11 numeric digits (CPF digit calculation will be performed);
The CPF number must be valid with the Brazilian tax authority and be in `REGULAR` status.

Mandatory for Anticipation - Required field for receivables anticipation.

", "format": "int64" }, "identification_document": { "$ref": "#/definitions/RequestDocumentPFUpdateViewModel" }, "monthly_gross_income": { "type": "number", "description": "Value of monthly income of the informed CPF. \r\n

If provided:

Must be greater than or equal to R$100.00.

Mandatory for Anticipation - Required field for receivables anticipation.

", "format": "double" }, "name": { "type": "string", "description": "Full name. \r\n

Rules:

Must have at least two names (ex: Mario Silveira);
We recommend sending this information without special characters, accents or abbreviations;
The full name from the CPF must be informed as registered with the tax authority.

Mandatory for Anticipation - Required field for receivables anticipation.

" }, "mothers_name": { "type": "string", "description": "Mother's name.\r\n

If provided:

Must have at least two names (ex. Maria Silveira);
We recommend sending this information without special characters, accents or abbreviations;
Inform the full name of the mother as shown in the identification document.

Mandatory for Anticipation - Required field for receivables anticipation.

" }, "fathers_name": { "type": "string", "description": "Father's full name.\r\n

If provided:

Must have at least two names (ex. Mario Silveira);
We recommend sending this information without special characters, accents or abbreviations;
Inform the full name of the father as shown in the identification document.

Mandatory for Anticipation - Required field for receivables anticipation.

" }, "birth_date": { "type": "string", "description": "Date of Birth.\r\n

If provided:

Must be greater than 18 years;
The date of birth must correspond to the informed CPF.

Mandatory for Anticipation - Required field for receivables anticipation.

", "format": "date-time" }, "sex": { "$ref": "#/definitions/eSexo" }, "nationality": { "type": "string", "description": "Nationality.\r\n

If provided:

Must have 2 characters;
Must inform the country code according to ISO-3166.

Mandatory for Anticipation - Required field for receivables anticipation.

" }, "phone": { "$ref": "#/definitions/RequestPhoneBusinessViewModel" }, "cellphone": { "$ref": "#/definitions/RequestCellPhoneUpdateViewModel" }, "ppe_indication": { "$ref": "#/definitions/ePPE" }, "ppe_description": { "type": "string", "description": "PEP description.\r\n

If provided:

If the value of the \"ppe_indication\" field equals \"not_applied\", inform \"NAO APLICADO\";
If the value of the \"ppe_indication\" field is different from \"not_applied\", inform the name of the politically exposed person.

Mandatory for Anticipation - Required field for receivables anticipation.

", "default": "NAO APLICADO" }, "birth_city": { "type": "string", "description": "City of birth.\r\n

If provided:

We recommend sending this information without special characters (Incorrect example: SANTO ANDRÉ, Correct example: SANTO ANDRE).

Mandatory for Anticipation - Required field for receivables anticipation.

" }, "birth_state": { "type": "string", "description": "State of birth.\r\n

If provided:

List of accepted states: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

Mandatory for Anticipation - Required field for receivables anticipation.

" }, "monthly_gross_income_date": { "type": "string", "description": "Reference date for Monthly Income.\r\n

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "format": "date-time" }, "gross_equity": { "type": "number", "description": "Asset value.", "format": "double" } }, "additionalProperties": false, "description": "Legal representative of the Subseller.\r\n

If provided:

Must follow the internal rules of the object.
If a mobile phone is registered, it will be changed.
If it does not exist, a mobile phone will be registered.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "RequestRepresentanteLegalViewModel": { "required": [ "birth_date", "legal_document_number", "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string", "description": "Required\r\n\r\nFull name.
\r\n

\r\n Rules:\r\n

\r\n

Must have at least two names (e.g.: Mario Silveira);
We recommend sending this information without special characters, accents or abbreviations;
The full name of the CPF must be informed as registered with the Federal Revenue Service.

" }, "birth_date": { "type": "string", "description": "Required\r\n\r\nDate of Birth.
\r\n

\r\n Rules:\r\n

\r\n

Must be older than 18 years and younger than 80;
The date of birth must correspond to the CPF provided.

", "format": "date-time" }, "legal_document_number": { "type": "integer", "description": "Required\r\n\r\nCPF number (Individual Taxpayer Registry).
\r\n

\r\n Rules:\r\n

\r\n

Must have a maximum of 11 numeric digits (CPF digit calculation will be performed);
The CPF number must be valid with Brazil's Federal Revenue Service and in `REGULAR` status.

", "format": "int64" }, "sex": { "$ref": "#/definitions/eSexo" }, "nationality": { "type": "string", "description": "Nationality.\r\n

Rules:

Must have 2 characters;
Must provide the country code according to ISO-3166.

" }, "ppe_indication": { "$ref": "#/definitions/ePPE" }, "ppe_description": { "type": "string", "description": "PEP description.\r\n

Rules:

If the value of the \"ppe_indication\" field equals \"not_applied\", provide \"NAO APLICADO\";
If the value of the \"ppe_indication\" field is different from \"not_applied\", provide the name of the politically exposed person.

", "default": "NAO APLICADO" }, "birth_city": { "type": "string", "description": "City of birth.\r\n

If provided:

We recommend sending this information without special characters (Incorrect example: SANTO ANDRÉ, Correct example: SANTO ANDRE).

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "birth_state": { "type": "string", "description": "State of birth.\r\n

If provided:

Accepted state list: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "mothers_name": { "type": "string", "description": "Mother's name.\r\n

If provided:

Must have at least two names (e.g.: Maria Silveira);
We recommend sending this information without special characters, accents or abbreviations;
Provide the full name of the mother as it appears in the identification document.

" }, "fathers_name": { "type": "string", "description": "Father's full name.\r\n

If provided:

Must have at least two names (e.g.: Mario Silveira);
We recommend sending this information without special characters, accents or abbreviations;
Provide the full name of the father as it appears in the identification document.

" }, "identification_document": { "$ref": "#/definitions/RequestDocumentPFViewModel" }, "monthly_gross_income": { "type": "number", "description": "Monthly income value.", "format": "double" }, "monthly_gross_income_date": { "type": "string", "description": "Reference date for Monthly Income.", "format": "date-time" }, "gross_equity": { "type": "number", "description": "Asset value.", "format": "double" } }, "additionalProperties": false, "description": "Legal representative of the Subseller.\r\n

If provided: \r\nMust follow the internal rules of the legal representative object.

" }, "RequestResidentialAddressViewModel": { "required": [ "city", "district", "postal_code", "state", "street" ], "type": "object", "properties": { "street": { "minLength": 1, "type": "string", "description": "Street Address \r\n

Rules:

Cannot be empty or null;
We recommend sending this information without special characters;
Must contain the type of address and name of the address (Example: AVENIDA BORGES DE MEDEIROS).

" }, "number": { "type": "integer", "description": "Street Number\r\n

Rules:

If provided, must contain only numeric digits;
For addresses without a number, provide null or 0 (zero);
If the value provided is null, the system will understand that it is an address without a number and will use 0 (zero) as the default value.

", "format": "int32" }, "district": { "minLength": 1, "type": "string", "description": "Neighborhood Name\r\n

Rules:

Cannot be empty or null;
We recommend sending this information without special characters (Incorrect example: SANTO ANDRÉ, Correct example: SANTO ANDRE).

" }, "city": { "minLength": 1, "type": "string", "description": "City Name\r\n

Rules:

Cannot be empty or null;
We recommend sending this information without special characters (Incorrect example: SANTO ANDRÉ, Correct example: SANTO ANDRE).

" }, "state": { "minLength": 1, "type": "string", "description": "State Code\r\n

Rules:

Accepted state list: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

" }, "postal_code": { "type": "integer", "description": "ZIP Code\r\n

Rules:

Must contain only numeric digits;
Must contain a maximum of 8 digits;
Must be valid in the postal code registry.

", "format": "int32" }, "suite": { "type": "string", "description": "Complement/Reference Point\r\n

Rules:

We recommend sending this information without special accent characters;
We do not recommend sending this information containing only numbers (Incorrect example: 406, Correct examples: APT 406, CASA 123).

" } }, "additionalProperties": false, "description": "Residential address\r\n

If provided:

Must follow the internal rules of the residential address object.

" }, "RequestSubSellerPFUpdateViewModel": { "required": [ "legal_document_number", "merchant_id", "subseller_id" ], "type": "object", "properties": { "merchant_id": { "minLength": 1, "type": "string", "description": "Identification number (EC) of the Marketplace at GETNET.\r\n

Rules:

Must contain only numeric digits.

" }, "subseller_id": { "type": "integer", "description": "Unique identifier of the SubSeller.\r\n

Rules:

Must contain only numeric digits;
Must contain a maximum of 9 digits.

", "format": "int32" }, "legal_document_number": { "type": "integer", "description": "CPF number (Individual Taxpayer Registry).\r\n

Rules:

Must have a maximum of 11 numeric digits (CPF digit calculation will be performed);
The CPF number must be valid with Brazil's Federal Revenue Service and in `REGULAR` status.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "format": "int64" }, "legal_name": { "type": "string", "description": "Full name. \r\n

If provided:

Must have at least two names (e.g.: Mario Silveira);
We recommend sending this information without special characters, accents or abbreviations;
The full name of the CPF must be informed as registered with the Federal Revenue Service.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "birth_date": { "type": "string", "description": "Date of Birth.\r\n

If provided:

Must be older than 18 years;
The date of birth must correspond to the CPF provided.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "format": "date-time" }, "sex": { "$ref": "#/definitions/eSexo" }, "mothers_name": { "type": "string", "description": "Mother's name.\r\n

If provided:

Must have at least two names (e.g.: Maria Silveira);
We recommend sending this information without special characters, accents or abbreviations;
Provide the full name of the mother as it appears in the identification document.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "fathers_name": { "type": "string", "description": "Father's full name.\r\n

If provided:

Must have at least two names (e.g.: Mario Silveira);
We recommend sending this information without special characters, accents or abbreviations;
Provide the full name of the father as it appears in the identification document.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "gross_equity": { "type": "number", "description": "Asset value.\r\n

If provided:

Must contain only numeric digits and decimal separator (.);
If there are decimal places, up to two decimal digits will be considered;

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "format": "double" }, "monthly_gross_income": { "type": "number", "description": "Monthly income value of the provided CPF. \r\n

If provided:

Must contain only numeric digits and decimal separator (.);
If there are decimal places, up to two decimal digits will be considered;
Must be greater than or equal to 100.00.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

If provided:

We recommend sending this information without special characters (Incorrect example: SANTO ANDRÉ, Correct example: SANTO ANDRE).

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "birth_state": { "type": "string", "description": "State of birth.\r\n

If provided:

Accepted state list: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "identification_document": { "$ref": "#/definitions/RequestDocumentPFUpdateViewModel" }, "phone": { "$ref": "#/definitions/RequestPhoneBusinessViewModel" }, "cellphone": { "$ref": "#/definitions/RequestCellPhoneViewModel" }, "nationality": { "type": "string", "description": "Nationality.\r\n

If provided:

Must have 2 characters;
Must provide the country code according to ISO-3166.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "ppe_indication": { "$ref": "#/definitions/ePPE" }, "ppe_description": { "type": "string", "description": "PEP description.\r\n

If provided:

If the value of the \"ppe_indication\" field equals \"not_applied\", provide \"NAO APLICADO\";
If the value of the \"ppe_indication\" field is different from \"not_applied\", provide the name of the politically exposed person.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "email": { "type": "string", "description": "Email.\r\n

If provided:

Must have a valid email format (Example: name@domain.com);
Cannot contain accents or special characters;
The domain cannot be @getnet or @santander.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "occupation": { "type": "string", "description": "Profession / Line of Business.\r\n

If provided:

We recommend sending this information without special characters (Incorrect example: MÉDICO, Correct example: MEDICO).

Mandatory for Anticipation - Mandatory field for receivables anticipation.

If provided:

Must contain only numeric digits;
Provide as per the list available at: `domains/paymentplans/{merchant_id}`

If provided:

Must follow the internal rules of the commission object.

" }, "subsellerid_ext": { "type": "string", "description": "Unique identifier of the External SubSeller.\r\n

Return: The return value contains up to 50 characters;

" }, "list_centralizer": { "type": "array", "items": { "type": "string" }, "description": "List of Centralized EC.\r\n

Rules:

The numbers of the EC's (Anchors) that will receive the replication of the store registration through a single registration must be informed;
These EC's must be configured in the system as centralized by a Centralizing EC (this one, informed in the 'merchant_id' field).

" } }, "additionalProperties": false, "description": "Data model used for inclusion and update of SubSeller PF" }, "RequestSubSellerPJUpdateViewModel": { "required": [ "legal_document_number", "merchant_id", "subseller_id" ], "type": "object", "properties": { "merchant_id": { "minLength": 1, "type": "string", "description": "Identification number (EC) of the Marketplace at GETNET.\r\n

Rules:

Must contain only numeric digits.

" }, "subseller_id": { "type": "integer", "description": "Unique identifier of the SubSeller.\r\n

Rules:

Must contain only numeric digits;
Must contain a maximum of 9 digits.

", "format": "int32" }, "subsellerid_ext": { "type": "string", "description": "Unique identifier of the External SubSeller.\r\n

Return: The return value contains up to 50 characters;

" }, "legal_document_number": { "minLength": 14, "maxLength": 14, "type": "string", "description": "CNPJ number (National Registry of Legal Entities).\r\n

Rules:

Must have 14 characters (CNPJ check digit calculation will be performed);
The CNPJ number must be valid with Brazil's Federal Revenue Service and in `ACTIVE` status.
As of July 2026, CNPJ format is alphanumeric: the first 8 characters must be alphanumeric (letters and numbers), the next 4 characters must also be alphanumeric, and the last 2 characters must be numeric (check digits); letters are automatically normalized to UPPERCASE.
The purely numeric CNPJ format issued before July 2026 remains valid.
The relationship between headquarters (matriz) and branches (filiais) is maintained through the CNPJ's root/radical, in both the alphanumeric and purely numeric formats.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "legal_name": { "type": "string", "description": "Company name.\r\n

Rules:

Cannot contain special characters, accents or abbreviations;
The full company name must be informed as registered with the Federal Revenue Service.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "trade_name": { "type": "string", "description": "Trade name of the Subseller.\r\n

Rules:

Cannot be empty;
We recommend sending this information without special accent characters.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

" }, "founding_date": { "type": "string", "description": "CNPJ founding date as registered with the Federal Revenue Service.\r\n

Rules:

Must be later than 01/01/1900;
Cannot be later than today's date.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "format": "date-time" }, "business_entity_type": { "type": "integer", "description": "Inform the code of the legal nature of the company as shown on the CNPJ card\r\n

Rules:

Must contain only numeric digits;
Must have 4 numeric digits.

Mandatory for Anticipation - Mandatory field for receivables anticipation.

", "format": "int32" }, "monthly_gross_income": { "type": "number", "description": "Enter the company's monthly revenue. If the company does not have one year of registration, the projected revenue must be informed.\r\n

Rules:

Must contain only numeric digits;
Must be greater than R$100.00.

Mandatory for Anticipation - Required field for receivables anticipation.

", "format": "double" }, "billing_value": { "type": "number", "description": "Enter the company's annual revenue. If the company does not have one year of registration, the projected revenue must be informed.\r\n

Rules:

Must contain only numeric digits;
Must be greater than R$100.00.

Mandatory for Anticipation - Required field for receivables anticipation.

", "format": "double" }, "billing_date": { "type": "string", "description": "Revenue date.\r\n

Mandatory for Anticipation - Required field for receivables anticipation.

", "format": "date-time" }, "phone": { "$ref": "#/definitions/RequestPhoneBusinessViewModel" }, "cellphone": { "$ref": "#/definitions/RequestCellPhoneViewModel" }, "business_address": { "$ref": "#/definitions/RequestBasicAddressUpdateViewModel" }, "economic_activity_classification_code": { "type": "integer", "description": "Enter the company's primary CNAE as shown on the CNPJ card\r\n

Rules:

Must contain only numeric digits;
Must have 6 or 7 numeric digits.

Mandatory for Anticipation - Required field for receivables anticipation.

", "format": "int32" }, "federal_registration_status": { "$ref": "#/definitions/eStatusReceita" }, "federal_registration_status_date": { "type": "string", "description": "Date of the Subseller's status with the Federal Revenue Service.\r\n

Mandatory for Anticipation - Required field for receivables anticipation.

", "format": "date-time" }, "state_fiscal_document_number": { "type": "string", "description": "State Registration of the Subseller.\r\n

Rules:

Cannot be empty;
Can be text (\"EXEMPT\") or only numeric digits;
When the company is required to register state registration, only numeric digits must be informed;
When not applicable, inform \"EXEMPT\".

Mandatory for Anticipation - Required field for receivables anticipation.

" }, "email": { "type": "string", "description": "Email.\r\n

If informed:

Must have a valid email format (Example: name@domain.com);
Cannot contain accents or special characters;
The domain cannot be @getnet or @santander.

Mandatory for Anticipation - Required field for receivables anticipation.

If informed:

Must contain only numeric digits;
Inform as per list available at: `domains/paymentplans/{merchant_id}`

If informed: \r\nMust follow the internal rules of the commission object.

" }, "list_centralizer": { "type": "array", "items": { "type": "string" }, "description": "List of Centralized EC.\r\n

Rules:

The EC numbers (Anchors) must be informed to receive store registration replication through a single registration;
These ECs must be configured in the system as centralized by a Centralizing EC (this one informed in the 'merchant_id' field).

" } }, "additionalProperties": false, "description": "Data model used for inclusion and update of Corporate SubSeller" }, "ResponseBankAccount": { "type": "object", "properties": { "bank": { "type": "string", "description": "Bank Code" }, "agency": { "type": "string", "description": "Branch" }, "agency_digit": { "type": "string", "description": "Branch Digit" }, "account": { "type": "string", "description": "Account" }, "account_type": { "type": "string", "description": "Account Type (Send \"C\" for Checking Account; \"P\" for Savings Account; or \"G\" for Payment Account)" }, "account_digit": { "type": "string", "description": "Account Digit" }, "brand": { "type": "string", "description": "Brand" } }, "additionalProperties": false, "description": "Bank Domicile by Brand." }, "ResponseCentralizador": { "required": [ "merchant_id" ], "type": "object", "properties": { "subseller_id": { "type": "integer", "description": "Unique SubSeller identifier.\r\n

Return: \r\nThe return value contains only numeric digits;\r\nThe return value contains a maximum of 9 digits.

", "format": "int32" }, "merchant_id": { "minLength": 1, "type": "string", "description": "Identification number (EC) of the Marketplace at GETNET.\r\n

Rules:

Must contain only numeric digits.

" } }, "additionalProperties": false }, "ResponseCommission": { "required": [ "brand_id", "payment_plan", "product_id" ], "type": "object", "properties": { "brand_id": { "$ref": "#/definitions/eBandeiraProduto" }, "product_id": { "$ref": "#/definitions/ePlanoVenda" }, "percent": { "type": "number", "description": "Percentage fee value (%)", "format": "double" }, "payment_plan": { "type": "integer", "description": "Payment Plan", "format": "int32" }, "value": { "type": "number", "description": "Fixed fee value", "format": "double" } }, "additionalProperties": false, "description": "MDR by Brand and Sales Plan" }, "ResponseErrors": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Indicates if the operation was performed successfully", "readOnly": true }, "errors": { "type": "array", "items": { "type": "string" }, "description": "List of errors" } }, "additionalProperties": false, "description": "Response Class" }, "ResponseMessages": { "type": "object", "properties": { "messages": { "type": "array", "items": { "type": "string" }, "description": "List of messages" } }, "additionalProperties": false, "description": "Response Class" }, "ResponsePaymentPlan": { "type": "object", "properties": { "paymentplan_id": { "type": "integer", "description": "Unique identifier number of the payment plan.", "format": "int32" }, "name": { "type": "string", "description": "Description of the payment plan." }, "anticipation": { "type": "string", "description": "Indicates if plan allows anticipation (\"Y\" or \"N\")." } }, "additionalProperties": false, "description": "Payment Plan Return" }, "ResponsePreSubSellerPF": { "type": "object", "properties": { "fiscal_type": { "$ref": "#/definitions/eTipoFiscal" }, "subseller_id": { "type": "integer", "description": "Unique SubSeller identifier.\r\n

Return: \r\nThe return value contains only numeric digits;\r\nThe return value contains a maximum of 9 digits.

", "format": "int32" }, "subsellerid_ext": { "type": "string", "description": "Unique External SubSeller identifier.\r\n

Return: \r\nThe return value contains up to 50 characters.

" }, "legal_document_number": { "type": "string", "description": "Registration document number.\r\n\r\n\r\nCPF for Individual (F) or CNPJ for Corporate (J).

Return: \r\nFor CPF the value contains only numeric digits without leading zeros, with a maximum of 11 digits;\r\nFor CNPJ the value contains 14 characters: either the legacy purely numeric format, or, as of July 2026, the alphanumeric format (first 8 and next 4 characters alphanumeric, last 2 numeric check digits, letters normalized to UPPERCASE).

" }, "enabled": { "type": "string", "description": "Indicates if the subseller is active.\r\n

Return: \r\nFor active registration the return value is `Y`;\r\nFor inactive registration the return value is `N`.

" }, "status": { "type": "string", "description": "

\r\n Return: \r\n According to the lifecycle within onboarding, the status may assume the values below:\r\n New; Rejected; Enrichment; Registration Treatment; Registration Treatment OK; Marketplace Treatment;\r\n Marketplace Treatment OK; Qualification; Disapproved; Approved to Transact;\r\n Approved to Transact and Anticipate; Deactivated.\r\n

" }, "payment_plan": { "type": "integer", "description": "Payment plan code configured for the registration.\r\n

Return: \r\nThe return value contains only numeric digit(s).

", "format": "int32" }, "capture_payments_enabled": { "type": "string", "description": "Indicates if transaction capture is enabled.\r\n

Return: \r\nFor transaction capture enabled the return value is `Y`;\r\nFor transaction capture blocked the return value is `N`.

" }, "anticipation_enabled": { "type": "string", "description": "Indicates if receivables anticipation is enabled.\r\n

Return: \r\nFor anticipation enabled the return value is `Y`;\r\nFor anticipation disabled the return value is `N`.

" }, "automatic_anticipation": { "type": "string", "description": "Indicates if the Subseller will use the MGM anticipation service.\r\n

Return:

\"Y\" if the subseller will use the anticipation service;
\"N\" if the subseller will not use the anticipation service.

" }, "accepted_contract": { "type": "string", "description": "Acceptance of Getnet Acquirer settlement services.\r\n

Return: \r\nFor accepted service contract the return value is `Y`;\r\nFor non-accepted service contract the return value is `N`.

" }, "bank_accounts": { "type": "array", "items": { "$ref": "#/definitions/ResponseBankAccount" }, "description": "Bank Domicile by Brand.\r\n

Attention: \r\nReturn details should be checked internally in the bank domicile object.

" }, "list_commissions": { "type": "array", "items": { "$ref": "#/definitions/ResponseCommission" }, "description": "List of MDR by Brand and product\r\n

Attention: \r\nReturn details should be checked internally in the commission object.

" }, "lock_schedule": { "type": "string", "description": "Moment of schedule block\r\n

Return: \r\nFor unlocked schedule the return value is `null`;\r\nFor locked schedule the return value is a date (yyyy-MM-ddTHH:mm:ss.fff) with the lock moment.

", "format": "date-time" }, "lock_capture_payments": { "type": "string", "description": "Moment of transaction capture block\r\n

Return: \r\nFor unlocked transaction capture the return value is `null`;\r\nFor blocked transaction capture the return value is a date (yyyy-MM-ddTHH:mm:ss.fff) with the block moment.

", "format": "date-time" }, "create_date": { "type": "string", "description": "Store registration date.\r\n

Return: \r\nThe return value is a date (yyyy-MM-ddTHH:mm:ss.fff) with the moment of registration creation.

", "format": "date-time" }, "list_centralizer": { "type": "array", "items": { "$ref": "#/definitions/ResponseCentralizador" }, "description": "List of Centralized EC.\r\n

Return: \r\nThe return value is a list with merchant_id and subseller_id.

" } }, "additionalProperties": false }, "ResponsePreSubSellerPJ": { "type": "object", "properties": { "fiscal_type": { "$ref": "#/definitions/eTipoFiscal" }, "subseller_id": { "type": "integer", "description": "Unique SubSeller identifier.\r\n

Return: \r\nThe return value contains only numeric digits;\r\nThe return value contains a maximum of 9 digits.

", "format": "int32" }, "subsellerid_ext": { "type": "string", "description": "Unique External SubSeller identifier.\r\n

Return: \r\nThe return value contains up to 50 characters.

" }, "legal_document_number": { "type": "string", "description": "Registration document number.\r\n\r\n\r\nCPF for Individual (F) or CNPJ for Corporate (J).

" }, "enabled": { "type": "string", "description": "Indicates if the subseller is active.\r\n

Return: \r\nFor active registration the return value is `Y`;\r\nFor inactive registration the return value is `N`.

" }, "status": { "type": "string", "description": "

" }, "payment_plan": { "type": "integer", "description": "Payment plan code configured for the registration.\r\n

Return: \r\nThe return value contains only numeric digit(s).

", "format": "int32" }, "capture_payments_enabled": { "type": "string", "description": "Indicates if transaction capture is enabled.\r\n

Return: \r\nFor transaction capture enabled the return value is `Y`;\r\nFor transaction capture blocked the return value is `N`.

" }, "anticipation_enabled": { "type": "string", "description": "Indicates if receivables anticipation is enabled.\r\n

Return: \r\nFor anticipation enabled the return value is `Y`;\r\nFor anticipation disabled the return value is `N`.

" }, "automatic_anticipation": { "type": "string", "description": "Indicates if the Subseller will use the MGM anticipation service.\r\n

Return:

\"Y\" if the subseller will use the anticipation service;
\"N\" if the subseller will not use the anticipation service.

Authentication

Payments

Payment Record Management

Biometric PIX

Combined Payments

Crossborder

Installments

Cards

Customers

Recurrence Plans

Network Token

Webhooks

Subscriptions

Models