Retrieve a MED case

GET

/order/v1/banking/med/{referenceId}

• Sandbox

Returns the whole case from the identifier of any of its objects: the MED 2.0 case, the tracing graph built by the DICT, every infringement notification sent to the receiving PSPs and every refund request, each with its status history.

Authorizations

• Bearer

Parameters

Path Parameters

referenceId

required

string

Identifier at the DICT of the recovery value, infringement notification or refund request.

Responses

200

The resource was returned successfully

object

recoveryValue

The MED 2.0 case (recovery value) driving the process, when the case was opened as one.

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

statusHistory

Every status this object went through, oldest first.

Array<object>

object

status

required

string

createdAt

string

graph

Tracing graph built by the DICT: where the funds went after the contested transaction. Accounts and holders are pseudonymised.

object

createdAt

string

minimumTransactionAmount

string

maxTransactions

number

timeWindow

string

maxDepth

number

transactions

Transactions the funds went through, as traced by the DICT. Accounts and holders are pseudonymised.

Array<object>

object

transactionId

required

string

debitedAccountId

required

Pseudo identifier of the debited account.

number

creditedAccountId

required

Pseudo identifier of the credited account.

number

amount

required

string

availableAmount

required

Amount still available for refund.

string

settledAt

required

string

infringementNotifications

required

Infringement notifications sent to the PSPs that received the funds.

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

statusHistory

Every status this object went through, oldest first.

Array<object>

object

status

required

string

createdAt

string

refundRequests

required

Refund requests issued in the case and their outcome.

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

statusHistory

Every status this object went through, oldest first.

Array<object>

object

status

required

string

createdAt

string

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

[]

404

Resource not found

object

error

string

Example

NOT_FOUND

message

string

Example

Resource not found

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

[]