Pendencies API (Partner) — Functional Documentation

Overview

The Pendencies API is designed for partners to query onboarding and accreditation pendencies for a given Merchant (EC — Estabelecimento Comercial). The API provides a minimal, stable, and secure contract that allows the partner to:
  1. Identify which pendencies exist for a merchant.
  2. Check the current status of each pendency.
  3. Trigger and validate contact channel tokens (SMS, email, WhatsApp) to confirm merchant identity.

Environments

EnvironmentBase URL
Homologation (HTI)https://api-homologacao.getnet.com.br
information icon

Production URL to be provided separately upon go-live.

Authentication

All endpoints require an API Key sent in the request header:
HeaderValue
Authorization<your_api_key>

Endpoints

1. Get Merchant Pendencies

Retrieves all pendencies associated with a merchant, identified by their acquirer merchant code.

Code

text
GET https://api-homologacao.getnet.com.br/contratos/v1/pendency-adapter/{acquirer_merchant_code}

Path Parameters

ParameterTypeRequiredDescription
acquirer_merchant_codestring✅Unique merchant code assigned by the acquirer

Behavior

  • If the merchant does not exist or is not accessible by the authenticated partner → returns 404 (anti-enumeration protection).
  • If the merchant exists but has no pendencies → returns 200 with an empty pendencies: [] array.
  • For pendencies of type DATA_GRID → the grid_info field is populated with the registration attributes that must be resolved.

Response — 200 OK

JSON

text
{ "acquirer_merchant_code": "string", "person_type": "company | natural_person", "situations": [ { "status": "pending", "status_update_date": "2026-05-12T10:00:00Z" } ], "pendencies": [ { "name": "string", "context": "string", "type": "DATA_GRID | DOCUMENT", "required_for_affiliation": true, "assigned_to_pending": false, "situation": { "status": "pending", "status_update_date": "2026-05-12T10:00:00Z" }, "grid_info": [ { "attribute": "string", "required": true, "description": "string" } ] } ] }

2. Request Token Validation

Sends a one-time validation code to the merchant via the specified contact channel (SMS, email, or WhatsApp).

Code

text
POST https://api-homologacao.getnet.com.br/contratos/v1/pendency-adapter/token-request/{acquirer_merchant_code}

Path Parameters

ParameterTypeRequiredDescription
acquirer_merchant_codestring✅Unique merchant code assigned by the acquirer

Request Body

JSON

text
{ "type": "cell_phone | email", "value": "email@example.com or 11999999999" }
FieldTypeRequiredDescription
typestring✅Contact channel: cell_phone or email
valuestring✅Phone number or email address of the merchant

Response — 202 Accepted

JSON

text
{ "sms_token_validation_id": "string", "email_validation_id": "string", "cell_phone": "string", "email": "string", "acquirer_merchant_code": "string", "situation": { "status": "pending | ok" } }

3. Validate Token

Submits the one-time code received by the merchant to confirm ownership of the contact channel.

Code

text
POST https://api-homologacao.getnet.com.br/contratos/v1/pendency-adapter/token-validation/{acquirer_merchant_code}

Path Parameters

ParameterTypeRequiredDescription
acquirer_merchant_codestring✅Unique merchant code assigned by the acquirer

Request Body

JSON

text
{ "token": "123456", "type": "cell_phone | email", "value": "email@example.com or 11999999999", "device_fingerprint": "string" }
FieldTypeRequiredDescription
tokenstring✅One-time code received by the merchant
typestring❌Contact channel: cell_phone or email
valuestring❌Phone number or email address
device_fingerprintstring❌Device fingerprint for fraud prevention

Response — 200 OK

JSON

text
{ "sms_token_validation_id": "string", "email_validation_id": "string", "cell_phone": "string", "email": "string", "acquirer_merchant_code": "string", "device_fingerprint": "string", "token": "string", "situation": { "status": "pending | ok" } }

Endpoint Summary

MethodURLDescription
GET.../contratos/v1/pendency-adapter/{acquirer_merchant_code}Query merchant pendencies
POST.../contratos/v1/pendency-adapter/token-request/{acquirer_merchant_code}Request OTP dispatch
POST.../contratos/v1/pendency-adapter/token-validation/{acquirer_merchant_code}Submit and validate OTP

Status Values

StatusDescription
createdRecord created, not yet processed
pendingAwaiting action
receivedInput received, being processed
analysisUnder review
approvedApproved
reprovedRejected
retryRetry scheduled
successCompleted successfully
failureFailed definitively
activeActive
inactiveDeactivated
finishedFully completed
canceledCanceled
reopenedReopened
dismissedDismissed without resolution
dismiss_analysisDismissed during analysis

Error Responses

ErrorDTO

JSON

text
{ "status_code": 400, "message": "string", "details": [ { "item": "field_name", "description": "Explanation of the error" } ] }

HTTP Error Codes

CodeDescription
400Bad Request — Invalid payload or unsupported channel
401Unauthorized — Missing or invalid API key
403Forbidden — Insufficient permissions
404Not Found — Merchant not found or inaccessible (anti-enumeration)
422Unprocessable Entity — Business rule violation
500Internal Server Error
504Gateway Timeout

Integration Flow

Code

text
1. 600;">GET .../contratos/v1/pendency-adapter/{acquirer_merchant_code} └─► Retrieve list of pendencies and their statuses 2. 600;">POST .../contratos/v1/pendency-adapter/token-request/{acquirer_merchant_code} └─► Request OTP dispatch to merchant (SMS / email / WhatsApp) 3. 600;">POST .../contratos/v1/pendency-adapter/token-validation/{acquirer_merchant_code} └─► Submit OTP received by merchant to confirm channel ownership 4. Use grid_info (for DATA_GRID pendencies) to identify which registration attributes must be corrected/filled.

On this page

Pendencies API (Partner) — Functional Documentation