API docs by Redocly

Amiko - Case Management API (2025.4.0)

Download OpenAPI specification:Download

Operations exposed by the Amiko Edge Connector for Issuer Banks.

NOTE:

In order to successfully invoke endpoints of Case Management API one needs to respect the configured endpoint authentication in Edge Connector configuration (see key "amiko-api-authentication").

Booking Status Callback

Submit a status update for a pending booking request.

This callback endpoint is used to submit a status update for a booking request received from Amiko.

NOTE:

In order to successfully invoke endpoints of Case Management API one needs to respect the configured endpoint authentication in Edge Connector configuration (see key "amiko-api-authentication").

path Parameters
amikoBookingId
required
string <uuid>
header Parameters
tracing-id
string

Optional, can be supplied in order to track and correlate a request with user integrations

Request Body schema: application/json
required

A JSON object containing the booking object with status update.

status
required
string
Default: "completed"
amikoBookingId
required
string <uuid>

Unique identifier for the booking generated by Amiko.

issuerBookingId
string

Unique identifier for the booking generated by the issuer bank.

Responses

Request samples

Content type
application/json
Example
{
  • "status": "completed",
  • "amikoBookingId": "5f27b818-027a-4008-b410-de01e1dd3a93",
  • "issuerBookingId": "string"
}

Response samples

Content type
application/json
{
  • "tracingId": "string",
  • "error": {
    }
}

Batch Case Create

Create multiple cases by uploading CSV file.

This endpoint is used to create cases by uploading a CSV file. The file is validated and the process will go into creation only if no errors are found.

NOTE:

In order to successfully invoke endpoints of Case Management API one needs to respect the configured endpoint authentication in Edge Connector configuration (see key "amiko-api-authentication").

header Parameters
tracing-id
string

Optional, can be supplied in order to track and correlate a request with user integrations

Request Body schema: multipart/form-data
required

A multipart form containing the file and operation parameters.

defaultCaseType
required
string

Case type that will be used when no sufficient information is available in the CSV file.

submitFraudReport
required
boolean

If set to true, all case will have a fraud report submitted. Request will fail if CSV file contains case definitions for which fraud report cannot be submitted.

maxMerchantResponseDurationInHours
integer <int32>

Specifies the duration after which the collaboration will be considered as failed. If empty, defaults to 72.

file
required
string <binary> <= 2000000

CSV file containing case definitions.

submitToEthoca
required
boolean

If set to true, all cases will be submitted to Ethoca. Request will fail if CSV file contains case definitions that cannot be submitted.

Responses

Response samples

Content type
application/json
"string"

Get Report

Get report document.

This endpoint is used to retrieve an existing report document.

NOTE:

In order to successfully invoke endpoints of Case Management API one needs to respect the configured endpoint authentication in Edge Connector configuration (see key "amiko-api-authentication").

header Parameters
tracing-id
string

Optional, can be supplied in order to track and correlate a request with user integrations

Request Body schema: application/json
required

A JSON object containing the parameters of desired report document.

type
required
string
Default: "acknowledged_cardholder_liable"
minCreateDate
required
string

Date in UTC timezone in ISO-8601

maxCreateDate
required
string

Date in UTC timezone in ISO-8601

includeOptionalCardAndBrandInformation
required
boolean

Responses

Request samples

Content type
application/json
Example
{
  • "type": "acknowledged_cardholder_liable",
  • "minCreateDate": "2025-04-15",
  • "maxCreateDate": "2025-04-15",
  • "includeOptionalCardAndBrandInformation": true
}

Response samples

Content type
application/json
{
  • "tracingId": "string",
  • "error": {
    }
}

Utility

Returns the health status for this API

The specification is based on the IETF draft linked below. Its content consists of a single mandatory root field (“status”) and several optional fields. Health Check Response Format for HTTP APIs: https://inadarei.github.io/rfc-healthcheck/

NOTE:

In order to successfully invoke endpoints of Case Management API one needs to respect the configured endpoint authentication in Edge Connector configuration (see key "amiko-api-authentication").

Responses

Response samples

Content type
application/json
{
  • "status": "pass",
  • "version": "string",
  • "output": "string",
  • "checks": {
    }
}

Case List

Get the list of cases

This endpoint is used to retrieve paginated list of cases.

NOTE:

In order to successfully invoke endpoints of Case Management API one needs to respect the configured endpoint authentication in Edge Connector configuration (see key "amiko-api-authentication").

header Parameters
tracing-id
string

Optional, can be supplied in order to track and correlate a request with user integrations

Request Body schema: application/json
required

A JSON object containing parameters for fetching the case list

limit
required
integer <int32>
offset
required
integer <int32>
sortBy
required
string
Enum: "client_create_date" "due_date" "last_worked_at" "total_value"
sortDir
required
string
Enum: "asc" "desc"
required
object (tech.rivero.caseModule.model.CaseManagementFilters)

Json object containing filters that should be applied to the case list. If a filter is not supposed to be applied to the output it shouldn't be part of the payload or it's value should be null. The issuerId parameter is optional. Provide it when your organization has multiple divisions/issuer IDs to scope the search to specific divisions. For single-division deployments, this parameter can be omitted.

Responses

Request samples

Content type
application/json
{
  • "limit": 0,
  • "offset": 0,
  • "sortBy": "client_create_date",
  • "sortDir": "asc",
  • "filters": {
    }
}

Response samples

Content type
application/json
{
  • "tracingId": "5f27b818-027a-4008-b410-de01e1dd3a93",
  • "result": {
    }
}

Search for cases

This endpoint is used to retrieve a list of cases for a given search string.

NOTE:

In order to successfully invoke endpoints of Case Management API one needs to respect the configured endpoint authentication in Edge Connector configuration (see key "amiko-api-authentication").

header Parameters
tracing-id
string

Optional, can be supplied in order to track and correlate a request with user integrations

Request Body schema: application/json
required

A JSON object containing parameters for searching cases

searchString
required
string
issuerId
Array of strings

This array must contain at least one item.

Responses

Request samples

Content type
application/json
{
  • "searchString": "string",
  • "issuerId": [
    ]
}

Response samples

Content type
application/json
{
  • "tracingId": "5f27b818-027a-4008-b410-de01e1dd3a93",
  • "result": [
    ]
}

Case Details

Returns details of a given case

Returns details of a given case

NOTE:

In order to successfully invoke endpoints of Case Management API one needs to respect the configured endpoint authentication in Edge Connector configuration (see key "amiko-api-authentication").

path Parameters
caseId
required
string
query Parameters
issuerId
Array of strings
header Parameters
tracing-id
string

Optional, can be supplied in order to track and correlate a request with user integrations

Responses

Response samples

Content type
application/json
{
  • "tracingId": "5f27b818-027a-4008-b410-de01e1dd3a93",
  • "result": {
    }
}

Returns list of documents list to a case

Returns list of documents list to a case

NOTE:

In order to successfully invoke endpoints of Case Management API one needs to respect the configured endpoint authentication in Edge Connector configuration (see key "amiko-api-authentication").

path Parameters
caseId
required
string
query Parameters
issuerId
Array of strings
header Parameters
tracing-id
string

Optional, can be supplied in order to track and correlate a request with user integrations

Responses

Response samples

Content type
application/json
{
  • "tracingId": "5f27b818-027a-4008-b410-de01e1dd3a93",
  • "result": [
    ]
}

This endpoint is used to retrieve a document. NOT

This endpoint is used to retrieve a document.

NOTE:

In order to successfully invoke endpoints of Case Management API one needs to respect the configured endpoint authentication in Edge Connector configuration (see key "amiko-api-authentication").

path Parameters
fileId
required
string
query Parameters
issuerId
Array of strings
header Parameters
tracing-id
string

Optional, can be supplied in order to track and correlate a request with user integrations

Responses

Response samples

Content type
application/json
{
  • "tracingId": "string",
  • "error": {
    }
}

Case create

Create a case

This endpoint is used to create a new case in Amiko.

It accepts a list of documents that should be added to the case.

The selected documents need to be present already in the issuer file store.

Optionally it can perform ethoca submission and fraud report submission.

All operations are performed synchronously therefore it can take a bit longer for the request to complete.

If fraud report or ethoca submission are selected more details about the transaction are required.

The endpoint returns a bad request response if some transactions are already present, not all transactions belong to the same card or some data is missing.

NOTE:

In order to successfully invoke endpoints of Case Management API one needs to respect the configured endpoint authentication in Edge Connector configuration (see key "amiko-api-authentication").

header Parameters
tracing-id
string

Optional, can be supplied in order to track and correlate a request with user integrations

Request Body schema: application/json
required

Case creation payload

cardId
required
string

Unique identifier of a card that is not the PAN and is not to be classified as account data or PII

caseType
required
string
Enum: "fraud" "cardholder_dispute"
bankCaseId
string
assignment
string

The id of the user assigned by the identity provider.

required
Array of objects

This array must contain at least one item.

required
Array of objects (tech.rivero.caseModule.model.service.domain.DocumentIdWithOptionalTag)
submitToEthoca
required
boolean
submitFraudReport
required
boolean

Responses

Request samples

Content type
application/json
{
  • "cardId": "b8ba25f3-c945-4ed0-9d4d-e3153a0dd048",
  • "caseType": "fraud",
  • "bankCaseId": "string",
  • "assignment": "string",
  • "transactions": [
    ],
  • "documents": [
    ],
  • "submitToEthoca": true,
  • "submitFraudReport": true
}

Response samples

Content type
application/json
{
  • "tracingId": "5f27b818-027a-4008-b410-de01e1dd3a93",
  • "result": {
    }
}

Add transactions to existing case

This endpoint is used to add transactions to an existing case in Amiko.

It accepts a list of documents that should be added to the case.

The selected documents need to be present already in the issuer file store.

Optionally it can perform ethoca submission and fraud report submission.

All operations are performed synchronously therefore it can take a bit longer for the request to complete.

If fraud report or ethoca submission are selected more details about the transaction are required.

The endpoint returns a bad request response if some transactions are already present, not all transactions belong to the same card or some data is missing.

NOTE:

In order to successfully invoke endpoints of Case Management API one needs to respect the configured endpoint authentication in Edge Connector configuration (see key "amiko-api-authentication").

header Parameters
tracing-id
string

Optional, can be supplied in order to track and correlate a request with user integrations

Request Body schema: application/json
required

Add transactions to existing case

caseId
required
string
required
Array of objects
required
Array of objects (tech.rivero.caseModule.model.service.domain.DocumentIdWithOptionalTag)
submitToEthoca
required
boolean
submitFraudReport
required
boolean

Responses

Request samples

Content type
application/json
{
  • "caseId": "1234",
  • "transactions": [
    ],
  • "documents": [
    ],
  • "submitToEthoca": true,
  • "submitFraudReport": true
}

Response samples

Content type
application/json
{
  • "tracingId": "5f27b818-027a-4008-b410-de01e1dd3a93",
  • "result": {
    }
}

Documents

Link documents to an existing case

This endpoint is used to link documents to a case. The selected documents need to be present already in the issuer file store.

NOTE:

In order to successfully invoke endpoints of Case Management API one needs to respect the configured endpoint authentication in Edge Connector configuration (see key "amiko-api-authentication").

header Parameters
tracing-id
string

Optional, can be supplied in order to track and correlate a request with user integrations

Request Body schema: application/json
required

Link documents to a case

caseId
required
string
documentId
required
string

The unique identifier for the document (used to retrieve the actual file)

tag
string
Enum: "acquirer_arbitration_documentation" "acquirer_dispute_response_documentation" "acquirer_merchant_letter_documentation" "acquirer_other_documentation" "acquirer_pre_arbitration_documentation" "acquirer_pre_compliance_documentation" "affidavit" "airline_transactions" "arbitration_acquirer_questionnaire" "arbitration_issuer_letter" "arbitration_response" "cardholder_dispute" "case_filing_document" "compliance_acquirer_letter" "compliance_issuer_letter" "dispute_issuer_questionnaire" "dispute_response_acquirer_questionnaire" "ebdf_fraud" "ecom_and_moto" "email_or_letter" "invalid" "issuer_dispute_form" "order_insight" "other_issuer_letter" "other_supporting_document" "other_visa_compelling_evidence" "poi_error" "police_report" "pre_arbitration_acquirer_questionnaire" "pre_arbitration_issuer_letter" "pre_arbitration_response" "pre_arbitration_response_acquirer_questionnaire" "pre_compliance_acquirer_letter" "pre_compliance_acquirer_questionnaire" "pre_compliance_issuer_letter" "reaffirmation" "recurring_transactions" "representment_document" "travel_and_expense" "unknown" "visa_acknowledgement_letter" "visa_final_decision_letter" "withdrawal"

Responses

Request samples

Content type
application/json
{
  • "caseId": "1234",
  • "documentId": "50c23df4-c8b3-4860-89d2-2d9b2a43b009",
  • "tag": "acquirer_arbitration_documentation"
}

Response samples

Content type
application/json
{
  • "tracingId": "5f27b818-027a-4008-b410-de01e1dd3a93",
  • "result": {
    }
}

Link documents to an existing case using the bank case id

This endpoint is used to link documents to a case using the bank case id. The selected documents need to be present already in the issuer file store.

NOTE:

In order to successfully invoke endpoints of Case Management API one needs to respect the configured endpoint authentication in Edge Connector configuration (see key "amiko-api-authentication").

header Parameters
tracing-id
string

Optional, can be supplied in order to track and correlate a request with user integrations

Request Body schema: application/json
required

Link documents to a case using the bank case id

bankCaseId
required
string
documentId
required
string

The unique identifier for the document (used to retrieve the actual file)

tag
string
Enum: "acquirer_arbitration_documentation" "acquirer_dispute_response_documentation" "acquirer_merchant_letter_documentation" "acquirer_other_documentation" "acquirer_pre_arbitration_documentation" "acquirer_pre_compliance_documentation" "affidavit" "airline_transactions" "arbitration_acquirer_questionnaire" "arbitration_issuer_letter" "arbitration_response" "cardholder_dispute" "case_filing_document" "compliance_acquirer_letter" "compliance_issuer_letter" "dispute_issuer_questionnaire" "dispute_response_acquirer_questionnaire" "ebdf_fraud" "ecom_and_moto" "email_or_letter" "invalid" "issuer_dispute_form" "order_insight" "other_issuer_letter" "other_supporting_document" "other_visa_compelling_evidence" "poi_error" "police_report" "pre_arbitration_acquirer_questionnaire" "pre_arbitration_issuer_letter" "pre_arbitration_response" "pre_arbitration_response_acquirer_questionnaire" "pre_compliance_acquirer_letter" "pre_compliance_acquirer_questionnaire" "pre_compliance_issuer_letter" "reaffirmation" "recurring_transactions" "representment_document" "travel_and_expense" "unknown" "visa_acknowledgement_letter" "visa_final_decision_letter" "withdrawal"

Responses

Request samples

Content type
application/json
{
  • "bankCaseId": "string",
  • "documentId": "50c23df4-c8b3-4860-89d2-2d9b2a43b009",
  • "tag": "acquirer_arbitration_documentation"
}

Response samples

Content type
application/json
{
  • "tracingId": "5f27b818-027a-4008-b410-de01e1dd3a93",
  • "result": {
    }
}