Closes a dispute

put https://api-preview.platform.breadpayments.com/api/servicing/payment-agreement/{id}/disputes/{disputeID}

Closes the dispute on a payment agreement

Path Params

uuid

required

The unique ID of the payment agreement.

disputeID

uuid

required

The unique ID of the product dispute.

Body Params

Request Body for Open Product Dispute endpoint

resolutionCode

string

required

Defaults to UNSPECIFIED_REASON_CODE

chargebackType

string

required

Defaults to UNKNOWN_CHARGEBACK_TYPE

chargebackAmount

object

Represents a monetary amount in the specified currency

rescinded

boolean

Whether the chargeback is due to invoking right of rescission

Responses

Response body

object

dispute

object

required

resolutionCode

string

required

Defaults to UNSPECIFIED_REASON_CODE

UNSPECIFIED_REASON_CODE PRODUCT_NOT_RECEIVED DAMAGED_OR_DEFECTIVE_PRODUCT PRODUCT_NOT_AS_DESCRIBED DUPLICATE_CHARGE INCORRECT_CHARGE_AMOUNT CANCELLATION_NOT_HONORED RETURN_REFUSAL_NOT_HONORED INCORRECT_CREDIT_ISSUED DIFFERENT_PAYMENT_METHOD_USED SERVICES_NOT_RENDERED MISLEADING_MARKETING_MATERIAL AUTHORIZATION_GIVEN_BY_THIRD_PARTY INVALID_DISPUTE_INSUFFICIENT_EVIDENCE DISPUTE_RESOLVED_BY_MERCHANT CUSTOMER_WITHDRAWS_DISPUTE OTHER HANDLED_BY_3RD_PARTY RIGHT_OF_RESCISSION

chargebackType

string

required

Defaults to UNKNOWN_CHARGEBACK_TYPE

UNKNOWN_CHARGEBACK_TYPE NONE PARTIAL FULL

chargebackAmount

object

required

Represents a monetary amount in the specified currency

rescinded

boolean

Whether the chargeback is due to invoking right of rescission

uuid

required

A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.

paymentAgreementID

uuid

required

A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.

scopeID

uuid

required

A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.

disputeCode

string

required

Defaults to UNSPECIFIED_REASON_CODE

status

string

required

Defaults to OPEN

OPEN CLOSED

resolvedAt

date-time

The timestamp value formatted per RFC3339. This does not allow nulls.

createdAt

date-time

required

The timestamp value formatted per RFC3339. This does not allow nulls.

updatedAt

date-time

required

The timestamp value formatted per RFC3339. This does not allow nulls.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
10
1
curl --request PUT \
2
     --url https://api-preview.platform.breadpayments.com/api/servicing/payment-agreement/id/disputes/disputeID \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "resolutionCode": "UNSPECIFIED_REASON_CODE",
8
  "chargebackType": "UNKNOWN_CHARGEBACK_TYPE"
9
}
10
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

200A successful response - close product dispute.

401Unauthorized. Indicates that provided credentials is not valid

403an unsuccessful response

500an unsuccessful response