For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
GuidesAPI Reference
GuidesAPI Reference
  • Reference
    • Introduction
      • GETRetrieve Dispute
      • GETReceive Dispute
      • POSTRespond to Dispute
      • GETAccept Dispute
      • POSTUpload File
      • GETRetrieve file
LogoLogo
ReferenceDisputes

Respond to Dispute

POST
/v2/disputes/:dispute_id
POST
/v2/disputes/:dispute_id
$curl -X POST https://global-api-sandbox.afterpay.com/v2/disputes/dispute_id \
>     -H "User-Agent: User-Agent" \
>     -H "Content-Type: application/json" \
>     -u "<username>:<password>" \
>     -d '{}'
1{
2  "id": "dp_N64jYg4RC4ZBUsXjLzE3W5",
3  "order": "123456789",
4  "amount": "48.46",
5  "reason": "product_not_received",
6  "status": "needs_response",
7  "open": true,
8  "responseDueBy": "1691884800",
9  "createdAt": "1691880800",
10  "openingNote": "Customer has no knowledge of the payment",
11  "closingReason": "merchant_accepted",
12  "merchantOrderId": "order54321",
13  "transactionDate": "1691882800",
14  "settlementAmount": "48.46",
15  "openingNoteAttachments": "[“fi_48vmw3sXdVqvtJGXbgKbAZ”]",
16  "updatedAt": "1691884000",
17  "closingNote": "Merchant accepted the dispute",
18  "meta": {
19    "transactionAmount": "48.46",
20    "orderType": "ONLINE",
21    "network": "Visa",
22    "networkReferenceId": "string"
23  }
24}

The Respond to the Dispute endpoint allows a merchant to submit evidence for the dispute. This is only allowed if the dispute is the state needs_response.

Merchants only have one opportunity to submit evidence. Once a 200 response is received, this information cannot be updated or changed.

Was this page helpful?
Previous

Accept Dispute

Next
Built with

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

dispute_idstringRequired

Headers

User-AgentstringRequired
AcceptstringOptional

application/json

Request

This endpoint expects an object.
idstringOptional
A unique ID given to a dispute.
evidenceobjectOptional
Evidence for the dispute. Note that there should be at least one valid field.

Response

When successful, returns the updated dispute object
idstring
Dispute identifier
orderstring
The token of the order that the dispute is for.
amountstring
The amount of the dispute
reasonenum
The reason for the dispute.
statusenum
The current state of the dispute. Values depend on how the dispute state machine is modeled.
openbooleanDefaults to true

True if a final decision on the dispute hasn’t been made yet.

responseDueBystring

Deadline by which the merchant must respond to the dispute. (Epoch timestamp in seconds, timezone UTC +0.00)

createdAtstring

A timestamp indicating when the dispute was created. (Epoch timestamp in seconds, timezone UTC +0.00)

openingNotestring

Text from the customer describing why the dispute was opened or the reason for the complaint. While dispute category codes are helpful at informing what a merchant should present, it doesn’t provide reasoning behind the customer’s complaint. In some cases, this can help merchants troubleshoot the dispute directly with their customers.

closingReasonenum
A reason indicating how the final decision on the dispute was reached. Recommended possible values listed in Closing Reasons.
Allowed values:
merchantOrderIdstring
The identifier for the transaction on the merchant side.
transactionDatestring

The timestamp of the order created by the customer. (Epoch timestamp in seconds, timezone UTC +0.00)

settlementAmountstring
The settlementAmount for audit usage.
openingNoteAttachmentsstring

Attachments to supplement the openingNote if the customer provided photos or screenshots as part of their dispute description.

updatedAtstring

Timestamp when the dispute was updated. (Epoch timestamp in seconds, timezone UTC +0.00)

closingNotestring

Text describing in detail how the final decision on the dispute was reached. This supplements the closingReason.

metaobject
The extra information for merchants to match payment.