Retrieve a case

Retrieve a case

curl --request GET \
  --url https://api.decisionly.com/v1/issuer/cases/{case_id} \
  --header 'Authorization: Basic <encoded-value>'

{
  "case_id": "<string>",
  "status": "created",
  "closed_reason": "accepted",
  "created": "2023-11-07T05:31:56Z",
  "reason": "<string>",
  "cardholder": {
    "name": "<string>",
    "email": "jsmith@example.com",
    "issuer_id": "<string>",
    "type": "individual"
  },
  "merchant": {
    "name": "<string>",
    "category_code": "<string>",
    "issuer_id": "<string>"
  },
  "transaction": {
    "date": "2023-11-07T05:31:56Z",
    "amount": 2,
    "currency": "<string>",
    "card_network": "visa",
    "card_last4": "<string>",
    "card_expiry_month": 6,
    "card_expiry_year": 123,
    "card_type": "credit",
    "arn": "<string>",
    "switch_serial_number": "<string>",
    "issuer_id": "<string>",
    "system": "single_message"
  },
  "dispute": {
    "date": "2023-11-07T05:31:56Z",
    "amount": 123,
    "currency": "<string>"
  },
  "issuer_evidence": {
    "documentation": [
      "<string>"
    ],
    "refund": {
      "promise_date": "2023-11-07T05:31:56Z",
      "policy_provided": true,
      "description": "<string>",
      "promised": true
    },
    "product": {
      "order_id": "<string>",
      "description": "<string>",
      "condition": "<string>",
      "type": "merchandise",
      "delivery_date": "2023-11-07T05:31:56Z",
      "expected_delivery_date": "2023-11-07T05:31:56Z"
    },
    "card": {
      "lost_date": "2023-11-07T05:31:56Z",
      "cardholder_has_possession": true,
      "possession_at_transaction": "possessed",
      "active": true
    },
    "prior_transaction": {
      "arn": "<string>",
      "switch_serial_number": "<string>",
      "issuer_id": "<string>",
      "date": "2023-11-07T05:31:56Z",
      "amount": 123,
      "currency": "<string>",
      "system": "single_message",
      "card_network": "visa",
      "card_type": "credit",
      "card_last4": "<string>",
      "card_expiry_month": 6,
      "card_expiry_year": 123,
      "card_fingerprint": "<string>"
    },
    "correct_amount": 123,
    "correct_currency": "<string>",
    "service_end_date": "2023-11-07T05:31:56Z",
    "resolution": {
      "contact_date": "2023-11-07T05:31:56Z",
      "contact_success": true,
      "contact_description": "<string>",
      "contact_prohibited_description": "<string>",
      "return_date": "2023-11-07T05:31:56Z",
      "return_success": true,
      "return_shipping_carrier": "<string>",
      "return_shipping_tracking": "<string>",
      "return_description": "<string>",
      "cancellation_id": "<string>",
      "cancellation_date": "2023-11-07T05:31:56Z",
      "cancellation_description": "<string>"
    },
    "cardholder_message": "<string>",
    "explanation": "<string>"
  }
}

GET

issuer

cases

{case_id}

Retrieve a case

curl --request GET \
  --url https://api.decisionly.com/v1/issuer/cases/{case_id} \
  --header 'Authorization: Basic <encoded-value>'

{
  "case_id": "<string>",
  "status": "created",
  "closed_reason": "accepted",
  "created": "2023-11-07T05:31:56Z",
  "reason": "<string>",
  "cardholder": {
    "name": "<string>",
    "email": "jsmith@example.com",
    "issuer_id": "<string>",
    "type": "individual"
  },
  "merchant": {
    "name": "<string>",
    "category_code": "<string>",
    "issuer_id": "<string>"
  },
  "transaction": {
    "date": "2023-11-07T05:31:56Z",
    "amount": 2,
    "currency": "<string>",
    "card_network": "visa",
    "card_last4": "<string>",
    "card_expiry_month": 6,
    "card_expiry_year": 123,
    "card_type": "credit",
    "arn": "<string>",
    "switch_serial_number": "<string>",
    "issuer_id": "<string>",
    "system": "single_message"
  },
  "dispute": {
    "date": "2023-11-07T05:31:56Z",
    "amount": 123,
    "currency": "<string>"
  },
  "issuer_evidence": {
    "documentation": [
      "<string>"
    ],
    "refund": {
      "promise_date": "2023-11-07T05:31:56Z",
      "policy_provided": true,
      "description": "<string>",
      "promised": true
    },
    "product": {
      "order_id": "<string>",
      "description": "<string>",
      "condition": "<string>",
      "type": "merchandise",
      "delivery_date": "2023-11-07T05:31:56Z",
      "expected_delivery_date": "2023-11-07T05:31:56Z"
    },
    "card": {
      "lost_date": "2023-11-07T05:31:56Z",
      "cardholder_has_possession": true,
      "possession_at_transaction": "possessed",
      "active": true
    },
    "prior_transaction": {
      "arn": "<string>",
      "switch_serial_number": "<string>",
      "issuer_id": "<string>",
      "date": "2023-11-07T05:31:56Z",
      "amount": 123,
      "currency": "<string>",
      "system": "single_message",
      "card_network": "visa",
      "card_type": "credit",
      "card_last4": "<string>",
      "card_expiry_month": 6,
      "card_expiry_year": 123,
      "card_fingerprint": "<string>"
    },
    "correct_amount": 123,
    "correct_currency": "<string>",
    "service_end_date": "2023-11-07T05:31:56Z",
    "resolution": {
      "contact_date": "2023-11-07T05:31:56Z",
      "contact_success": true,
      "contact_description": "<string>",
      "contact_prohibited_description": "<string>",
      "return_date": "2023-11-07T05:31:56Z",
      "return_success": true,
      "return_shipping_carrier": "<string>",
      "return_shipping_tracking": "<string>",
      "return_description": "<string>",
      "cancellation_id": "<string>",
      "cancellation_date": "2023-11-07T05:31:56Z",
      "cancellation_description": "<string>"
    },
    "cardholder_message": "<string>",
    "explanation": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Use your API key as the username. No password is required.

Path Parameters

case_id

string

required

Response

200 - application/json

Returns the case.

case_id

string

Unique identifier for the case.

status

enum<string>

Current status of the case.

Available options:

created,

chargeback_filed,

chargeback_represented,

prearb_filed,

prearb_rebutted,

arbitration_filed,

won,

lost,

closed

closed_reason

enum<string> | null

Reason the case was closed, if applicable.

Available options:

accepted,

rejected,

expired,

withdrawn

created

string<date-time>

When the case was created.

reason

string

The reason for the dispute.

cardholder

object

Show child attributes

cardholder.name

string

required

Cardholder name.

cardholder.email

string<email> | null

Cardholder email address.

cardholder.issuer_id

string | null

Your ID for the cardholder.

Maximum string length: 250

cardholder.type

enum<string>

default:individual

Whether the cardholder is an individual or company.

Available options:

individual,

company

merchant

object

Show child attributes

merchant.name

string

required

Merchant name.

merchant.category_code

string | null

Merchant category code (MCC).

Required string length: 4

merchant.issuer_id

string | null

Your ID for the merchant.

Maximum string length: 250

transaction

object

Details of the disputed transaction. Either arn or switch_serial_number is required.

Show child attributes

transaction.date

string<date-time>

required

Date of the transaction.

transaction.amount

integer

required

Settled amount of the transaction in smallest currency unit.

Required range: x >= 1

transaction.currency

string

required

Currency of the transaction amount.

Required string length: 3

transaction.card_network

enum<string>

required

The card network.

Available options:

visa,

mastercard,

amex,

discover

transaction.card_last4

string

required

Last 4 digits of the card number.

Required string length: 4

transaction.card_expiry_month

integer

required

Card expiry month (1-12).

Required range: 1 <= x <= 12

transaction.card_expiry_year

integer

required

Card expiry year (4 digits).

transaction.card_type

enum<string>

required

Type of card.

Available options:

credit,

debit,

prepaid

transaction.arn

string | null

The acquirer reference number of the transaction. Either this or switch_serial_number is required.

Required string length: 23

transaction.switch_serial_number

string | null

The switch serial number for the transaction. Either this or arn is required.

Required string length: 9

transaction.issuer_id

string | null

Your unique ID for the transaction.

Maximum string length: 250

transaction.system

enum<string> | null

The transaction system.

Available options:

single_message,

dual_message

dispute

object

Show child attributes

dispute.date

string<date-time>

required

When the dispute was raised.

dispute.amount

integer

required

Amount disputed in smallest currency unit.

dispute.currency

string

required

Currency of the dispute amount.

Required string length: 3

issuer_evidence

object

Show child attributes

issuer_evidence.documentation

string[] | null

Array of file IDs for supporting documentation. Upload files using the file upload endpoint.

issuer_evidence.refund

object

Show child attributes

issuer_evidence.refund.promise_date

string<date-time> | null

issuer_evidence.refund.policy_provided

boolean | null

issuer_evidence.refund.description

string | null

issuer_evidence.refund.promised

boolean | null

issuer_evidence.product

object

Show child attributes

issuer_evidence.product.order_id

string | null

issuer_evidence.product.description

string | null

issuer_evidence.product.condition

string | null

issuer_evidence.product.type

enum<string> | null

Available options:

merchandise,

service

issuer_evidence.product.delivery_date

string<date-time> | null

issuer_evidence.product.expected_delivery_date

string<date-time> | null

issuer_evidence.card

object

Show child attributes

issuer_evidence.card.lost_date

string<date-time> | null

issuer_evidence.card.cardholder_has_possession

boolean | null

issuer_evidence.card.possession_at_transaction

enum<string> | null

Available options:

possessed,

lost,

stolen,

never_received

issuer_evidence.card.active

boolean | null

issuer_evidence.prior_transaction

object

Show child attributes

issuer_evidence.prior_transaction.arn

string | null

Required string length: 23

issuer_evidence.prior_transaction.switch_serial_number

string | null

Required string length: 9

issuer_evidence.prior_transaction.issuer_id

string | null

Maximum string length: 250

issuer_evidence.prior_transaction.date

string<date-time> | null

issuer_evidence.prior_transaction.amount

integer | null

issuer_evidence.prior_transaction.currency

string | null

Required string length: 3

issuer_evidence.prior_transaction.system

enum<string> | null

Available options:

single_message,

dual_message

issuer_evidence.prior_transaction.card_network

enum<string> | null

Available options:

visa,

mastercard,

amex,

discover

issuer_evidence.prior_transaction.card_type

enum<string> | null

Available options:

credit,

debit,

prepaid

issuer_evidence.prior_transaction.card_last4

string | null

Required string length: 4

issuer_evidence.prior_transaction.card_expiry_month

integer | null

Required range: 1 <= x <= 12

issuer_evidence.prior_transaction.card_expiry_year

integer | null

issuer_evidence.prior_transaction.card_fingerprint

string | null

Maximum string length: 250

issuer_evidence.correct_amount

integer | null

issuer_evidence.correct_currency

string | null

Required string length: 3

issuer_evidence.service_end_date

string<date-time> | null

issuer_evidence.resolution

object

Show child attributes

issuer_evidence.resolution.contact_date

string<date-time> | null

issuer_evidence.resolution.contact_success

boolean | null

issuer_evidence.resolution.contact_description

string | null

issuer_evidence.resolution.contact_prohibited_description

string | null

issuer_evidence.resolution.return_date

string<date-time> | null

issuer_evidence.resolution.return_success

boolean | null

issuer_evidence.resolution.return_shipping_carrier

string | null

issuer_evidence.resolution.return_shipping_tracking

string | null

issuer_evidence.resolution.return_description

string | null

issuer_evidence.resolution.cancellation_id

string | null

issuer_evidence.resolution.cancellation_date

string<date-time> | null

issuer_evidence.resolution.cancellation_description

string | null

issuer_evidence.cardholder_message

string | null

issuer_evidence.explanation

string | null

Create a case Update a case

⌘I

v1 Cases

v1 Events

v1 Files

Authorizations

Path Parameters

Response