ALL
Server API version 1.0
Java

icon-search-large

Submit dispute

POST https://{domainname}/v1/{merchantId}/disputes/{disputeId}/submit

Disputes

The Dispute REST Service allows you to retrieve and manage disputes that have been created on a payment. Dispute requests will only be handled after you have submitted the dispute, which should only be done after you have uploaded all the evidence.

Request

This REST service submits a previously created dispute.

Request example

SDK: Java

This scenario you will probably use the most

  • DisputeResponse response = client.merchant("merchantId").disputes().submit("disputeId");
    

Responses

Please find below an overview of the possible responses.

Response 200 - OKDisputeResponse

The dispute status was changed from DRAFT to CREATED. The response contains the standard dispute object.

Property Type Required Details
disputeOutput object no read close
close

Description

A list containing all dispute-related information that is generated upon dispute creation.
  • SDK Object type
    DisputeOutput
close

Description

Object containing amount and ISO currency code attributes
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

The name of the person on your side who can be contacted regarding this dispute.
close

Description

Object containing various details related to this dispute’s creation.
  • SDK Object type
    DisputeCreationDetail
close

Description

The date and time of creation of this dispute, in yyyyMMddHHmmss format.
close

Description

The originator of this dispute, which is either Ingenico ePayments or you as our client.
close

Description

The user account name of the dispute creator.
close

Description

The email address of the contact person.
close

Description

An array containing all files related to this dispute.
close
  • SDK Object type
    HostedFile
close

Description

The name of the file.
close

Description

The size of the file in bytes.
close

Description

The type of the file.
close

Description

The numeric identifier of the file.
close

Description

A collection of reference information related to this dispute.
  • SDK Object type
    DisputeReference
close

Description

The merchant’s order ID of the transaction to which this dispute is linked.
close

Description

Your (unique) reference for the transaction that you can use to reconcile our report files.
close

Description

Payment Reference generated by WebCollect.
close

Description

The numerical identifier of the Service Provider (Acquirer).
close

Description

The Service Provider’s reference.
close

Description

The email address to which the reply message will be sent.
close

Description

The message sent from you to Ingenico ePayments.
close

Description

The return message sent from the GlobalCollect platform to you.
id string no read close
close

Description

The numeric identifier of the file.
paymentId string no read close
close

Description

The ID of the payment that is being disputed.
status string no read close
close

Description

The status of the dispute in alphabetical format, e.g. CREATED, DRAFT, etc.
statusOutput object no read close
close

Description

This object has the numeric representation of the current payment status, timestamp of last status change and performable action on the current payment resource. In case of failed payments and negative scenarios, detailed error information is listed.
  • SDK Object type
    DisputeStatusOutput
close

Description

Flag indicating if the payment can be cancelled
  • true
  • false
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 consumer 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.
close

Description

Numeric status code that is returned by either Ingenico's Global Collect Payment Platform or Ingenico's Ogone Payment Platform. It is returned to ease the migration from the local APIs to Ingenico Connect. You should not write new business logic based on this field as it will be deprecated in a future version of the API. The value can also be found in the Global Collect Payment Console, in the Global Collect report files and the Ogone BackOffice and report files.
close

Description

Date and time of payment
Format: YYYYMMDDHH24MISS

Response example

SDK: Java

This scenario you will probably use the most

  • {
        "id" : "162",
        "paymentId" : "000000852800000014110000100001",
        "disputeOutput" : {
            "creationDetails" : {
                "disputeCreationDate" : "20180702020752",
                "disputeOriginator" : "Merchant / Ingenico",
                "userName" : ""
            },
            "contactPerson" : "Wile Coyote",
            "emailAddress" : "wile.e.coyote@acmelabs.com",
            "replyTo" : "wile.e.coyote@acmelabs.com",
            "requestMessage" : "This is the message from the merchant to GlobalCollect.",
            "responseMessage" : "This is the response back from GlobalCollect to the merchant",
            "amountOfMoney" : {
                "amount" : 1234,
                "currencyCode" : "USD"
            },
            "files" : [
                {
                    "fileName" : "file.pdf",
                    "id" : "d3BjLWRpc3B1dGU6MDAwMDAwMTcwMTAwMDAyMDIzMjYwMDAwMTAwMDAxOmNsZWFuLWNvZGUtcHl0aG9uMy5wZGY=",
                    "fileType" : "application/pdf",
                    "fileSize" : "4261722"
                }
            ]
        },
        "status" : "CREATED",
        "statusOutput" : {
            "isCancellable" : true,
            "statusCode" : 600,
            "statusCodeChangeDateTime" : "20180731033126"
        }
    }
    

Response 400 - Bad requestErrorResponse

Property Type Required Details
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
close

Description

Contains detailed information on one single error.
  • SDK Object type
    APIError
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.
close

Description

Error code
close

Description

HTTP status code for this error that can be used to determine the type of error
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
close

Description

Human-readable error message that is not meant to be relayed to consumer as it might tip off people who are trying to commit fraud
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'.
close

Description

ID of the request that can be used for debugging purposes

Response example

SDK: Java

This scenario you will probably use the most

  • {
        "errorId" : "5c3c638abff221fe4e90f41d20d4863d",
        "errors" : [
            {
                "code" : "310400200",
                "id" : "DISPUTE_ACTION_NOT_ALLOWED_ON_TRANSACTION",
                "category" : "DISPUTE_SERVICE_ERROR",
                "message" : "Action not allowed for current state",
                "httpStatusCode" : 400
            }
        ]
    }
    
icon_top_1