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: Python

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.

Property	Type	Required	Details
Properties Expand all properties Hide deprecated properties
disputes	array of object	no	read close
close Description Array containing disputes and their characteristics.
items	object	no	read close
close Description All items in the dispute response. SDK Object type Dispute
disputeOutput	object	no	read close
close Description This property contains the creationDetails and default information regarding a dispute. SDK Object type DisputeOutput
amountOfMoney	object	no	read close
close Description Object containing amount and ISO currency code attributes SDK Object type AmountOfMoney
amount	integer (12)	yes	read close
close Description Amount in cents and always having 2 decimals
currencyCode	string (3)	yes	read close
close Description Three-letter ISO currency code representing the currency for the amount
contactPerson	string	no	read close
close Description The name of the person on your side who can be contacted regarding this dispute.
creationDetails	object	no	read close
close Description Object containing various details related to this dispute’s creation. SDK Object type DisputeCreationDetail
disputeCreationDate	string	no	read close
close Description The date and time of creation of this dispute, in yyyyMMddHHmmss format.
disputeOriginator	string	no	read close
close Description The originator of this dispute, which is either Worldline or you as our client.
userName	string	no	read close
close Description The user account name of the dispute creator.
emailAddress	string	no	read close
close Description The email address of the contact person.
files	array of object	no	read close
close Description An array containing all files related to this dispute.
items	object	no	read close
close SDK Object type HostedFile
fileName	string	no	read close
close Description The name of the file.
fileSize	string	no	read close
close Description The size of the file in bytes.
fileType	string	no	read close
close Description The type of the file.
id	string	no	read close
close Description The numeric identifier of the file.
reference	object	no	read close
close Description A collection of reference information related to this dispute. SDK Object type DisputeReference
merchantOrderId	string	no	read close
close Description The merchant’s order ID of the transaction to which this dispute is linked.
merchantReference	string	no	read close
close Description Your (unique) reference for the transaction that you can use to reconcile our report files.
paymentReference	string	no	read close
close Description Payment Reference generated by WebCollect.
providerId	string	no	read close
close Description The numerical identifier of the Service Provider (Acquirer).
providerReference	string	no	read close
close Description The Service Provider’s reference.
replyTo	string	no	read close
close Description The email address to which the reply message will be sent.
requestMessage	string	no	read close
close Description The message sent from you to Worldline.
responseMessage	string	no	read close
close Description The return message sent from the GlobalCollect platform to you.
id	string	no	read close
close Description Dispute ID for a given merchant.
paymentId	string	no	read close
close Description The ID of the payment that is being disputed.
status	string	no	read close
close Description Current dispute status.
statusOutput	object	no	read close
close Description This property contains the output for a dispute regarding the status of the dispute. SDK Object type DisputeStatusOutput
isCancellable	boolean	no	read close
close Description Flag indicating if the payment can be cancelled true false
statusCategory	string	no	read close
close Description Highlevel status of the payment, payout or refund with the following possible values: CREATED - The transaction has been created. This is the initial state once a new payment, payout or refund is created. This category groups the following statuses: CREATED PENDING_PAYMENT: The payment is waiting on customer action. This category groups the following statuses: PENDING_PAYMENT REDIRECTED ACCOUNT_VERIFIED: The account has been verified. This category groups the following statuses: ACCOUNT_VERIFIED PENDING_MERCHANT: The transaction is awaiting approval to proceed with the payment, payout or refund. This category groups the following statuses: PENDING_APPROVAL PENDING_COMPLETION PENDING_CAPTURE PENDING_FRAUD_APPROVAL PENDING_CONNECT_OR_3RD_PARTY: The transaction is in the queue to be processed. This category groups the following statuses: AUTHORIZATION_REQUESTED CAPTURE_REQUESTED PAYOUT_REQUESTED REFUND_REQUESTED COMPLETED: The transaction has completed. This category groups the following statuses: CAPTURED PAID ACCOUNT_CREDITED CHARGEBACK_NOTIFICATION REVERSED: The transaction has been reversed. This category groups the following statuses: CHARGEBACKED REVERSED REFUNDED: The transaction has been refunded. This category groups the following statuses: REFUNDED UNSUCCESSFUL: The transaction has been rejected or is in such a state that it will never become successful. This category groups the following statuses: CANCELLED REJECTED REJECTED_CAPTURE REJECTED_CREDIT Please see Statuses for a full overview of possible values.
statusCode	integer	no	read close
close Description Numeric 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.
statusCodeChangeDateTime	string	no	read close
close Description Date and time of payment Format: YYYYMMDDHH24MISS

Response example

SDK: Python

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.

Property	Type	Required	Details
Properties Expand all properties Hide deprecated properties
errorId	string	yes	read close
close Description Unique reference, for debugging purposes, of this error response
errors	array of object	yes	read close
close Description List of one or more errors
items	object	no	read close
close Description Contains detailed information on one single error. SDK Object type APIError
category	string	no	read close
close Description Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values: CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform. PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform. IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
code	string	yes	read close
close Description Error code
httpStatusCode	integer	no	read close
close Description HTTP status code for this error that can be used to determine the type of error
id	string	no	read close
close Description ID of the error. This is a short human-readable message that briefly describes the error.
message	string	no	read close
close Description Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
propertyName	string	no	read close
close Description Returned 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: a.b selects the value of property b of root property a, a[1] selects the first element of the array in root property a, a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
requestId	string	no	read close
close Description ID of the request that can be used for debugging purposes

Response example

SDK: Python

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
        }
    ]
}

Get disputes

Payments

Request

Request example

Responses

Response 200 - OKDisputesResponse

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Response example

Response 404 - Not foundErrorResponse

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Response example