Worldline Periodic Payment Initiation Service (Extended service) API
The Periodic Payment Initiation Service (Extended service) API from Worldline — 10 operation(s) for periodic payment initiation service (extended service).
Worldline Periodic 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 Periodic 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 60 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.
10 operations
10 paths
60 schemas
1 DELETE1 GET6 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Worldline Periodic Payment Initiation Service (Extended service) API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (basic) using the application flow.
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.
Periodic Payment Initiation Service (Extended service) 10
POST
/periodic-payments
Payment initiation request
GET
/periodic-payments/{paymentId}/status
Status of the payment request
POST
/periodic-payments/{paymentId}/confirmation
Confirmation of the payment request by the PISP
POST
/periodic-payments/{paymentId}/identification
Payment identification request
POST
/periodic-payments/{paymentId}/authorisations
Payment authorisation request
PUT
/periodic-payments/{paymentId}/authorisations/{authorisationId}
Payment authorisation request
DELETE
/periodic-payments/{paymentId}
Payment cancellation request
POST
/periodic-payments/{paymentId}/cancellation-identification
Payment cancellation identification request
POST
/periodic-payments/{paymentId}/cancellation-authorisations
Payment cancellation authorisation request
PUT
/periodic-payments/{paymentId}/cancellation-authorisations/{authorisationId}
Payment cancellation authorisation request update
Schemas 60
The contract defines 60 schemas that model the data the API accepts and returns. The most detailed are PeriodicPaymentInitiationRequestBasic (18 properties), CommonPaymentDataResponse (13 properties), InitiationResponseLinks (11 properties), AddressData (10 properties). Each schema is shown below with its type and property counts.
PaymentProductEnum
string
Indicates the requested payment method.
CommonPaymentDataIdentificationResponse
object
4 properties
2 required
EstimatedTotalAmount
object
Estimated Total Amount.
2 properties
2 required
AddressData
object
10 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
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
ProductSpecificMasterData
object
2 properties
2 required
CommonPaymentDataResponse
object
13 properties
2 required
AuthorisationRequiredData
object
The data required for PSU authentication and transaction authorisation
4 properties
CreditorAccount
object
4 properties
BillingAddress
object
2 properties
DebtorContactDetailsResponse
object
4 properties
PaymentIdentificationResponse
object
PaymentIdentificationresponse
2 properties
ExchangeRateInformationResponse
object
Provides details on the currency exchange rate and contract.
5 properties
ScaChallengeData
object
JSON DTO used to represent challenge data.
6 properties
CredentialLabel
object
2 properties
2 required
PaymentStatusEnum
string
Payment status. 'TimeoutAtTpp': This status can only occur in combination with the Bank Selection Interface (UseAuthorisationLandingPages = true). It's set if…
ConfirmationRequest
object
1 property
CrossCurrencyPayment
object
2 properties
1 required
CurrencyConversionFee
object
Currency Conversion Fee
3 properties
3 required
RiskInformation
object
Information used for risk scoring by the ASPSP.
8 properties
PeriodRules
object
5 properties
2 required
EstimatedInterbankSettlementAmount
object
Estimated Interbank Settlement Amount.
2 properties
2 required
PsuData
object
8 properties
DebtorInformationResponse
object
All debtor relavant data
6 properties
CreditorInformation
object
All creditor relavant data
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…
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
ExchangeRateInformationRequest
object
Provides details on the currency exchange rate and contract.
4 properties
Amount
object
6 properties
1 required
RemittanceInformationStructured
object
3 properties
1 required
PeriodicPaymentInitiationRequestBasic
object
Basic type for Periodic Payment InitiationRequest
18 properties
2 required
Link
object
1 property
1 required
ScaMethods
object
5 properties
2 required
PaymentDetailedInformation
object
Payment Status Response
4 properties
TransactionFees
object
Information used for transporting transaction fees by the ASPSP.
3 properties
PaymentConfirmationResponse
object
PaymentConfirmationResponse
2 properties
PsuAuthCredentials
object
2 properties
2 required
PaymentCancellationResponse
object
2 properties
CredentialDetails
object
Credentials Details.
3 properties
3 required
PsuDataIdentification
object
5 properties
DebtorInformation
object
All debtor relavant data
6 properties
RegulatoryReportingCode
string
Information needed due to regulatory and statutory requirements. Economical codes to be used are provided by the National Competent Authority
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…
PeriodicPaymentInitiationRequest
object
Periodic Payment Initiation Request
5 properties
1 required
PaymentInitiationResponse
object
Payment Initiation Response
3 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
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…
PaymentAuthorisationRequest
object
2 properties
CommonPaymentDataConfirmationResponse
object
3 properties
2 required
CommonPaymentDataAuthorisationResponse
object
6 properties
2 required
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
PsuCredentials
object
PSU Credentials on the Bank system.
2 properties
1 required
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
DebtorAccount
object
4 properties
1 required
PaymentAuthorisationUpdateRequest
object
4 properties
PaymentIdentificationRequest
object
1 property
PaymentAuthorisationResponse
object
2 properties
AmountRelatedDetails
object
contains additional information about the fees and estimated amount
5 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Worldline 12
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
#Periodic Payment Initiation Service (Extended service)