disputes

README

Go API client for disputes

This API provides endpoints for dispute management. You can use the API to retrieve defense reasons, supply defense ducoments, delete defense documents, upload chargebacks or accept disputes.

For more information on using the APIs, refer to Dispute service.

Authentication

Each request to the Dispute API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in How to get the API key. Then set this key to the X-API-Key header value, for example:

curl
-H \"Content-Type: application/json\" \\
-H \"X-API-Key: Your_API_key\" \\
...

Note that when going live, you need to generate new web service user credentials to access the live endpoints.

## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.  By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.

- API version: 1
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoClientExperimentalCodegen
For more information, please visit [https://support.adyen.com/](https://support.adyen.com/)

Documentation

Index

• type DefendDisputeRequest
• type DefendDisputeResponse
• type DefenseDocument
• type DefenseDocumentType
• type DefenseReason
• type DefenseReasonsRequest
• type DefenseReasonsResponse
• type DeleteDefenseDocumentRequest
• type DeleteDefenseDocumentResponse
• type DisputeServiceResult
• type Disputes
  • func (a Disputes) DefendDispute(req *DefendDisputeRequest, ctxs ..._context.Context) (DefendDisputeResponse, *_nethttp.Response, error)
  • func (a Disputes) DeleteDisputeDefenseDocument(req *DeleteDefenseDocumentRequest, ctxs ..._context.Context) (DeleteDefenseDocumentResponse, *_nethttp.Response, error)
  • func (a Disputes) DownloadDisputeDefenseDocument(req *DownloadDefenseDocumentRequest, ctxs ..._context.Context) (DownloadDefenseDocumentResponse, *_nethttp.Response, error)
  • func (a Disputes) RetrieveApplicableDefenseReasons(req *DefenseReasonsRequest, ctxs ..._context.Context) (DefenseReasonsResponse, *_nethttp.Response, error)
  • func (a Disputes) SupplyDefenseDocument(req *SupplyDefenseDocumentRequest, ctxs ..._context.Context) (SupplyDefenseDocumentResponse, *_nethttp.Response, error)
• type DownloadDefenseDocumentRequest
• type DownloadDefenseDocumentResponse
• type SupplyDefenseDocumentRequest
• type SupplyDefenseDocumentResponse

Types

type DefendDisputeRequest

type DefendDisputeRequest struct {
	// The reasoncode for this dispute
	DefenseReasonCode string `json:"defenseReasonCode"`
	// The psp reference of the dispute
	DisputePspReference string `json:"disputePspReference"`
	// The merchant account identifier
	MerchantAccountCode string `json:"merchantAccountCode"`
}

DefendDisputeRequest struct for DefendDisputeRequest

type DefendDisputeResponse

type DefendDisputeResponse struct {
	DisputeServiceResult DisputeServiceResult `json:"disputeServiceResult"`
}

DefendDisputeResponse struct for DefendDisputeResponse

type DefenseDocument

type DefenseDocument struct {
	// The content of the defense document
	Content string `json:"content"`
	// The content type of the defense document
	ContentType string `json:"contentType"`
	// The typecode for the defense document type
	DefenseDocumentTypeCode string `json:"defenseDocumentTypeCode"`
}

DefenseDocument struct for DefenseDocument

type DefenseDocumentType

type DefenseDocumentType struct {
	// Indicates if this document type is available
	Available bool `json:"available"`
	// The typecode for the defense document type
	DefenseDocumentTypeCode string `json:"defenseDocumentTypeCode"`
	// The requirement level for the defense document type
	RequirementLevel string `json:"requirementLevel"`
}

DefenseDocumentType struct for DefenseDocumentType

type DefenseReason

type DefenseReason struct {
	// Defense ducoment types
	DefenseDocumentTypes *[]DefenseDocumentType `json:"defenseDocumentTypes,omitempty"`
	// The reason code for this specific defense
	DefenseReasonCode string `json:"defenseReasonCode"`
	// Indicates if this defense reason is satisfied
	Satisfied bool `json:"satisfied"`
}

DefenseReason struct for DefenseReason

type DefenseReasonsRequest

type DefenseReasonsRequest struct {
	// The psp reference of the dispute
	DisputePspReference string `json:"disputePspReference"`
	// The merchant account identifier
	MerchantAccountCode string `json:"merchantAccountCode"`
}

DefenseReasonsRequest struct for DefenseReasonsRequest

type DefenseReasonsResponse

type DefenseReasonsResponse struct {
	// Defense reasons
	DefenseReasons       *[]DefenseReason     `json:"defenseReasons,omitempty"`
	DisputeServiceResult DisputeServiceResult `json:"disputeServiceResult"`
}

DefenseReasonsResponse struct for DefenseReasonsResponse

type DeleteDefenseDocumentRequest

type DeleteDefenseDocumentRequest struct {
	// The specific type of the defense document
	DefenseDocumentType string `json:"defenseDocumentType"`
	// The psp reference of the dispute
	DisputePspReference string `json:"disputePspReference"`
	// The merchant account identifier
	MerchantAccountCode string `json:"merchantAccountCode"`
}

DeleteDefenseDocumentRequest struct for DeleteDefenseDocumentRequest

type DeleteDefenseDocumentResponse

type DeleteDefenseDocumentResponse struct {
	DisputeServiceResult DisputeServiceResult `json:"disputeServiceResult"`
}

DeleteDefenseDocumentResponse struct for DeleteDefenseDocumentResponse

type DisputeServiceResult

type DisputeServiceResult struct {
	// error message, empty if request was successfull
	ErrorMessage string `json:"errorMessage,omitempty"`
	// Indicates whether or not the request succeeded
	Success bool `json:"success"`
}

DisputeServiceResult struct for DisputeServiceResult

type Disputes

type Disputes common.Service

Disputes Disputes service

func (Disputes) DefendDispute

func (a Disputes) DefendDispute(req *DefendDisputeRequest, ctxs ..._context.Context) (DefendDisputeResponse, *_nethttp.Response, error)

PostDefendDispute Defend dispute Defend the dispute with the given reason code.

• @param request DefendDisputeRequest - reference of DefendDisputeRequest).
• @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return DefendDisputeResponse

func (Disputes) DeleteDisputeDefenseDocument

func (a Disputes) DeleteDisputeDefenseDocument(req *DeleteDefenseDocumentRequest, ctxs ..._context.Context) (DeleteDefenseDocumentResponse, *_nethttp.Response, error)

PostDeleteDisputeDefenseDocument Delete dispute defense document Delete a dispute defense document.

• @param request DeleteDefenseDocumentRequest - reference of DeleteDefenseDocumentRequest).
• @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return DeleteDefenseDocumentResponse

func (Disputes) DownloadDisputeDefenseDocument

func (a Disputes) DownloadDisputeDefenseDocument(req *DownloadDefenseDocumentRequest, ctxs ..._context.Context) (DownloadDefenseDocumentResponse, *_nethttp.Response, error)

GetDownloadDisputeDefenseDocument Download Dispute defense document Download a dispute defense document.

• @param request DownloadDefenseDocumentRequest - reference of DownloadDefenseDocumentRequest).
• @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return DownloadDefenseDocumentResponse

func (Disputes) RetrieveApplicableDefenseReasons

func (a Disputes) RetrieveApplicableDefenseReasons(req *DefenseReasonsRequest, ctxs ..._context.Context) (DefenseReasonsResponse, *_nethttp.Response, error)

GetRetrieveApplicableDefenseReasons Retrieve applicable defense reasons Retrieve a list of possible defense reasons with required documents for the given dispute.

• @param request DefenseReasonsRequest - reference of DefenseReasonsRequest).
• @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return DefenseReasonsResponse

func (Disputes) SupplyDefenseDocument

func (a Disputes) SupplyDefenseDocument(req *SupplyDefenseDocumentRequest, ctxs ..._context.Context) (SupplyDefenseDocumentResponse, *_nethttp.Response, error)

PostSupplyDefenseDocument Supply defense document Supply a dispute defense document.

• @param request SupplyDefenseDocumentRequest - reference of SupplyDefenseDocumentRequest).
• @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return SupplyDefenseDocumentResponse

type DownloadDefenseDocumentRequest

type DownloadDefenseDocumentRequest struct {
	// The specific type of the defense document
	DefenseDocumentType string `json:"defenseDocumentType"`
	// The psp reference of the dispute
	DisputePspReference string `json:"disputePspReference"`
	// The merchant account identifier
	MerchantAccountCode string `json:"merchantAccountCode"`
}

DownloadDefenseDocumentRequest struct for DownloadDefenseDocumentRequest

type DownloadDefenseDocumentResponse

type DownloadDefenseDocumentResponse struct {
	// The content of the dispute defense document
	Content string `json:"content,omitempty"`
	// The content type of the dispute defense document
	ContentType          string               `json:"contentType,omitempty"`
	DisputeServiceResult DisputeServiceResult `json:"disputeServiceResult"`
}

DownloadDefenseDocumentResponse struct for DownloadDefenseDocumentResponse

type SupplyDefenseDocumentRequest

type SupplyDefenseDocumentRequest struct {
	// The defense documents to be supplied
	DefenseDocuments []DefenseDocument `json:"defenseDocuments"`
	// The psp reference of the dispute
	DisputePspReference string `json:"disputePspReference"`
	// The merchant account identifier
	MerchantAccountCode string `json:"merchantAccountCode"`
}

SupplyDefenseDocumentRequest struct for SupplyDefenseDocumentRequest

type SupplyDefenseDocumentResponse

type SupplyDefenseDocumentResponse struct {
	DisputeServiceResult DisputeServiceResult `json:"disputeServiceResult"`
}

SupplyDefenseDocumentResponse struct for SupplyDefenseDocumentResponse