Get disputes
GET https://{domainname}/v1/{merchantId}/payments/{paymentId}/disputes
Payments
The payments REST services allow you to initiate a payment, retrieve the payment details or perform specific actions like refunding or requesting capture of a payment. A payment is identified by its paymentId. Some payment products allow a two step approach allowing you to control when the authorization takes place separate from when the funds are actually captured.
Request
Retrieves the disputes created for a given payment, if any.
Request example
SDK: Ruby
Default scenario
This scenario you will probably use the most
-
response = client.v1.merchant('merchantId').payments.disputes('paymentId')
Responses
A list of the disputes created for the given payment.
Response 200 - OKDisputesResponse
The response contains a list of disputes associated with a payment. This list can be empty if there are no disputes for this specific payment.
|
Properties
|
|||
| Property | Type | Required | Details |
|---|---|---|---|
| array of object | no | read close | |
|
close
DescriptionArray containing disputes and their characteristics.
|
|||
|
close
DescriptionThis property contains the creationDetails and default information regarding a dispute.
|
|||
|
close
DescriptionObject containing amount and ISO currency code attributes
|
|||
|
close
DescriptionAmount in cents and always having 2 decimals
|
|||
|
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
|
close
DescriptionThe name of the person on your side who can be contacted regarding this dispute.
|
|||
|
close
DescriptionObject containing various details related to this dispute’s creation.
|
|||
|
close
DescriptionThe date and time of creation of this dispute, in yyyyMMddHHmmss format.
|
|||
|
close
DescriptionThe originator of this dispute, which is either Worldline or you as our client.
|
|||
|
close
DescriptionThe user account name of the dispute creator.
|
|||
|
close
DescriptionThe email address of the contact person.
|
|||
|
close
DescriptionAn array containing all files related to this dispute.
|
|||
|
close
DescriptionThe name of the file.
|
|||
|
close
DescriptionThe size of the file in bytes.
|
|||
|
close
DescriptionThe type of the file.
|
|||
|
close
DescriptionThe numeric identifier of the file.
|
|||
|
close
DescriptionA collection of reference information related to this dispute.
|
|||
|
close
DescriptionThe merchant’s order ID of the transaction to which this dispute is linked.
|
|||
|
close
DescriptionYour (unique) reference for the transaction that you can use to reconcile our report files.
|
|||
|
close
DescriptionPayment Reference generated by WebCollect.
|
|||
|
close
DescriptionThe numerical identifier of the Service Provider (Acquirer).
|
|||
|
close
DescriptionThe Service Provider’s reference.
|
|||
|
close
DescriptionThe email address to which the reply message will be sent.
|
|||
|
close
DescriptionThe message sent from you to Worldline.
|
|||
|
close
DescriptionThe return message sent from the GlobalCollect platform to you.
|
|||
|
close
DescriptionDispute ID for a given merchant.
|
|||
|
close
DescriptionThe ID of the payment that is being disputed.
|
|||
|
close
DescriptionCurrent dispute status.
|
|||
|
close
DescriptionThis property contains the output for a dispute regarding the status of the dispute.
|
|||
|
close
DescriptionFlag indicating if the payment can be cancelled
|
|||
|
close
DescriptionHighlevel status of the payment, payout or refund with the following possible values:
Please see Statuses for a full overview of possible values. |
|||
|
close
DescriptionNumeric status code of the legacy API. It is returned to ease the migration from the legacy APIs to Worldline Connect. You should not write new business logic based on this property as it will be deprecated in a future version of the API. The value can also be found in the GlobalCollect Payment Console, in the Ogone BackOffice and in report files.
|
|||
|
close
DescriptionDate and time of payment
Format: YYYYMMDDHH24MISS |
|||
| Property | Type | Required | Details |
Response example
SDK: Ruby
Default scenario
This scenario you will probably use the most
-
{ "disputeOutput" : { "amountOfMoney" : { "amount" : 1234, "currencyCode" : "EUR" }, "contactPerson" : "Wile E. Coyote", "creationDetails" : { "disputeCreationDate" : "20181218035202" }, "emailAddress" : "wile.e.coyote@acmelabs.com", "files" : [ ], "reference" : { "paymentReference" : "0", "providerId" : "1000000071" }, "replyTo" : "wile.e.coyote@acmelabs.com", "requestMessage" : "This is the message from the merchant to GlobalCollect" }, "id" : "821", "paymentId" : "000000170100001958950000100001", "status" : "DRAFT", "statusOutput" : { "isCancellable" : false, "statusCode" : 500, "statusCodeChangeDateTime" : "20181218035202" } }
Response 404 - Not foundErrorResponse
The requested payment does not have any associated disputes.
|
Properties
|
|||
| Property | Type | Required | Details |
|---|---|---|---|
| errorId | string | yes | read close |
|
close
DescriptionUnique reference, for debugging purposes, of this error response
|
|||
| array of object | yes | read close | |
|
close
DescriptionList of one or more errors
|
|||
|
close
DescriptionCategory the error belongs to. The category should give an indication of the type of error you are dealing with.
Possible values:
|
|||
|
close
DescriptionError code
|
|||
|
close
DescriptionHTTP status code for this error that can be used to determine the type of error
|
|||
|
close
DescriptionID of the error. This is a short human-readable message that briefly describes the error.
|
|||
|
close
DescriptionHuman-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
|
|||
|
close
DescriptionReturned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query. Some common examples:
|
|||
|
close
DescriptionID of the request that can be used for debugging purposes
|
|||
| Property | Type | Required | Details |
Response example
SDK: Ruby
Default scenario
This scenario you will probably use the most
-
{ "errorId" : "5c3712a9b48a7483433aa2b5a289c95d", "errors" : [ { "code" : "310404100", "id" : "DISPUTE_DATA_NOT_FOUND", "category" : "DISPUTE_SERVICE_ERROR", "message" : "No dispute found for merchantId and dispute id", "httpStatusCode" : 404 } ] }