Open a MED case for a transaction

POST

/order/v1/banking/med/accounts/{accountId}

• Sandbox

Opens a MED 2.0 case (“recuperação de valores”) at the DICT for a transaction debited from the account. The DICT traces where the funds went, notifies the receiving PSPs and the case evolves through CREATED, TRACED, WAITING_ANALYSIS, ANALYSED, WAITING_REFUND and COMPLETED. Progress arrives as MED webhooks and can be followed on GET /public/v1/banking/med/{referenceId}.

Authorizations

• Bearer

Parameters

Path Parameters

accountId

required

string

Account the contested transaction was debited from.

Header Parameters

idempotency-key

required

string

Unique key for idempotent requests

Request Body ^required

object

endToEndId

required

End to end id of the contested transaction, or the return id (RtrId) when contesting a refund.

string

Example

E04358798202508270918y6j6mt9l0pi

situationType

required

Situation that gave rise to the case.

string

Allowed values: SCAM UNAUTHORIZED_TRANSACTION CRIME_OF_COERCION FRAUDULENT_ACCESS_AND_AUTHORIZATION OTHERS UNKNOWN

Example

SCAM

details

Details that help the receiving PSPs analyse the case. Required when situationType is OTHERS.

string

<= 2000 characters

tracing

Tracing graph options. The DICT defaults apply when omitted.

object

minimumTransactionAmount

Minimum amount a transaction must have to enter the tracing graph. Defaults to 200.00 at the DICT, so lower it when the contested amount is smaller.

string

Example

100.00

maxTransactions

Maximum number of transactions per graph node (DICT limit: 5).

number

default: 5

timeWindow

Maximum time between a credit and the following debit for the funds to be traced (DICT limit: PT2H).

string

Example

PT2H

maxDepth

Maximum depth of the tracing graph (DICT limit: 10).

number

default: 2

Responses

201

The resource was returned successfully

object

referenceId

required

Identifier of the case at the DICT. Use it to follow the case and to receive MED webhooks.

string

status

required

Status of the case at the DICT right after opening (CREATED or TRACED).

string

accountId

required

Account the case belongs to.

string

endToEndId

required

Contested transaction.

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

[]