Worldline Refund Initiation Service V3 (Extended services) API is one of 79 APIs that Worldline publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Refund Initiation Service V3 (Extended services). The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
6 operations
across 6 paths,
and defines 50 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.
6 operations6 paths50 schemas1 GET4 POST1 PUT
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 Refund Initiation Service V3 (Extended services) API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (basic) using the application flow.
Paths & Operations 6
Across 6 paths, the API surfaces 6 operations — 1 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Refund Initiation Service V3 (Extended services) 6
The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are AddressData (10 properties), RefundAuthorisationApproachLinks (9 properties), StatusResponseLinks (8 properties), CommonPaymentDataRefundResponse (8 properties). Each schema is shown below with its type and property counts.
Refund
object
8 properties2 required
Link
object
1 property1 required
ExchangeRateInformationResponse
object
Provides details on the currency exchange rate and contract.
5 properties
BillingAddress
object
2 properties
RefundAuthorisationResponseLinks
object
A list of hyperlinks to be recognized by the Initiating Party. The actual hyperlinks used in the response depend on the dynamical decisions on authorization ap…
6 properties
StatusResponseLinks
object
A list of hyperlinks to be recognized by the Initiating Party. The actual hyperlinks used in the response depend on the dynamical decisions on authorization ap…
8 properties
ScaChallengeData
object
JSON DTO used to represent challenge data.
6 properties
PaymentAuthorisationRequest
object
2 properties
CommonPaymentDataRefundDetailsResponse
object
Basic type for Payment Initiation Response
7 properties2 required
RefundAuthorisationApproachLinks
object
A list of hyperlinks to be recognized by the Initiating Party. The actual hyperlinks used in the response depend on the dynamical decisions on authorization ap…
9 properties
CommonPaymentDataRefundAuthorisationResponse
object
6 properties2 required
CredentialLabel
object
2 properties2 required
RefundConfirmationResponse
object
2 properties
RefundStatusResponse
object
2 properties1 required
ScaMethods
object
5 properties2 required
PaymentStatusEnum
string
Payment status. 'TimeoutAtTpp': This status can only occur in combination with the Bank Selection Interface (UseAuthorisationLandingPages = true). It's set if…
CommonPaymentDataRefund
object
5 properties2 required
ConfirmationRequest
object
1 property
CommonPaymentDataRefundResponse
object
Basic type for Payment Initiation Response
8 properties2 required
AccountError
object
2 properties2 required
EstimatedTotalAmount
object
Estimated Total Amount.
2 properties2 required
RefundAuthorisationResponse
object
2 properties
AddressData
object
10 properties
RefundAmount
object
2 properties1 required
PsuCredentials
object
PSU Credentials on the Bank system.
2 properties1 required
CommonPaymentDataRefundIdentificationResponse
object
4 properties2 required
CommonPaymentDataRefundConfirmationResponse
object
3 properties2 required
IdentificationTypeEnum
string
Type of the account number.
RefundLinks
object
A list of hyperlinks to be recognized by the Initiating Party. The actual hyperlinks used in the response depend on the dynamical decisions on authorization ap…
1 property
CurrencyConversionFee
object
Currency Conversion Fee
3 properties3 required
RefundInitiationRequest
object
Refund Initiation Request
1 property2 required
CreditorDateAndPlaceOfBirth
object
Date and place of birth of a person. This information must be requested for detection of Fraud, Money-Laundering and Terrorism Financing in case of internation…
3 properties3 required
DebtorInformation
object
All debtor relavant data
6 properties
TransactionFees
object
Information used for transporting transaction fees by the ASPSP.
3 properties
DebtorAccount
object
4 properties1 required
AuthorisationRequiredData
object
The data required for PSU authentication and transaction authorisation
4 properties
CreditorAccount
object
4 properties
PaymentAuthorisationUpdateRequest
object
4 properties
EstimatedInterbankSettlementAmount
object
Estimated Interbank Settlement Amount.
2 properties2 required
PaymentIdentificationRequest
object
1 property
PsuAuthCredentials
object
2 properties2 required
CredentialDetails
object
Credentials Details.
3 properties3 required
RefundIdentificationResponse
object
Payment Identification response
2 properties
PsuDataIdentification
object
5 properties
RefundInitiationResponse
object
2 properties1 required
CreditorInformation
object
All creditor relavant data
8 properties
PsuData
object
8 properties
AuthStatusEnum
string
This data element is containing information about the status of the SCA method applied. The following codes are defined for this data type. 'Received': An auth…
OverRefund
object
3 properties2 required
AmountRelatedDetails
object
contains additional information about the fees and estimated amount
5 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
