Backoffice API — Adjustments
The Adjustments API in Getnet Split Payments lets you post manual credit or debit entries to a partner's balance and query the entries already made. Use it to correct an amount that was distributed incorrectly in a split, without depending on a new transaction.
Request an Adjustment
Send a POST request to
/v1/mgm/adjustment/request-adjustments to post a credit or debit entry to a partner's balance.- Set the
Authorizationheader with the access token, in the formatBearer <token>. - Build the request body with the fields in the table below.
- Send the request and check the response code in the Check the Response Codes table, further below.
Request Fields
| Field | Required | Type | Description |
|---|---|---|---|
seller_id | Yes | string | Marketplace ID (SellerId). |
merchant_id | Yes | string | Merchant establishment code (EC). |
subseller_id | Yes | integer | Partner ID. |
type_adjustment | Yes | integer | Adjustment type: 1 (credit adjustment) or 2 (debit adjustment). |
amount | Yes | integer | Total adjustment amount. |
date_adjustment | Yes | string (date-time) | Adjustment date. |
adjustment_motive_code | No | integer | Adjustment reason code. Check the available codes in the Adjustment Reason Codes table, below. |
description | No | string | Adjustment description. |
Adjustment Reason Codes
The reason names below are the API's own values, in Portuguese, and are listed here as-is.
| Code | Reason |
|---|---|
1 | Ajuste Chargeback |
2 | Ajuste Comissão |
3 | Recuperação Financeira |
4 | Vendas com outros meios de pagamento |
5 | Reembolso |
6 | Ajuste de Pedidos |
Check Adjustment Entries
Send a GET request to
/v1/mgm/adjustment/get-adjustments-entries to query the adjustment entries already recorded.- Include the
Authorizationheader with the access token, in the formatBearer <token>. - Provide
seller_idormerchant_id(at least one of the two is required), plus the search period. - Use
subseller_idoradjustment_entry_idto filter the result, if needed. - Check the response code in the Check the Response Codes table, further below.
Query Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
seller_id | Conditional | string | Marketplace ID (SellerId). Required if merchant_id isn't provided. |
merchant_id | Conditional | string | Merchant establishment code (EC). Required if seller_id isn't provided. |
subseller_id | No | string | Partner ID. |
adjustment_entry_id | No | integer | Entry ID. |
adjustment_entry_date_start | Yes | string | Search period start date. |
adjustment_entry_date_end | Yes | string | Search period end date. |
The maximum search period is 30 days when
subseller_id is provided, and 2 days when it isn't. If adjustment_entry_date_start is missing, or the period exceeds the maximum, the API returns a 400 with status_code 9002 or 9008, respectively. The response returns the seller's total credits and debits and, for each partner found, the list of entries with their respective amounts.Check the Response Codes
| Code | Meaning |
|---|---|
| 200 | Success. |
| 400 | Invalid request. |
| 401 | Access denied. |
| 403 | Forbidden (only on Check Adjustment Entries). |
| 404 | Not found. |
| 500 | Internal server error. |
Together, these two calls cover posting and tracking manual adjustments to each partner's balance. Always validate the result using the response codes above.
Next Steps
- Balance API: check the partner's balance after applying an adjustment.
- Balance Management: see the overview of releases, adjustments, and refunds.
On this page
Backoffice API — Adjustments