Worldline Mobile Payment Operations API
Apple Pay Controller
Worldline Mobile Payment Operations API is one of 79 APIs that Worldline publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Mobile Payment Operations. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 16 operations across 16 paths, and defines 53 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.
16 operations
16 paths
53 schemas
4 GET12 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Worldline Mobile Payment Operations API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (basic) using the application flow.
Paths & Operations 16
Across 16 paths, the API surfaces 16 operations — 4 GET, 12 POST. Each is listed below with its method, path, parameters, and response codes.
Mobile Payment Operations 16
Apple Pay Controller
POST
/issuers/{issuerId}/cards/{cardReference}/create-apple-tokenized-card
Token Provisioning: Apple push provisioning
POST
/issuers/{issuerId}/cards/{cardReference}/create-vts-tokenized-card
Token Provisioning: Google or Samsung push provisioning (Visa variant)
POST
/issuers/{issuerId}/cards/{cardReference}/create-mdes-tokenized-card
Token Provisioning: Google or Samsung push provisioning (Mastercard variant)
POST
/issuers/{issuerId}/tokens/{tokenReference}/generate-crypto-otp
Token Provisioning: Get-Crypto-OTP by Token
POST
/issuers/{issuerId}/cards/{cardReference}/generate-crypto-otp
Token Provisioning: Get-Crypto-OTP by card reference
GET
/issuers/{issuerId}/cards/{cardReference}/token-list
Selfcare : Get Token list from a Card Reference
GET
/issuers/{issuerId}/tokens/{tokenReference}/tokenRequestors/{tokenRequestorId}/details
Selfcare : Get token details
POST
/issuers/{issuerId}/tokens/{tokenReference}/update
Selfcare : Update a token status
GET
/issuers/{issuerId}/tokens/{tokenReference}/card-reference
Selfcare : Get Card Reference From Token
POST
/issuers/{issuerId}/cards/{cardReference}/click-to-pay-enroll
Click-To-Pay: Enroll a card
POST
/issuers/{issuerId}/cards/{cardReference}/click-to-pay-remove
Click-To-Pay: Remove a card or complete account
GET
/issuers/{issuerId}/cards/{cardReference}/click-to-pay-account-data
Click-To-Pay: Return all data provisioned for a given card
POST
/issuers/{issuerId}/cardholders/{cardholderReference}/update
Update click-to-pay cardholder data
POST
/issuers/{issuerId}/vts-apple-push-datadeprecated
Issuer service aimed to generate data specific elements for push provisioning with ApplePay (MBPAD, MBPAC)
POST
/issuers/{issuerId}/vts-mobile-banking-auth-codedeprecated
Issuer service aimed to generate data specific elements for app to app provisioning (MBAAC)
POST
/issuers/{issuerId}/vts-payment-instrument-detailsdeprecated
Issuer service aimed to generate data specific elements for push provisioning for VTS
Schemas 53
The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are AddTokenData (14 properties), VtsPaymentInstrumentsDetailsRequest (12 properties), ConsumerInformation (9 properties), DetailsDataResponse (9 properties). Each schema is shown below with its type and property counts.
AddBaseRequest
object
1 property
1 required
CreateVtsTokenizedCardV2Response
object
1 property
AddTokenData
object
Structure used for filling information related to the found tokens. Present if minimum one token found
14 properties
3 required
GetCardIdFromTokenV2Response
object
5 properties
EncryptedPayload
object
EncryptedPayload object containing a FundingAccountData object
5 properties
3 required
VtsPushProvisioningResponse
object
1 property
NotFoundErrorApiResponse
object
1 property
1 required
BadGatewayErrorApiResponse
object
1 property
1 required
VtsMobileBankingAuthCode
object
2 properties
InternalServerErrorErrorApiResponse
object
1 property
1 required
InternalServerErrorResponseMetadata
object
4 properties
4 required
VtsPaymentInstrumentsDetailsRequest
object
12 properties
UnauthorizedErrorApiResponse
object
1 property
1 required
ResponseV2CreateVtsTokenizedCardV2Response
object
2 properties
1 required
TokenSelfcareUpdateRequest
object
2 properties
2 required
VtsCommonPushProvisioningRequest
object
5 properties
5 required
MobileBankingAppAuthCodeResponse
object
1 property
Links
object
2 properties
1 required
ResponseV2DetailsDataResponse
object
2 properties
1 required
FundingAccountInfo
object
Json structure containing encrypted payload
3 properties
1 required
CreateMdesTokenizedCardV2Request
object
1 property
1 required
CardDetails
object
List of cardDetail structures that contains information on cards associated to a click-to-Pay account. Returned if min one present. See below for subfields
8 properties
5 required
CreateAppleTokenizedCardV2Request
object
6 properties
4 required
GetTokenDataV2Response
object
4 properties
MdesIssuerDigitizationDataResponse
object
The data that must be returned to the mobile application and transmitted to wallet provider
2 properties
1 required
ConsumerInformation
object
Structure used for information related to click-to-pay account
9 properties
5 required
VtsApplePushDataRequest
object
4 properties
BillingAddress
object
7 properties
4 required
ApiResponseEntityVtsPushProvisioningResponse
object
Issuer response entity
2 properties
1 required
UnauthorizedResponseMetadata
object
4 properties
4 required
ApplePayPushProvisioningResponse
object
2 properties
GetCryptoOTPV2Response
object
1 property
ApiResponseEntityMobileBankingAppAuthCodeResponse
object
Issuer response entity
2 properties
1 required
NotFoundResponseMetadata
object
4 properties
4 required
ResponseMetadata
object
6 properties
4 required
ResponseV2ClickToPayRetrieveAccountDataResponse
object
2 properties
1 required
ClickToPayRetrieveAccountDataResponse
object
4 properties
ResponseV2
object
2 properties
1 required
CreateAppleTokenizedCardV2Response
object
3 properties
ForbiddenErrorApiResponse
object
1 property
1 required
ResponseV2CreateMdesTokenizedCardV2Response
object
2 properties
1 required
ResponseV2GetCardIdFromTokenV2Response
object
2 properties
1 required
ResponseV2GetTokenDataV2Response
object
2 properties
1 required
DetailsDataResponse
object
9 properties
ClickToPayEnrollUpdateRequest
object
2 properties
BadRequestResponseMetadata
object
4 properties
4 required
ResponseV2GetCryptoOTPV2Response
object
2 properties
1 required
ResponseV2CreateAppleTokenizedCardV2Response
object
2 properties
1 required
BadGatewayResponseMetadata
object
4 properties
4 required
ApiResponseApplePayPushProvisioning
object
Issuer response entity
2 properties
1 required
BadRequestErrorApiResponse
object
1 property
1 required
CreateMdesTokenizedCardV2Response
object
1 property
ForbiddenResponseMetadata
object
4 properties
4 required
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
#Mobile Payment Operations