Pendencies API (Partner)

API intended for partners to query onboarding/accreditation pendencies of a Merchant (EC).

The goal is to expose a minimum, stable, and secure contract, allowing the partner to identify:

Which pendencies exist for the EC
The status of each pendency

For pendencies of type DATA_GRID, the response includes the list of registration attributes (gridInfo) that must be reviewed/resolved by the partner, indicating which ones are required.

General Information

Field	Value
Version	1
Base URL (HML)	`https://adapter-pendency-partner-contracts-hti.apps.ocp-hml.getnet.com.br`
Contact	Getnet

Authentication

All requests must include the Authorization header with a valid API Key.

text

Authorization: <your-api-key>

text

Authorization: <your-api-key>

Endpoints

1. Query Merchant Pendencies

Returns the list of pendencies associated with the provided merchant.

text

GET /partners/v1/pendencies/{acquirer_merchant_code}

text

GET /partners/v1/pendencies/{acquirer_merchant_code}

Parameters

Name	Location	Type	Required	Description
`acquirer_merchant_code`	path	string	✅	Unique merchant code assigned by the acquirer

Response `200 OK`

json

{
  "person_type": "company",
  "situations": [
    {
      "status": "pending",
      "status_update_date": "2026-05-27T14:30:00Z"
    }
  ],
  "pendencies": [
    {
      "pendency_type": "DATA_GRID",
      "situation": {
        "status": "pending",
        "status_update_date": "2026-05-27T14:30:00Z"
      },
      "grid_info": [
        {
          "attribute": "trading_name",
          "required": true
        }
      ]
    }
  ]
}

json

{
  "person_type": "company",
  "situations": [
    {
      "status": "pending",
      "status_update_date": "2026-05-27T14:30:00Z"
    }
  ],
  "pendencies": [
    {
      "pendency_type": "DATA_GRID",
      "situation": {
        "status": "pending",
        "status_update_date": "2026-05-27T14:30:00Z"
      },
      "grid_info": [
        {
          "attribute": "trading_name",
          "required": true
        }
      ]
    }
  ]
}

Behavior

If the merchant does not exist or is not accessible by the authenticated partner → returns 404 (anti-enumeration).
If the merchant exists but has no pendencies → returns 200 with an empty list (pendencies: []).
Pendencies of type DATA_GRID include the grid_info field.

2. Request Validation Code

Requests a validation code to be sent to the merchant via SMS, email, or WhatsApp.

text

POST /partners/v1/pendencies/token-request/{acquirer_merchant_code}

text

POST /partners/v1/pendencies/token-request/{acquirer_merchant_code}

Parameters

Name	Location	Type	Required	Description
`acquirer_merchant_code`	path	string	✅	Unique merchant code assigned by the acquirer

Request Body

json

{
  "type": "cell_phone",
  "value": "11999999999"
}

json

{
  "type": "cell_phone",
  "value": "11999999999"
}

Field	Type	Required	Description
`type`	string	✅	Contact channel. Allowed values: `cell_phone`, `email`
`value`	string	✅	Channel value. E.g.: `email@email.com` or `11999999999`

Response `202 Accepted`

json

{
  "sms_token_validation_id": "abc-123",
  "cell_phone": "11999999999",
  "acquirer_merchant_code": "MC123456",
  "situation": {
    "status": "pending"
  }
}

json

{
  "sms_token_validation_id": "abc-123",
  "cell_phone": "11999999999",
  "acquirer_merchant_code": "MC123456",
  "situation": {
    "status": "pending"
  }
}

3. Validate Received Code

Submits the validation code received by the merchant to confirm ownership of the contact channel.

text

POST /partners/v1/pendencies/token-validation/{acquirer_merchant_code}

text

POST /partners/v1/pendencies/token-validation/{acquirer_merchant_code}

Parameters

Name	Location	Type	Required	Description
`acquirer_merchant_code`	path	string	✅	Unique merchant code assigned by the acquirer

Request Body

json

{
  "token": "123456",
  "type": "cell_phone",
  "value": "11999999999",
  "device_fingerprint": "fp_abc123xyz"
}

json

{
  "token": "123456",
  "type": "cell_phone",
  "value": "11999999999",
  "device_fingerprint": "fp_abc123xyz"
}

Field	Type	Required	Description
`token`	string	✅	One-time validation code received by the merchant
`type`	string	❌	Contact channel. Allowed values: `cell_phone`, `email`
`value`	string	❌	Corresponding channel value
`device_fingerprint`	string	❌	Device fingerprint for fraud prevention and session binding

Response `200 OK`

json

{
  "sms_token_validation_id": "abc-123",
  "cell_phone": "11999999999",
  "acquirer_merchant_code": "MC123456",
  "token": "123456",
  "device_fingerprint": "fp_abc123xyz",
  "situation": {
    "status": "ok"
  }
}

json

{
  "sms_token_validation_id": "abc-123",
  "cell_phone": "11999999999",
  "acquirer_merchant_code": "MC123456",
  "token": "123456",
  "device_fingerprint": "fp_abc123xyz",
  "situation": {
    "status": "ok"
  }
}

Data Models

PendencyResponse

Field	Type	Description
`person_type`	string	Person type: `company` or `natural_person`
`situations`	array<Situation>	List of overall onboarding status records for the merchant
`pendencies`	array<Pendency>	List of open pendencies that must be resolved

Pendency

Field	Type	Description
`pendency_type`	string	Pendency type identifier as defined in the v1 catalog
`situation`	Situation	Current resolution status of the pendency
`grid_info`	array<GridInfoItem>	Registration attributes to review (only for `DATA_GRID` type)

GridInfoItem

Field	Type	Description
`attribute`	string	Name of the registration attribute to be filled or corrected
`required`	boolean	Whether this attribute is mandatory for completing the pendency

Situation

Field	Type	Description
`status`	string	Current status (see possible values below)
`status_update_date`	string (date-time)	ISO-8601 date-time of the last update

Possible status values:

active · inactive · created · success · failure · retry · approved · pending · received · reopened · dismissed · dismiss_analysis · reproved · finished · analysis · canceled

TokenManagerResponse

Field	Type	Description
`sms_token_validation_id`	string	Unique identifier for the SMS token validation session
`email_validation_id`	string	Unique identifier for the email validation session
`cell_phone`	string	Mobile phone number used for token delivery
`email`	string	Email address used for token delivery
`acquirer_merchant_code`	string	Unique merchant code assigned by the acquirer
`device_fingerprint`	string	Device fingerprint captured during validation
`token`	string	One-time validation token
`situation`	object	Processing status: `pending` or `ok`

ErrorDTO

Field	Type	Description
`status_code`	integer	HTTP error code
`message`	string	Descriptive error message
`details`	array<ErrorDetailDTO>	Additional error details

ErrorDetailDTO

Field	Type	Description
`item`	string	Field or item related to the error
`description`	string	Error description

Error Codes

Code	Description
`400`	Invalid request or incorrect payload
`401`	Unauthorized — missing or invalid API Key
`403`	Forbidden — access denied to the requested resource
`404`	Merchant not found or not accessible by the authenticated partner
`422`	Unprocessable Entity — business rule violation
`500`	Internal Server Error
`504`	Gateway Timeout

On this page

Pendencies API (Partner)

Pendencies API (Partner)

General Information

Authentication

Endpoints

1. Query Merchant Pendencies

Parameters

Response 200 OK

Behavior

2. Request Validation Code

Parameters

Request Body

Response 202 Accepted

3. Validate Received Code

Parameters

Request Body

Response 200 OK

Data Models

PendencyResponse

Pendency

GridInfoItem

Situation

TokenManagerResponse

ErrorDTO

ErrorDetailDTO

Error Codes

Response `200 OK`

Response `202 Accepted`

Response `200 OK`