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 Account API

Account Api Controller

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

This API exposes 6 JSON Schema definitions.

Tagged areas include Account. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

This API exposes 36 operations across 32 paths, and defines 136 schemas. It is described by OpenAPI 3.2.0, at version 2.41.1.

Requests are made against a single base URL, https://sbx-wlip.api1-eu2.psapigateway.preprod.giservices.io/card-issuing/api/v2.

36 operations 32 paths 136 schemas 26 GET2 PATCH6 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.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 Account API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (basic) using the clientCredentials flow.

Paths & Operations 36

Across 32 paths, the API surfaces 36 operations — 26 GET, 2 PATCH, 6 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Account 36

Account Api Controller

GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}
Retrieve account by external reference
retrieveAccountByIssuerExtRef 7 params → 400401403404500502200
PATCH
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}
Update account parameters by external reference
modifyAccountByIssuerExtRef 6 params body → 400401403404500502200
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-guarantor
Retrieve account guarantor for an account by external reference
retrieveAccountGuarantorByIssuerExtRef 7 params → 400401403404500502200
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-history
Retrieve list of historic updates of an account by external reference
listAccountHistoryByIssuerExtRef 8 params → 400401403404500502200
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-owner
Retrieve account owner for an account by external reference
retrieveAccountOwnerByIssuerExtRef 7 params → 400401403404500502200
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/balance
Retrieve financial information by external reference
retrieveAccountBalanceByIssuerExtRef 6 params → 400401403404500502200
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/contract
Retrieve contract for an account by external reference
retrieveContractForAccountByIssuerExtRef 9 params → 400401403404500502200
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/corporate-contract
Retrieve corporate contract for an account by external reference (beta)
retrieveCorporateContractForAccountByIssuerExtRef 7 params → 400401403404500502200
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/credit-limit
Retrieve account credit limit by external reference
retrieveAccountCreditLimitByIssuerExtRef 6 params → 400401403404500502200
PUT
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/credit-limit
Update account credit limit by external reference
modifyCreditLimitByIssuerExtRef 6 params body → 400401403404500502200
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/credit-transfers
List outgoing credit transfers for an account by external reference
listCreditTransfersByIssuerAccExtRef 9 params → 400401403404500502200
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/direct-debits
List direct debits for an account by external reference
listDirectDebitsByIssuerAccExtRef 9 params → 400401403404500502200
POST
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/cancel-delinquency
Cancel account delinquency by external reference
cancelAccountDelinquencyByExtRef 6 params body → 200400401403404500502
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/turnover-informationdeprecated
Retrieve turnover information for an account by external reference (beta)
retrieveTurnoverInformationByExtRef 6 params → 400401403404500502200
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/turnovers
Retrieve list of turnover for an account by external reference
listTurnoverByExtRef 7 params → 400401403404500502200
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/temporary-credit-limits
List temporary credit limits for an account by external reference
listTemporaryCreditLimitForAccountByIssuerExtRef 7 params → 400401403404500502200
POST
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/create-mandate
Create mandate by external reference
createMandateByIssuerExtRef 6 params body → 200400401403404500502
POST
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/cancel-mandate
Cancel mandate by external reference
cancelMandateByIssuerExtRef 6 params body → 200400401403404500502
GET
/issuers/{issuerId}/accounts/{accountReference}
Retrieve account
retrieveAccount 7 params → 400401403404500502200
PATCH
/issuers/{issuerId}/accounts/{accountReference}
Update account parameters
modifyAccount 6 params body → 400401403404500502200
GET
/issuers/{issuerId}/accounts/{accountReference}/account-guarantor
Retrieve account guarantor for an account
retrieveAccountGuarantor 7 params → 400401403404500502200
GET
/issuers/{issuerId}/accounts/{accountReference}/account-history
Retrieve list of historic updates of an account
listAccountHistory 8 params → 400401403404500502200
GET
/issuers/{issuerId}/accounts/{accountReference}/account-owner
Retrieve account owner for an account
retrieveAccountOwner 7 params → 400401403404500502200
POST
/issuers/{issuerId}/accounts/{accountReference}/cancel-delinquency
Cancel account delinquency
cancelAccountDelinquency 6 params body → 200400401403404500502
GET
/issuers/{issuerId}/accounts/{accountReference}/turnover-informationdeprecated
Retrieve turnover information for an account (beta)
retrieveTurnoverInformation 6 params → 400401403404500502200
GET
/issuers/{issuerId}/accounts/{accountReference}/turnovers
Retrieve list of turnover for an account
listTurnover 7 params → 400401403404500502200
GET
/issuers/{issuerId}/accounts/{accountReference}/balance
Retrieve financial information
retrieveAccountBalance 6 params → 400401403404500502200
GET
/issuers/{issuerId}/accounts/{accountReference}/contract
Retrieve contract for an account
retrieveContractForAccount 9 params → 400401403404500502200
GET
/issuers/{issuerId}/accounts/{accountReference}/corporate-contract
Retrieve corporate contract for an account (beta)
retrieveCorporateContractForAccount 7 params → 400401403404500502200
GET
/issuers/{issuerId}/accounts/{accountReference}/credit-limit
Retrieve account credit limit
retrieveAccountCreditLimit 6 params → 400401403404500502200
PUT
/issuers/{issuerId}/accounts/{accountReference}/credit-limit
Update account credit limit
modifyCreditLimit 6 params body → 400401403404500502200
GET
/issuers/{issuerId}/accounts/{accountReference}/credit-transfers
List outgoing credit transfers for an account
listCreditTransfers 9 params → 400401403404500502200
GET
/issuers/{issuerId}/accounts/{accountReference}/direct-debits
List direct debits for an account
listDirectDebits 9 params → 400401403404500502200
GET
/issuers/{issuerId}/accounts/{accountReference}/temporary-credit-limits
List temporary credit limits for an account
listTemporaryCreditLimitForAccount 7 params → 400401403404500502200
POST
/issuers/{issuerId}/accounts/{accountReference}/create-mandate
Create mandate
createMandate 6 params body → 200400401403404500502
POST
/issuers/{issuerId}/accounts/{accountReference}/cancel-mandate
Cancel mandate
cancelMandate 6 params body → 200400401403404500502

Schemas 136

The contract defines 136 schemas that model the data the API accepts and returns. The most detailed are Account (103 properties), CardContract (58 properties), Card (53 properties), ContractMember (44 properties). Each schema is shown below with its type and property counts.

CorporateContractFee
object
Specify the corporate contract Fee
CreditTransfer
object
21 properties
ApiResponseEntityTurnoverInformation
object
Issuer response entity
2 properties 1 required
CreditTransferIdentifier
object
1 property
FeePostingEntityIdentifier
object
3 properties
ModifyAccountHierarchyOperationStatus
object
The issuer can update blocking information for the account hierarchy.
5 properties
CreateMandateResponse
object
4 properties
CorporateContractEntity
object
Specify the corporate contract entity
8 properties
AccountStatusHistory
object
3 properties
Order
object
35 properties
InsuranceEvent
object
3 properties
ModifyAccountRequestAccountModel
object
3 properties
Links
object
2 properties 1 required
NotFoundResponseMetadata
object
4 properties 4 required
LegitimacyDocument
object
Legitimacy document information
6 properties
ContractFee
object
6 properties
Turnover
object
6 properties 2 required
ContractIdentifier
object
Identification of thecorporate contract either by Issuer contract external reference or by contract reference
2 properties
UnauthorizedResponseMetadata
object
4 properties 4 required
DirectDebit
object
21 properties
ExternalVelocityLimitIdentifier
object
1 property
AddOnServiceParameter
object
4 properties
BadRequestResponseMetadata
object
4 properties 4 required
ApiResponseEntityModifyAccountResponse
object
Issuer response entity
2 properties 1 required
DirectDebitStatusHistory
object
4 properties
BadGatewayResponseMetadata
object
4 properties 4 required
AccountIdentifier
object
2 properties
ContractModel
object
Model containing predefined configuration for fee generation applicable on a contract
2 properties
AdvertisementFlags
object
Specify possible channels used to provide advertisements
6 properties
AuthorizationDataValidation
object
The issuer can update cardholder data used by the Front Office for verification (AVS/ANI).
6 properties
PinInheritanceExternalCardIdentifier
object
1 property
ApiResponseEntityListDirectDebit
object
Issuer response entity
2 properties 1 required
AccountHierarchyModel
object
2 properties
ApiResponseEntityCancelAccountDelinquencyResponse
object
Issuer response entity
2 properties 1 required
AccountModel
object
3 properties
Contract
object
Consumer contract entity
39 properties
CancelMandateResponse
object
4 properties
ContractMember
object
44 properties
ContactCenter
object
6 properties
BadRequestErrorApiResponse
object
1 property 1 required
ForbiddenErrorApiResponse
object
1 property 1 required
TurnoverInformation
object
5 properties 2 required
BadGatewayErrorApiResponse
object
1 property 1 required
ExternalRestrictionIdentifier
object
1 property
PhoneNumber
object
3 properties 1 required
ApiResponseEntityCancelMandateResponse
object
2 properties 1 required
CustomerIdentifier
object
Identification of the updated customer either by Issuer customer external reference or by customer reference
2 properties
TemporaryCreditLimit
object
4 properties
AccountRelation
object
2 properties 2 required
ApiResponseEntityCreateMandateResponse
object
2 properties 1 required
ModifyCreditLimitResponse
object
1 property 1 required
FeeCondition
object
3 properties
ModifyAccountOutgoingCreditTransferFeature
object
The issuer can override each different Outgoing Credit Transfer (OCT) options if is allowed within the reimbursement model.
9 properties
OrderStatusHistory
object
3 properties
ModifyAccountResponse
object
1 property
PreviousPeriodTurnover
object
4 properties 3 required
InsuranceContract
object
10 properties
Company
object
21 properties
MultiCardInfo
object
3 properties
CancelAccountDelinquencyRequest
object
1 property
InsuranceContractPackage
object
2 properties
MultiCard
object
6 properties
AccountHistory
object
28 properties 3 required
HierarchyOutgoingCreditTransferFeature
object
Specify OctFeature (periodicOct, periodicOctType, periodicOctMaxThreshold, etc.)
9 properties
SepaMandateMailAddress
object
13 properties
AddressVersionIdentifier
object
1 property
ForbiddenResponseMetadata
object
4 properties 4 required
ActiveCreditLimit
object
3 properties
EmailAddress
object
1 property 1 required
AddressUsage
object
3 properties 2 required
CycleInformation
object
Dates related to the closure calendar for the open closure cycle
10 properties
HierarchyOperationStatus
object
4 properties
CancelMandateRequest
object
4 properties 1 required
ApiResponseEntityCorporateContract
object
Issuer response entity
2 properties 1 required
InternalServerErrorResponseMetadata
object
4 properties 4 required
CardChange
object
2 properties
EncryptedPan
object
2 properties
ModifyAccountRequest
object
34 properties
ApiResponseEntityModifyCreditLimitResponse
object
Issuer response entity
2 properties 1 required
ProductChangeInformation
object
Only if a product change is triggered by card replacement. Represents product change information
11 properties
MailAddress
object
15 properties 1 required
CardContract
object
58 properties
UnauthorizedErrorApiResponse
object
1 property 1 required
ContactIdentifier
object
1 property
CreditLimit
object
2 properties
AddressIdentifier
object
2 properties
ApiResponseEntityCreditLimit
object
Issuer response entity
2 properties 1 required
CorporateContractLevel
object
Specify the level in the company organization
2 properties
ProductExtensionIdentifier
object
1 property
ApiResponseEntityListCreditTransfer
object
Issuer response entity
2 properties 1 required
ProductIdentifier
object
2 properties
CardStatusHistory
object
6 properties
PinInheritanceCardIdentifier
object
2 properties
TemporaryCreditLimitIdentifier
object
1 property
LoyaltyPoint
object
2 properties
CardBlockingInformation
object
25 properties 1 required
ExternalRestriction
object
5 properties 1 required
InternalServerErrorErrorApiResponse
object
1 property 1 required
ModifyCreditLimitRequest
object
1 property 1 required
ApiResponseEntityListTemporaryCreditLimit
object
Issuer response entity
2 properties 1 required
CardContractIdentifier
object
Identification of the card contract either by Issuer card contract external reference or by card contract reference
2 properties
ContactCenterIdentifier
object
1 property
CreditTransferStatusHistory
object
4 properties
ApiResponseEntityContractMember
object
Issuer response entity
2 properties 1 required
Card
object
53 properties 1 required
CorporateEmployeeAccount
object
Specify the corporate employee account
17 properties
ApiResponseEntityTurnover
object
Issuer response entity
2 properties 1 required
CorporateContract
object
31 properties
CreateMandateRequest
object
20 properties
ApiResponseEntityListAccountHistory
object
Issuer response entity
2 properties 1 required
Account
object
103 properties 12 required
AccountOutgoingCreditTransferFeature
object
Specify OctFeature (periodicOct, periodicOctType, periodicOctMaxThreshold, etc.)
9 properties
DirectDebitIdentifier
object
1 property
Vulnerability
object
2 properties 1 required
AddOnSubscription
object
6 properties
ApiResponseEntityContract
object
Issuer response entity
2 properties 1 required
Address
object
15 properties 2 required
NotFoundErrorApiResponse
object
1 property 1 required
CancelAccountDelinquencyResponse
object
2 properties 2 required
Amount
object
3 properties 3 required
CardIdentifier
object
Identification of the card either by Issuer card external reference or by card reference
2 properties
DataAnalysisFlags
object
Specify which data analysis flags are enabled (person, paymentTransaction, exchangeThirdParties, etc.)
3 properties
ModifyHierarchyOutgoingCreditTransferFeature
object
Specify OctFeature (periodicOct, periodicOctType, periodicOctMaxThreshold, etc.)
9 properties
InsurancePackageIdentifier
object
Unique identifier of the insurance contract package
1 property
HierarchyOperationStatusHistory
object
6 properties
AccountBalance
object
14 properties
InsuranceContractIdentifier
object
The insurance package which is linked to this contract
1 property
DeliveryChannel
object
Specify the channel for letter delivery used for this contract
3 properties
ResponseMetadata
object
6 properties 4 required
Contact
object
11 properties
ApiResponseEntityAccount
object
Issuer response entity
2 properties 1 required
Customer
object
43 properties 2 required
ExternalVelocityLimit
object
7 properties 1 required
ApiResponseEntityAccountBalance
object
Issuer response entity
2 properties 1 required
OrderIdentifier
object
Order reference calculated by our system
1 property
CardContractModel
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wordline-account-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 - Authorization API
Worldline Account - Authorization Restriction API
Worldline Account - Cvv2 Try Counter API
Where this information came from

This is an independent, third-party profile of Worldline Account 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.