How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Worldline Scheduled Payment Initiation Service (Extended service) API

The Scheduled Payment Initiation Service (Extended service) API from Worldline — 10 operation(s) for scheduled payment initiation service (extended service).

Worldline Scheduled Payment Initiation Service (Extended service) API is one of 79 APIs that Worldline publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Scheduled Payment Initiation Service (Extended service). The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 10 operations across 10 paths, and defines 59 schemas. It is described by OpenAPI 3.2.0, at version 3.15.0.

Requests are made against 2 base URLs: https://xs2a.awltest.de/xs2a/routingservice/services/ob/pis/v3, https://digitalroutingservice.awltest.de/xs2a/routingservice/services/ob/pis/v3.

10 operations 10 paths 59 schemas 1 DELETE1 GET6 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.15.0
Base URL
https://api.connect.worldline-solutions.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Worldline Scheduled Payment Initiation Service (Extended service) API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Authorization).

  • Authorization — The 'Authorization' field must be filled with an access token. How to get an access token To request an access token, the Initiating Party must digitally sign…

Paths & Operations 10

Across 10 paths, the API surfaces 10 operations — 1 DELETE, 1 GET, 6 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Scheduled Payment Initiation Service (Extended service) 10
POST
/scheduled-payments
Payment initiation request
scheduledPaymentInitiate 24 params body → 201400401403404415500502
GET
/scheduled-payments/{paymentId}/status
Status of the payment request
scheduledPaymentStatus 7 params → 200400401403404415500502
POST
/scheduled-payments/{paymentId}/confirmation
Confirmation of the payment request by the PISP
scheduledPaymentConfirmation 3 params body → 200400401403404415500502
POST
/scheduled-payments/{paymentId}/identification
Payment identification request
scheduledPaymentIdentification 3 params body → 200400401403404415500502
POST
/scheduled-payments/{paymentId}/authorisations
Payment authorisation request
scheduledPaymentAuthorisation 3 params body → 201400401403404415500502
PUT
/scheduled-payments/{paymentId}/authorisations/{authorisationId}
Payment authorisation request
scheduledPaymentAuthorisationUpdate 4 params body → 200400401403404415500502
DELETE
/scheduled-payments/{paymentId}
Payment cancellation request
scheduledPaymentCancellation 11 params → 200204405400401403404415
POST
/scheduled-payments/{paymentId}/cancellation-identification
Payment cancellation identification request
scheduledPaymentCancellationIdentification 3 params body → 200400401403404415500502
POST
/scheduled-payments/{paymentId}/cancellation-authorisations
Payment cancellation authorisation request
scheduledPaymentCancellationAuthorisation 3 params body → 201400401403404415500502
PUT
/scheduled-payments/{paymentId}/cancellation-authorisations/{authorisationId}
Payment cancellation authorisation request update
scheduledPaymentCancellationAuthorisationUpdate 4 params body → 200400401403404415500502

Schemas 59

The contract defines 59 schemas that model the data the API accepts and returns. The most detailed are ScheduledPaymentInitiationRequestBasic (18 properties), CommonPaymentDataResponse (13 properties), InitiationResponseLinks (11 properties), AddressData (10 properties). Each schema is shown below with its type and property counts.

PaymentAuthorisationResponse
object
2 properties
ExchangeRateInformationResponse
object
Provides details on the currency exchange rate and contract.
5 properties
Links
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
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…
IdentificationTypeEnum
string
Type of the account number.
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 properties 3 required
PaymentCancellationResponse
object
2 properties
DebtorAccount
object
4 properties 1 required
PaymentDetailedInformation
object
Payment Status Response
4 properties
InitiationResponseLinks
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…
11 properties
PaymentConfirmationResponse
object
PaymentConfirmationResponse
2 properties
CurrencyConversionFee
object
Currency Conversion Fee
3 properties 3 required
ConfirmationRequest
object
1 property
ScheduledPaymentInitiationRequestBasic
object
Basic type for Scheduled Payment InitiationRequest
18 properties 2 required
CommonPaymentDataResponse
object
13 properties 2 required
CredentialDetails
object
Credentials Details.
3 properties 3 required
AuthorisationRequiredData
object
The data required for PSU authentication and transaction authorisation
4 properties
CommonPaymentDataConfirmationResponse
object
3 properties 2 required
Link
object
1 property 1 required
PaymentIdentificationResponse
object
PaymentIdentificationresponse
2 properties
DebtorInformationResponse
object
All debtor relavant data
6 properties
AmountBreakdown
object
Breakdown of the transaction amount. The sum of all the fields within this breakdown must be equal to the transaction amount. Possible to use for iDEAL payment…
2 properties 2 required
BillingAddress
object
2 properties
PaymentAuthorisationUpdateRequest
object
4 properties
PaymentInitiationResponse
object
Payment Initiation Response
3 properties
EstimatedInterbankSettlementAmount
object
Estimated Interbank Settlement Amount.
2 properties 2 required
TransactionFees
object
Information used for transporting transaction fees by the ASPSP.
3 properties
PsuDataIdentification
object
5 properties
CommonPaymentDataAuthorisationResponse
object
6 properties 2 required
CategoryPurposeEnum
string
Specifies the high level purpose of the instruction based on a set of pre-defined categories. This is used by the initiating party to provide information conce…
RegulatoryReportingCode
string
Information needed due to regulatory and statutory requirements. Economical codes to be used are provided by the National Competent Authority
PsuData
object
8 properties
PaymentProductEnum
string
Indicates the requested payment method.
CreditorAccount
object
4 properties
PsuAuthCredentials
object
2 properties 2 required
DebtorInformation
object
All debtor relavant data
6 properties
CredentialLabel
object
2 properties 2 required
ScaChallengeData
object
JSON DTO used to represent challenge data.
6 properties
CreditorInformation
object
All creditor relavant data
8 properties
AuthorisationResponseLinks
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
ScaMethods
object
5 properties 2 required
CrossCurrencyPayment
object
2 properties 1 required
DebtorContactDetailsResponse
object
4 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
LevelOfGuaranteeEnum
string
Level of payment guarantee for Payment Status. The level of guarantee for banks in countries where SCT Instant is either absent or entails a higher cost, as we…
PsuCredentials
object
PSU Credentials on the Bank system.
2 properties 1 required
EstimatedTotalAmount
object
Estimated Total Amount.
2 properties 2 required
RemittanceInformationStructured
object
3 properties 1 required
ScheduledPaymentInitiationRequest
object
ScheduledPaymentInitiationRequest
5 properties 1 required
PaymentIdentificationRequest
object
1 property
AmountRelatedDetails
object
contains additional information about the fees and estimated amount
5 properties
AddressData
object
10 properties
PaymentStatusEnum
string
Payment status. 'TimeoutAtTpp': This status can only occur in combination with the Bank Selection Interface (UseAuthorisationLandingPages = true). It's set if…
PaymentAuthorisationRequest
object
2 properties
Amount
object
6 properties 1 required
RiskInformation
object
Information used for risk scoring by the ASPSP.
8 properties
ProductSpecificMasterData
object
2 properties 2 required
CommonPaymentDataIdentificationResponse
object
4 properties 2 required
ExchangeRateInformationRequest
object
Provides details on the currency exchange rate and contract.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wordline-scheduled-payment-initiation-service-extended-service-api-openapi.yml Raw ↑

Other APIs Worldline publishes across the network.

Worldline Connect (Global Collect) API
Worldline Direct (Global Online Pay) API
Worldline Acquiring API
Worldline Financial Services Issuing API
Worldline Financial Services Acquiring API
Worldline Open Banking API
Worldline SmartPOS API
Worldline Identity and Authentication API
Worldline Account - AccountState API
Worldline Account API
Worldline Account - Authorization API
Worldline Account - Authorization Restriction API
Where this information came from

This is an independent, third-party profile of Worldline Scheduled Payment Initiation Service (Extended service) API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.