Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Worldline

Worldline Dispute API

Dispute Api Controller

Documentation Provider Profile APIs.io OpenAPI GitHub

Worldline Dispute API is one of 79 APIs that Worldline publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Dispute. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 13 operations across 13 paths, and defines 42 schemas. It is described by OpenAPI 2.0, at version 2.41.1.

Requests are made against the base URL https://api.connect.worldline-solutions.com.

13 operations 13 paths 42 schemas 3 GET10 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2.41.1
Base URL
https://api.connect.worldline-solutions.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Worldline Dispute API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (basic) using the application flow.

Paths & Operations 13

Across 13 paths, the API surfaces 13 operations — 3 GET, 10 POST. Each is listed below with its method, path, parameters, and response codes.

Dispute 13

Dispute Api Controller

POST
/issuers/{issuerId}/operations/{externalOperationReference}/disputesdeprecated
Create Dispute
createDispute 7 params → 400401403404500502200
GET
/issuers/{issuerId}/disputes/{disputeFolderReference}
Get the dispute information of the folder
getDisputeFolderInformation 7 params → 400401403404500502200
GET
/issuers/{issuerId}/operations/{externalOperationReference}/disputedeprecated
Get the dispute information of the operation identified by external operation reference
getDisputeFolderInfoByExternalOperationReference 7 params → 400401403404500502200
GET
/issuers/{issuerId}/disputes/external-disputes/{issuerDisputeExternalReference}
Get the dispute information of the folder identified by external reference
getDisputeFolderInfoByIssDisputeExtRef 7 params → 400401403404500502200
POST
/issuers/{issuerId}/disputes/{disputeFolderReference}/postings
Perform a posting (Refund or WriteOff) related to the Dispute Folder
createPosting 7 params → 400401403404500502200
POST
/issuers/{issuerId}/disputes/external-disputes/{issuerDisputeExternalReference}/postings
Perform a posting related to the Dispute Folder by external reference
createPostingByIssDisputeExtRef 7 params → 400401403404500502200
POST
/issuers/{issuerId}/disputes/{disputeFolderReference}/events
Create an Event in the Dispute Folder
createEvent 7 params → 400401403404500502200
POST
/issuers/{issuerId}/disputes/external-disputes/{issuerDisputeExternalReference}/events
Create an Event in the Dispute Folder by external reference
createEventByIssDisputeExtRef 7 params → 400401403404500502200
POST
/issuers/{issuerId}/disputes/{disputeFolderReference}/documents
Add an External Document to the Dispute Folder
createDocument 7 params → 400401403404500502200
POST
/issuers/{issuerId}/disputes/external-disputes/{issuerDisputeExternalReference}/documents
Add an External Document to the Dispute Folder by external reference
createDocumentByIssDisputeExtRef 7 params → 400401403404500502200
POST
/issuers/{issuerId}/disputes/{disputeFolderReference}/generate-chargeback
Generate a ChargeBack to the scheme by dispute reference
generateChargeback 7 params → 400401403404500502200
POST
/issuers/{issuerId}/disputes/external-disputes/{issuerDisputeExternalReference}/generate-chargeback
Generate a ChargeBack to the scheme by external reference
generateChargebackByIssDisputeExtRef 7 params → 400401403404500502200
POST
/issuers/{issuerId}/super-folders
create a super folder (beta)
createSuperFolder 6 params → 400401403404500502200

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are Dispute (33 properties), CreateDisputeRequest (10 properties), DisputeMessage (8 properties), DisputePosting (7 properties). Each schema is shown below with its type and property counts.

CardIdentifier
object
Identification of the card either by Issuer card external reference or by card reference
2 properties
GenerateChargebackRequest
object
6 properties 1 required
CreatePostingResponse
object
3 properties 3 required
ForbiddenResponseMetadata
object
4 properties 4 required
NotFoundErrorApiResponse
object
1 property 1 required
BadGatewayErrorApiResponse
object
1 property 1 required
InternalServerErrorErrorApiResponse
object
1 property 1 required
InternalServerErrorResponseMetadata
object
4 properties 4 required
SuperFolderIdentifier
object
1 property
UnauthorizedErrorApiResponse
object
1 property 1 required
ApiResponseEntityCreateDisputeResponse
object
Issuer response entity
2 properties 1 required
DisputeMessage
object
8 properties
CreateDisputeRequest
object
10 properties
Links
object
2 properties 1 required
DisputeFolderIdentifier
object
2 properties 1 required
CreateSuperFolderRequest
object
2 properties 1 required
Dispute
object
33 properties
UnauthorizedResponseMetadata
object
4 properties 4 required
DisputePosting
object
7 properties
CreateSuperFolderResponse
object
2 properties 1 required
ApiResponseEntityCreateDocumentResponse
object
Issuer response entity
2 properties 1 required
ApiResponseEntityDispute
object
Issuer response entity
2 properties 1 required
NotFoundResponseMetadata
object
4 properties 4 required
ResponseMetadata
object
6 properties 4 required
Amount
object
3 properties 3 required
ForbiddenErrorApiResponse
object
1 property 1 required
DisputeDocument
object
5 properties
GenerateChargebackResponse
object
2 properties
ApiResponseCreateSuperFolderResponse
object
Create Superfolder Response entity
2 properties 1 required
DisputeEvent
object
4 properties
ApiResponseEntityGenerateChargebackResponse
object
Issuer response entity
2 properties 1 required
CreateEventRequest
object
2 properties 1 required
BadRequestResponseMetadata
object
4 properties 4 required
CreateDocumentRequest
object
5 properties 3 required
CreateDocumentResponse
object
3 properties 2 required
CreateDisputeResponse
object
5 properties 1 required
BadGatewayResponseMetadata
object
4 properties 4 required
ApiResponseEntityCreateEventResponse
object
Issuer response entity
2 properties 1 required
ApiResponseEntityCreatePostingResponse
object
Issuer response entity
2 properties 1 required
BadRequestErrorApiResponse
object
1 property 1 required
CreatePostingRequest
object
4 properties 2 required
CreateEventResponse
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wordline-dispute-api-openapi.yml Raw ↑

Other APIs Worldline publishes across the network.

Worldline Connect (Global Collect) API
AE Profile APIs.io
Worldline Direct (Global Online Pay) API
AE Profile APIs.io
Worldline Acquiring API
AE Profile APIs.io
Worldline Financial Services Issuing API
AE Profile APIs.io
Worldline Financial Services Acquiring API
AE Profile APIs.io
Worldline Open Banking API
AE Profile APIs.io
Worldline SmartPOS API
AE Profile APIs.io
Worldline Identity and Authentication API
AE Profile APIs.io
Worldline Account - AccountState API
AE Profile APIs.io
Worldline Account API
AE Profile APIs.io
Worldline Account - Authorization API
AE Profile APIs.io
Worldline Account - Authorization Restriction API
AE Profile APIs.io
#Dispute
← Back to W APIs
API Details
ID
wordline:wordline-dispute-api
Base URL
https://api.connect.worldline-solutions.com
Docs
https://docs.connect.worldline-solutions.com/
Provider
Worldline
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network