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.
Tagged areas include Account. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 36 operations across 32 paths, and defines 136 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.
36 operations
32 paths
136 schemas
26 GET2 PATCH6 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Worldline Account API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (basic) using the application 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
PATCH
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}
Update account parameters by external reference
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-guarantor
Retrieve account guarantor for an account by external reference
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-history
Retrieve list of historic updates of an account by external reference
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-owner
Retrieve account owner for an account by external reference
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/balance
Retrieve financial information by external reference
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/contract
Retrieve contract for an account by external reference
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/corporate-contract
Retrieve corporate contract for an account by external reference (beta)
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/credit-limit
Retrieve account credit limit by external reference
PUT
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/credit-limit
Update account credit limit by external reference
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/credit-transfers
List outgoing credit transfers for an account by external reference
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/direct-debits
List direct debits for an account by external reference
POST
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/cancel-delinquency
Cancel account delinquency by external reference
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/turnover-informationdeprecated
Retrieve turnover information for an account by external reference (beta)
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/turnovers
Retrieve list of turnover for an account by external reference
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/temporary-credit-limits
List temporary credit limits for an account by external reference
POST
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/create-mandate
Create mandate by external reference
POST
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/cancel-mandate
Cancel mandate by external reference
GET
/issuers/{issuerId}/accounts/{accountReference}
Retrieve account
PATCH
/issuers/{issuerId}/accounts/{accountReference}
Update account parameters
GET
/issuers/{issuerId}/accounts/{accountReference}/account-guarantor
Retrieve account guarantor for an account
GET
/issuers/{issuerId}/accounts/{accountReference}/account-history
Retrieve list of historic updates of an account
GET
/issuers/{issuerId}/accounts/{accountReference}/account-owner
Retrieve account owner for an account
POST
/issuers/{issuerId}/accounts/{accountReference}/cancel-delinquency
Cancel account delinquency
GET
/issuers/{issuerId}/accounts/{accountReference}/turnover-informationdeprecated
Retrieve turnover information for an account (beta)
GET
/issuers/{issuerId}/accounts/{accountReference}/turnovers
Retrieve list of turnover for an account
GET
/issuers/{issuerId}/accounts/{accountReference}/balance
Retrieve financial information
GET
/issuers/{issuerId}/accounts/{accountReference}/contract
Retrieve contract for an account
GET
/issuers/{issuerId}/accounts/{accountReference}/corporate-contract
Retrieve corporate contract for an account (beta)
GET
/issuers/{issuerId}/accounts/{accountReference}/credit-limit
Retrieve account credit limit
PUT
/issuers/{issuerId}/accounts/{accountReference}/credit-limit
Update account credit limit
GET
/issuers/{issuerId}/accounts/{accountReference}/credit-transfers
List outgoing credit transfers for an account
GET
/issuers/{issuerId}/accounts/{accountReference}/direct-debits
List direct debits for an account
GET
/issuers/{issuerId}/accounts/{accountReference}/temporary-credit-limits
List temporary credit limits for an account
POST
/issuers/{issuerId}/accounts/{accountReference}/create-mandate
Create mandate
POST
/issuers/{issuerId}/accounts/{accountReference}/cancel-mandate
Cancel mandate
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.
CustomerIdentifier
object
Identification of the updated customer either by Issuer customer external reference or by customer reference
2 properties
CardIdentifier
object
Identification of the card either by Issuer card external reference or by card reference
2 properties
CancelMandateRequest
object
4 properties
1 required
CorporateContractFee
object
Specify the corporate contract Fee
ContractMember
object
44 properties
ModifyAccountRequestAccountModel
object
3 properties
CreditLimit
object
2 properties
CancelAccountDelinquencyResponse
object
2 properties
2 required
AccountHistory
object
28 properties
3 required
ModifyCreditLimitResponse
object
1 property
1 required
Customer
object
43 properties
2 required
ProductIdentifier
object
2 properties
AccountStatusHistory
object
3 properties
InsurancePackageIdentifier
object
Unique identifier of the insurance contract package
1 property
TemporaryCreditLimit
object
4 properties
CycleInformation
object
Dates related to the closure calendar for the open closure cycle
10 properties
ContractModel
object
Model containing predefined configuration for fee generation applicable on a contract
2 properties
EncryptedPan
object
2 properties
PinInheritanceExternalCardIdentifier
object
1 property
ContactIdentifier
object
1 property
DataAnalysisFlags
object
Specify which data analysis flags are enabled (person, paymentTransaction, exchangeThirdParties, etc.)
3 properties
ApiResponseEntityListAccountHistory
object
Issuer response entity
2 properties
1 required
Order
object
35 properties
ForbiddenErrorApiResponse
object
1 property
1 required
CancelAccountDelinquencyRequest
object
1 property
Card
object
53 properties
1 required
ModifyAccountHierarchyOperationStatus
object
The issuer can update blocking information for the account hierarchy.
5 properties
FeeCondition
object
3 properties
FeePostingEntityIdentifier
object
3 properties
ApiResponseEntityListCreditTransfer
object
Issuer response entity
2 properties
1 required
DirectDebitStatusHistory
object
4 properties
MailAddress
object
15 properties
1 required
AccountOutgoingCreditTransferFeature
object
Specify OctFeature (periodicOct, periodicOctType, periodicOctMaxThreshold, etc.)
9 properties
BadGatewayErrorApiResponse
object
1 property
1 required
InternalServerErrorErrorApiResponse
object
1 property
1 required
InternalServerErrorResponseMetadata
object
4 properties
4 required
NotFoundErrorApiResponse
object
1 property
1 required
CorporateContractLevel
object
Specify the level in the company organization
2 properties
ProductExtensionIdentifier
object
1 property
CorporateEmployeeAccount
object
Specify the corporate employee account
17 properties
CreateMandateResponse
object
4 properties
AddressUsage
object
3 properties
2 required
ActiveCreditLimit
object
3 properties
MultiCardInfo
object
3 properties
AccountModel
object
3 properties
Turnover
object
6 properties
2 required
AccountHierarchyModel
object
2 properties
ExternalRestriction
object
5 properties
1 required
HierarchyOutgoingCreditTransferFeature
object
Specify OctFeature (periodicOct, periodicOctType, periodicOctMaxThreshold, etc.)
9 properties
AddOnSubscription
object
6 properties
DeliveryChannel
object
Specify the channel for letter delivery used for this contract
3 properties
AccountIdentifier
object
2 properties
ApiResponseEntityContract
object
Issuer response entity
2 properties
1 required
CreditTransfer
object
21 properties
ApiResponseEntityCancelAccountDelinquencyResponse
object
Issuer response entity
2 properties
1 required
EmailAddress
object
1 property
1 required
InsuranceContract
object
10 properties
AccountBalance
object
14 properties
CardContract
object
58 properties
ApiResponseEntityContractMember
object
Issuer response entity
2 properties
1 required
ExternalVelocityLimitIdentifier
object
1 property
AddressVersionIdentifier
object
1 property
OrderIdentifier
object
Order reference calculated by our system
1 property
ModifyHierarchyOutgoingCreditTransferFeature
object
Specify OctFeature (periodicOct, periodicOctType, periodicOctMaxThreshold, etc.)
9 properties
ApiResponseEntityModifyCreditLimitResponse
object
Issuer response entity
2 properties
1 required
ExternalRestrictionIdentifier
object
1 property
UnauthorizedErrorApiResponse
object
1 property
1 required
CreateMandateRequest
object
20 properties
DirectDebit
object
21 properties
ApiResponseEntityListTemporaryCreditLimit
object
Issuer response entity
2 properties
1 required
CorporateContract
object
31 properties
ProductChangeInformation
object
Only if a product change is triggered by card replacement. Represents product change information
11 properties
ApiResponseEntityCreateMandateResponse
object
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
Account
object
103 properties
12 required
ModifyAccountOutgoingCreditTransferFeature
object
The issuer can override each different Outgoing Credit Transfer (OCT) options if is allowed within the reimbursement model.
9 properties
ApiResponseEntityCreditLimit
object
Issuer response entity
2 properties
1 required
InsuranceEvent
object
3 properties
HierarchyOperationStatus
object
4 properties
ApiResponseEntityAccount
object
Issuer response entity
2 properties
1 required
MultiCard
object
6 properties
AdvertisementFlags
object
Specify possible channels used to provide advertisements
6 properties
PinInheritanceCardIdentifier
object
2 properties
HierarchyOperationStatusHistory
object
6 properties
Amount
object
3 properties
3 required
CardContractModel
object
2 properties
Contract
object
Consumer contract entity
39 properties
TurnoverInformation
object
5 properties
2 required
ContactCenterIdentifier
object
1 property
TemporaryCreditLimitIdentifier
object
1 property
ApiResponseEntityCorporateContract
object
Issuer response entity
2 properties
1 required
DirectDebitIdentifier
object
1 property
AuthorizationDataValidation
object
The issuer can update cardholder data used by the Front Office for verification (AVS/ANI).
6 properties
ModifyCreditLimitRequest
object
1 property
1 required
Contact
object
11 properties
ApiResponseEntityListDirectDebit
object
Issuer response entity
2 properties
1 required
BadRequestResponseMetadata
object
4 properties
4 required
CardStatusHistory
object
6 properties
ContactCenter
object
6 properties
AddOnServiceParameter
object
4 properties
ApiResponseEntityTurnover
object
Issuer response entity
2 properties
1 required
PhoneNumber
object
3 properties
1 required
BadGatewayResponseMetadata
object
4 properties
4 required
ExternalVelocityLimit
object
7 properties
1 required
ContractIdentifier
object
Identification of thecorporate contract either by Issuer contract external reference or by contract reference
2 properties
ForbiddenResponseMetadata
object
4 properties
4 required
Company
object
21 properties
ApiResponseEntityCancelMandateResponse
object
2 properties
1 required
Vulnerability
object
2 properties
1 required
CardBlockingInformation
object
25 properties
1 required
CreditTransferIdentifier
object
1 property
InsuranceContractIdentifier
object
The insurance package which is linked to this contract
1 property
ModifyAccountResponse
object
1 property
SepaMandateMailAddress
object
13 properties
AddressIdentifier
object
2 properties
LoyaltyPoint
object
2 properties
Links
object
2 properties
1 required
UnauthorizedResponseMetadata
object
4 properties
4 required
ModifyAccountRequest
object
34 properties
CancelMandateResponse
object
4 properties
Address
object
15 properties
2 required
NotFoundResponseMetadata
object
4 properties
4 required
ResponseMetadata
object
6 properties
4 required
AccountRelation
object
2 properties
2 required
OrderStatusHistory
object
3 properties
ApiResponseEntityAccountBalance
object
Issuer response entity
2 properties
1 required
ApiResponseEntityModifyAccountResponse
object
Issuer response entity
2 properties
1 required
CorporateContractEntity
object
Specify the corporate contract entity
8 properties
LegitimacyDocument
object
Legitimacy document information
6 properties
ApiResponseEntityTurnoverInformation
object
Issuer response entity
2 properties
1 required
ContractFee
object
6 properties
InsuranceContractPackage
object
2 properties
CardChange
object
2 properties
PreviousPeriodTurnover
object
4 properties
3 required
BadRequestErrorApiResponse
object
1 property
1 required
CreditTransferStatusHistory
object
4 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 - Authorization API
Worldline Account - Authorization Restriction API
Worldline Account - Cvv2 Try Counter API
#Account