Search Cases Response

Field

Type

Description

numberOfElements

Integer

Total number of elements in the response.

page

Integer

Current page number for this response starting with 0

hasNext

Boolean

Indicates whether there is a next page (true) or not (false).

content

Arrayk:parame

Content to the respective request.

content[].id

String

The ID of the case.

content[].receptionDate

String

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

content[].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

content[].responseDate

String

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

content[].chargebackAmount

Decimal

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

content[].reasonCode

String

Reason code originating from the acquirer side.

content[].fraud

Boolean

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

content[].currency

String

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

content[].lastUpdateDate

String

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

content[].status

String

Last status applied to the case. Must be one of ld", "h-1": "Type", "h-2": "Description", "0-0": "numberOfElements", "0-1": "Integer", "0-2": "Total nu

content[].merchant

Object

Merchant information related to the case.

content[].merchant.name

String

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

content[].merchant.transactionId

String

Transaction ID sent by merchant during processing.

content[].submerchant

Object

Sub-merchant information related to the case.

content[].submerchant.name

String

Name of the Sub Merchant related to the transaction on this case.

content[].transaction

Object

Transaction information related to the case.

content[].transaction.uuid

String

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

content[].transaction.id

String

ID used in the payment engine.

content[].transaction.date

String

Date on which the transaction was processed in UTC.

content[].transaction.cardNumber

String

Masked card number, if applicable.

content[].transaction.brand

String

Card Brand, if applicable.

content[].transaction.descriptor

String

Soft descriptor applied to the transaction.

content[].transaction.amount

String

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

content[].statuses

Arrayk:parame

Case status history.

content[].statuses[].status

String

The case status after the specified date. Must be one of "h-1": "Type", "h-2": "Description", "0-0": "numberOfElements", "0-1": "Integer", "0-2": "Total number of el

content[].statuses[].date

String

The date on which the case received the status.

Example

{
  "content" : [ {
    "id" : "8fbf8e08-f2e9-4a89-9b6a-63f60caa339f",
    "receptionDate" : "2023-09-14T15:23:47.247829",
    "responseDueDate" : "2023-10-01T15:23:47.247829",
    "responseDate" : "2023-09-07T15:23:47.247829",
    "chargebackAmount" : 10000,
    "reasonCode" : "2189",
    "fraud" : false,
    "currency" : "BRL",
    "lastUpdateDate" : "2023-09-17T15:23:47.247829",
    "status" : "NEW",
    "merchant" : {
      "name" : "Example Merchant",
      "transactionId" : "edd5327c-6db4-407d-8646-e182ad966b96"
    },
    "submerchant" : { },
    "transaction" : {
      "uuid" : "8fbf8e08-f2e9-4a89-9b6a-63f60caa339f",
      "date" : "2023-08-23T15:23:47.247947",
      "cardNumber" : "445512******3456",
      "brand" : "Visa",
      "descriptor" : "Product 0001",
      "amount" : 10000.35
    },
    "statuses" : [ {
      "status" : "NEW",
      "date" : "2023-09-17T15:23:47.247829"
    } ]
  }, {
    "id" : "f73be521-bd6d-43a6-a50c-11c954a4ccdf",
    "receptionDate" : "2023-09-14T15:23:47.247829",
    "responseDueDate" : "2023-10-01T15:23:47.247829",
    "responseDate" : "2023-09-07T15:23:47.247829",
    "chargebackAmount" : 10000,
    "reasonCode" : "2189",
    "fraud" : false,
    "currency" : "BRL",
    "lastUpdateDate" : "2023-09-17T15:23:47.247829",
    "status" : "NEW",
    "merchant" : {
      "name" : "Example Merchant",
      "transactionId" : "852b45d4-e3ac-4e2d-862c-e43edf00434c"
    },
    "submerchant" : { },
    "transaction" : {
      "uuid" : "f73be521-bd6d-43a6-a50c-11c954a4ccdf",
      "date" : "2023-08-23T15:23:47.263887",
      "cardNumber" : "445512******3456",
      "brand" : "Visa",
      "descriptor" : "Product 0001",
      "amount" : 10000.35
    },
    "statuses" : [ {
      "status" : "NEW",
      "date" : "2023-09-17T15:23:47.247829"
    } ]
  }, {
    "id" : "32a95ce8-4b9a-4c1b-98c1-3d7a96824678",
    "receptionDate" : "2023-09-14T15:23:47.247829",
    "responseDueDate" : "2023-10-01T15:23:47.247829",
    "responseDate" : "2023-09-07T15:23:47.247829",
    "chargebackAmount" : 10000,
    "reasonCode" : "2189",
    "fraud" : false,
    "currency" : "BRL",
    "lastUpdateDate" : "2023-09-17T15:23:47.247829",
    "status" : "NEW",
    "merchant" : {
      "name" : "Example Merchant",
      "transactionId" : "26ee9785-a359-4183-9fba-d94c3eeeb093"
    },
    "submerchant" : { },
    "transaction" : {
      "uuid" : "32a95ce8-4b9a-4c1b-98c1-3d7a96824678",
      "date" : "2023-08-23T15:23:47.265398",
      "cardNumber" : "445512******3456",
      "brand" : "Visa",
      "descriptor" : "Product 0001",
      "amount" : 10000.35
    },
    "statuses" : [ {
      "status" : "NEW",
      "date" : "2023-09-17T15:23:47.247829"
    } ]
  } ],
  "page" : 0,
  "hasNext" : false,
  "numberOfElements" : 3
}