Get Case Response

Field

Type

Description

id

String

The ID of the case.

receptionDate

String

Date on which a case became available to merchants at API in UTC. Related to the filter: RECEPTION_DATE

responseDueDate

String

Maximum date on which the case response is accepted by the API. Related to the filter: RESPONSE_DUE_DATE; calculated as reception date + N days in UTC

responseDate

String

Date on which the merchant response was successfully submitted to the API. Related to the filter: RESPONSE_DATE

chargebackAmount

Decimal

Amount for this case. Must be between 0.0 and 10,000,000,000.

reasonCode

String

Reason code originating from the acquirer side.

fraud

Boolean

Determines whether the dispute is related to fraud based on scheme reason codes.

currency

String

Currency code of the transaction (ISO 4217). Size must be equal to 3

lastUpdateDate

String

Last time the information was updated for the case in the API. Related to the filter: LAST_UPDATE_DATE

status

String

Last status applied to the case. Must be one of ld", "h-1": "Type", "h-2": "Description", "0-0": "id", "0-1": "String", "0-2": "The ID of the case.",

merchant

Object

Merchant information related to the case.

merchant.name

String

Name of the merchant related to the transaction on this case.

merchant.transactionId

String

Transaction ID sent by merchant during processing.

submerchant

Object

Sub merchant information related to the case

submerchant.name

String

Name of the sub-merchant related of the transaction on this case.

transaction

Object

Transaction information related to the case.

transaction.uuid

String

Unique ID of the corresponding sale transaction on PPRO. Will be deprecated soon and replaced with transaction.id

transaction.id

String

ID used in the payment engine.

transaction.date

String

Date on which the transaction was processed in UTC.

transaction.cardNumber

String

Masked card number, if applicable.

transaction.brand

String

Card brand, if applicable.

transaction.descriptor

String

Soft descriptor applied to the transaction.

transaction.amount

Decimal

Transaction amount for this case. Must be between 0.0 and 10,000,000,000.

statuses

Arrayk:parame

Case status history.

statuses[].status

String

The case status after the specified date. Must be one of "h-1": "Type", "h-2": "Description", "0-0": "id", "0-1": "String", "0-2": "The ID of the case.", "1-0": "`

statuses[].date

String

The date on which the case received the status.

Example

{
  "id" : "909fb467-8212-4332-bb22-30758457ad6c",
  "receptionDate" : "2023-08-18T15:23:50.322335",
  "responseDueDate" : "2023-10-01T15:23:50.322335",
  "responseDate" : "2023-09-07T15:23:50.322335",
  "chargebackAmount" : 10000,
  "reasonCode" : "2189",
  "fraud" : false,
  "currency" : "BRL",
  "lastUpdateDate" : "2023-09-17T15:23:50.322335",
  "status" : "NEW",
  "merchant" : {
    "name" : "Example Merchant",
    "transactionId" : "5fd9e952-971f-4e2d-9313-dbf1c0f9cf51"
  },
  "submerchant" : { },
  "transaction" : {
    "uuid" : "1beaf092-2e36-43b8-b442-0682d46c57e6",
    "date" : "2023-08-23T15:23:50.322449",
    "cardNumber" : "445512******3456",
    "brand" : "Visa",
    "descriptor" : "Product 0001",
    "amount" : 10000.35
  },
  "statuses" : [ {
    "status" : "NEW",
    "date" : "2023-09-17T15:23:50.322335"
  } ]
}