List MED cases

GET

/order/v1/banking/med

Production
Sandbox

Lists the MED objects of every account of the company: MED 2.0 cases (recovery values) opened by this institution, infringement notifications and refund requests against or in favour of the accounts. Use accountId to narrow it to one account and onlyPending=true to see just what is still open.

Authorizations

Bearer

Parameters

Query Parameters

accountId

string

Restricts the listing to one account. When omitted, every account of the company is listed.

objectTypes

Array<string>

Allowed values: RECOVERY_VALUE INFRINGEMENT_NOTIFICATION REFUND_REQUEST

Restricts the listing to these MED object kinds.

statuses

Array<string>

Restricts the listing to these statuses.

onlyPending

boolean

When true, returns only the MED objects still open (running recovery values, infringement notifications and refund requests awaiting analysis).

role

string

Allowed values: PAYER RECEIVER

Restricts to cases where the account was the payer or the receiver of the contested transaction.

from

string

Only objects opened at the DICT on or after this date/time.

string

Only objects opened at the DICT on or before this date/time.

page

number

default: 1

Page number (1-based).

limit

number

default: 50

Page size.

Responses

200

The resource was returned successfully

object

data

required

Array<object>

object

objectType

required

string

Allowed values: RECOVERY_VALUE INFRINGEMENT_NOTIFICATION REFUND_REQUEST

referenceId

required

Identifier of the object at the DICT.

string

status

required

Current status of the object at the DICT.

string

awaitingOurAnalysis

required

True when the object is waiting for an analysis by this institution.

boolean

endToEndId

Contested transaction, or root transaction of the case for a recovery value.

string

recoveryId

Recovery value (MED 2.0) this object belongs to.

string

reason

string

type

Situation that originated the case.

string

details

string

amount

Contested amount or amount requested for refund.

string

returnedAmount

Amount effectively refunded.

string

analysisResult

string

analysisDetails

string

accountId

Account the object is linked to.

string

companyId

Company that owns the account.

string

accountNumber

Account number with check digit.

string

role

Side of the contested transaction the account took.

string

Allowed values: PAYER RECEIVER

account

Deprecated: use accountId, accountNumber and role. Kept for compatibility.

object

branchNumber

string

accountNumber

required

Account number with check digit.

string

accountType

string

documentNumber

Holder document number (CPF/CNPJ).

string

role

required

Side of the contested transaction the account took.

string

Allowed values: PAYER RECEIVER

createdAt

Creation date/time at the DICT.

string

updatedAt

Last status change date/time at the DICT.

string

total

required

Total of objects matching the filters.

number

page

required

number

limit

required

number

hasNext

required

Whether there is another page after this one.

boolean

400

object

error

string

Example

INVALID_REQUEST

message

string

details

Array<object>

object

field

string

issue

string

description

string

Example

[
  {
    "field": "field_name",
    "issue": "INVALID",
    "description": "Field is invalid"
  }
]

401

Unauthorized Request

object

error

string

Example

UNAUTHORIZED

message

string

Example

Unauthorized Request

details

Array<object>

object

field

string

issue

string

description

string

Example

[]

403

object

error

string

Example

FORBIDDEN_ERROR

message

string

details

Array<object>

object

field

string

issue

string

description

string

Example

[]

500

object

error

string

Example

INTERNAL_ERROR

message

string

details

Array<object>

object

field

string

issue

string

description

string

Example

[]