API version 2.10.1
Contact

Get in touch
Please get in touch if you need any assistance, our team is happy to help.
Initiating Party Extranet
The Initiating Party Extranet is the GUI Interface for the Initiating Party to access and use the Open Banking Platform and provides the following Modules:
Master data and Subscription Management
Transaction Management and Post Processing
Refund Processing
User Management
Secure User Login
Report Management
Documents (view and download only)
Online Help
Functional Modules with partly or without GUI Access:
Directory Service Management ♦ Reconciliation / Clearing Module ♦ Audit Logs ♦ White Labelling
Administrator Portal
The Administrator Portal is the GUI Interface for Backoffice Users of the client to access and administer the Open Banking Platform. It provides the following modules:
Initiating Party and Subscription Management
User and Access Management
Service Provider Management
Banks can set up Providers for Initiating Parties in their environment. Those Service Providers do the technical integration for them and make it more easy to offer payment means to the customers. So (e.g. smaller) Initiating Parties can avoid the effort of integrating to the routing services systems for each payment mean by choosing a PSP as Way of Integration during the onboarding The service provider needs some configuration on the system, e.g. they have to provide a valid certificate and some mandatory data. In order to maintain the service providers per service to be offered to Initiating Parties as connection method, the Open Banking Platform provides the Service Provider Management.
Which features are provided?
The Service Provider Management enables Initiating Parties and Bank Backoffice Admins according to their access rights to maintain the following features: Service Provider data, Account data, Service Subscription Data, Technical & Security data, Setup, check, manage, deactivate existing service providers.
User Login Functionalities
As standard the Backoffice includes an access control via personified login page, the user can insert his name and valid password into the according fields and submit via the Login button. If the entered data don’t match, an error message (Authorization failed) informs him and after repetition and successful validation he is logged in the application. In case of forgotten password, additionally a link “Forgot Password” available. Using it, an according dialog starts to renew the current password.
Also as standard solution our Backoffice includes an user login with 2FA Authentication, which can be activated per acquirer bank / tenant via the configuration management. Once activated the existing username/password is used as first factor, the smartphone functions as second factor. On the smartphone an One Time Password (The user has to install an OTP generator on his smartphone, e.g. FreeOTP Authenticator). can be used to provide a temporary valid OTP, which has to be entered into the login form.
In addition the latest possible date from which the use of the OTP feature becomes mandatory for users is configurable on per acquirer / tenant: In this case an individual “Start of OTP” is stored for each user (new or already existing), who does the first login for his acquirer via 2FA. During every login now is checked, whether the individual "Start of OTP" date of the user is already exceeded and how many days remain until expiration. Before expiration, the user is able skip the OTP secret verification (via an according button on the GUI), afterwards he has to verify and register an OTP secret.
As login mechanismen to the bank systems we provide Web Single Sign On functionality (Web SSO) using credentials for authentication, which are a unique username and password: By using this functionality the first step it is checked if the user is already logged in to the authentication system. Users, who are already signed in, are marked as Single Sign On Users in the system and are granted access immediately. If not, the user is directed to the authentication system to sign in. For each session, the user must first sign into the authentication system with a unique username and password. The authentication system uses a token for the session that stays in effect until the user logs out.
After the authentication process is running, the authentication information is passed to the application, requesting verification of the user.
To login the OB Platform via Web Single Sign On (Web SSO) the banks offer special URLs. The Certificate, which is needed for the securing the Web SSO connection, can be uploaded via the Merchant and Subscription Management Module.
Certificate Management
Our Certificate Management provides a central management for certificates and is operated from the Backoffice GUI. As a consequence of PSD2 this functionality allows to manage hundreds of certificates and to automatically update related keystores in all associated Routing Service Instances during runtime: Certificates can be refreshed automatically during application runtime of the Routing service.
The Certificate Management allows creating Qualified Website Authentication Certificates (commonly known as TLS certificates) and Qualified Electronic Seal, certificate signing request (CSR). Whereas the key pairs, consisting of a private and public key, for QWAC CSRs are generated by the module itself; keys for QSEAL CSRs are derived from HSM Boxes using the restcrypto-server application.
Once the official signing process of QWAC and QSEAL CSRs is completed by an external certification authority (CA), the resulted certificates can be uploaded to the Certificate Management Module.
At last a functionality within the module allows the user to send the certificates (as for QWACs the private keys as well) wrapped in a keystore to the Routing Service Instances at runtime.
If the same certifiacte (fingerprint) is stored on merchant and subscription level, the certificate is only stored once. It will only be deleted, when the certifcate is deleted on both levels on Backoffice side.
I is possible to Upload Certificates for the API authentication in the BO on merchant level additionally to the ones on subscription level. This is allowing to use the same certificate for all subscriptions.
Transactions Processing/ Refund Processing: Overview of all IP running on the system
Initiating Party Ticketing/Support
Document Management
Dynamic Creditor Account Lookup (DCAL)
We provide a Dynamic Creditor Account Lookup Service , which can be switched on or off for each of the tenants’ Initiating Party (by the tenant’s Backoffice Admin). If the DCAL is activated, up to ten additional creditor accounts can be set up. This service will only be used for Initiating Party without Sub Ids.
In case, the DCAL service is switched off, but DCAL entries already exist, those entries will not be deleted. When DCAL is switched back on, the data are available again. Clients, who have access to the Backoffice as Admin User can select the DCAL option itself in the Tenant GUI and on the Initiating Party GUI , in the PIS service configuration.
Via the DCAL screen the on/off switch can be managed very easily and on the DCAL table creditor accounts can be created, updated and deleted.
Backoffice
The Open Banking Platform consists of several components, that you might use depending on the product - the Back Office is one major component, allowing to onboard and manage your clients, view transactions and create refunds. Here you'll find an overview of modules, which we offer and might be of interest.
The Administrator Portal is the GUI Interface for Backoffice Users of the client to access and administer the Open Banking Platform. It provides the following modules:
Initiating Party and Subscription Management ♦ User and Access Management ♦ Initiation Service ♦ User Login Functionalities ♦ Certificate Management ♦ Transactions Processing/ Refund Processing ♦ Initiating Party Ticketing/Support ♦ Document Management ♦ Dynamic Creditor Account Lookup
The Initiating Party Extranet is the GUI Interface for the Initiating Party to access and use the Open Banking Platform and provides the following Modules: Master data and Subscription Management ♦ Transaction Management and Post Processing ♦ Refund Processing ♦ User Management ♦ Secure User Login ♦ Report Management ♦ Documents (view and download only) ♦ Online Help
Functional Modules with partly or without GUI Access:
Directory Service Management ♦ Reconciliation / Clearing Module ♦ Audit Logs ♦ White Labelling
Release Notes: Recent Update
- Version 2.10.0 to 2.10.1
- What's New
- What's Changed
- What's Deleted
- What's Deprecated
What's New
Post a Bonus operation for an account (beta)
POST
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-bonus-operation
The API is used to post manually a Bonus operation to an account. A Bonus operation is used to reward or adjust a given account (in credit or in debit, e.g. in case of too high, too low or missing reward). As an input it must be provided
- the account, identified either by its account reference generated by WL or its issuer external account reference, on which the bonus operation has to be posted
- the related Bonus program, defined for the issuer and the account
- the Bonus operation itself, uniquely identified by its external reference, date and service poster, its amount in currency (monetary) or loyalty point kind (non monetary) Note:
- for monetary bonus the provided currency must be the same than the posting account, for non monetary bonus the provided loyalty point unit must be allowed by the Bonus program
- it is possible to post credit and debit bonus operation If the Bonus operation is related to an existing initial operation, this latter can be provided. As a result the Bonus operation is posted to the account. Monetary bonus has an immediate impact on the account balance.
Reverse a Bonus operation for an account (beta)
POST
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/reverse-bonus-operation
The API is used to fully reverse a Bonus operation previously posted on an account. As an input it must be provided
- the account, identified either by its account reference generated by WL or its issuer external account reference, on which the bonus operation was previously posted
- the Bonus operation to be reversed
- the information related to the reversal operation (reference, date, service poster)
Post a Bonus operation for an account (beta)
POST
/issuers/{issuerId}/accounts/{accountReference}/post-bonus-operation
The API is used to post manually a Bonus operation to an account. A Bonus operation is used to reward or adjust a given account (in credit or in debit, e.g. in case of too high, too low or missing reward). As an input it must be provided
- the account, identified either by its account reference generated by WL or its issuer external account reference, on which the bonus operation has to be posted
- the related Bonus program, defined for the issuer and the account
- the Bonus operation itself, uniquely identified by its external reference, date and service poster, its amount in currency (monetary) or loyalty point kind (non monetary) Note:
- for monetary bonus the provided currency must be the same than the posting account, for non monetary bonus the provided loyalty point unit must be allowed by the Bonus program
- it is possible to post credit and debit bonus operation If the Bonus operation is related to an existing initial operation, this latter can be provided. As a result the Bonus operation is posted to the account. Monetary bonus has an immediate impact on the account balance.
Reverse a Bonus operation for an account (beta)
POST
/issuers/{issuerId}/accounts/{accountReference}/reverse-bonus-operation
The API is used to fully reverse a Bonus operation previously posted on an account. As an input it must be provided
- the account, identified either by its account reference generated by WL or its issuer external account reference, on which the bonus operation was previously posted
- the Bonus operation to be reversed
- the information related to the reversal operation (reference, date, service poster)
Create a new WL Message subscription
POST
/issuers/{issuerId}/subscriptions
Search for subscriptions (with non-pci search terms)
GET
/issuers/{issuerId}/subscriptions/search
Retrieve subscription by reference
GET
/issuers/{issuerId}/subscriptions/{subscriptionReference}
Modify subscription by reference
PUT
/issuers/{issuerId}/subscriptions/{subscriptionReference}
Delete subscription by reference
DELETE
/issuers/{issuerId}/subscriptions/{subscriptionReference}
Retrieve services by subscription reference
GET
/issuers/{issuerId}/subscriptions/{subscriptionReference}/services
Create new service subscription
POST
/issuers/{issuerId}/subscriptions/{subscriptionReference}/services
Retrieve services for a subscription
GET
/issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}
Modify subscription service by reference
PUT
/issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}
Delete subscription service by reference
DELETE
/issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}
Retrieve subscritpion events by subscription service reference
GET
/issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}/events
Create new event subscription
POST
/issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}/events
Retrieve event for a subscription service
GET
/issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}/events/{subscriptionEventReference}
Modify subscription event by reference
PUT
/issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}/events/{subscriptionEventReference}
Delete subscription event by reference
DELETE
/issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}/events/{subscriptionEventReference}
What's Changed
Retrieve card by external reference
GET
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}
Parameters:
Changed:embed
in query
Response:
- Changed property
data
(objectCard
)- Added property
orders
(array)
- Changed property
cardContract
(objectCardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Added property
Retrieve card order by external reference
GET
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders/{orderReference}
Response:
- Changed property
data
(objectOrder
)- Added property
notExtractedReason
(string) - Added property
notExtractedUpdateDate
(string)
- Changed property
card
(objectCard
)- Added property
orders
(array)
- Changed property
cardContract
(objectCardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Added property
- Added property
Retrieve card
GET
/issuers/{issuerId}/cards/{cardReference}
Parameters:
Changed:embed
in query
Response:
- Changed property
data
(objectCard
)- Added property
orders
(array)
- Changed property
cardContract
(objectCardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Added property
Retrieve card order
GET
/issuers/{issuerId}/cards/{cardReference}/orders/{orderReference}
Response:
- Changed property
data
(objectOrder
)- Added property
notExtractedReason
(string) - Added property
notExtractedUpdateDate
(string)
- Changed property
card
(objectCard
)- Added property
orders
(array)
- Changed property
cardContract
(objectCardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Added property
- Added property
Request credit instalment model simulation
POST
/issuers/{issuerId}/credit-instalments/simulate
Response:
- Changed property
data
(objectCreditInstalmentSimulationResponse
)- New required properties:
simulationDetails
- Changed property
simulationDetails
(array)- Changed items (object
CreditInstalmentSimulationResponseSimulationDetails
)- New required properties:
instalmentModelReference
instalmentTerm
interestRate
monthlyRepaymentAmount
totalInterestAmount
- New required properties:
- Changed items (object
- New required properties:
Retrieve customer address by customer external reference and address external reference
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}
Response:
- Changed property
data
(objectAddress
)- Added property
temporary
(boolean)
- Added property
Retrieve customer address by customer external reference
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}
Response:
- Changed property
data
(objectAddress
)- Added property
temporary
(boolean)
- Added property
Retrieve customer address by address external reference
GET
/issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}
Response:
- Changed property
data
(objectAddress
)- Added property
temporary
(boolean)
- Added property
Retrieve customer address
GET
/issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}
Response:
- Changed property
data
(objectAddress
)- Added property
temporary
(boolean)
- Added property
Retrieve account by external reference
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}
Response:
- Changed property
data
(objectAccount
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
Retrieve account guarantor for an account by external reference
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-guarantor
Response:
- Changed property
data
(objectCustomer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
Retrieve account owner for an account by external reference
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-owner
Response:
- Changed property
data
(objectCustomer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
Retrieve operation by external reference
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations/{operationId}
Response:
- Changed property
data
(objectOperation
)- Added property
loyaltyPoint
(object) - Added property
rewardedOperationIdentifier
(object)
- Added property
Create velocity limit override by external account reference
POST
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/velocity-limits/{velocityLimitReference}/velocity-limit-overrides
Request body:
- New optional properties:
velocityLimitOverrideIdentifier
- Deleted property
velocityLimitOverrideIdentifier
(object)
Retrieve account
GET
/issuers/{issuerId}/accounts/{accountReference}
Response:
- Changed property
data
(objectAccount
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
Retrieve account guarantor for an account
GET
/issuers/{issuerId}/accounts/{accountReference}/account-guarantor
Response:
- Changed property
data
(objectCustomer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
Retrieve account owner for an account
GET
/issuers/{issuerId}/accounts/{accountReference}/account-owner
Response:
- Changed property
data
(objectCustomer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
Retrieve operation
GET
/issuers/{issuerId}/accounts/{accountReference}/operations/{operationId}
Response:
- Changed property
data
(objectOperation
)- Added property
loyaltyPoint
(object) - Added property
rewardedOperationIdentifier
(object)
- Added property
Create velocity limit override
POST
/issuers/{issuerId}/accounts/{accountReference}/velocity-limits/{velocityLimitReference}/velocity-limit-overrides
Request body:
- New optional properties:
velocityLimitOverrideIdentifier
- Deleted property
velocityLimitOverrideIdentifier
(object)
Retrieve company's information (beta)
GET
/issuers/{issuerId}/companies/{customerReference}
Response:
- Changed property
data
(objectCompany
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
Retrieve company information by external reference (beta)
GET
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}
Response:
- Changed property
data
(objectCompany
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
Create address for a company customer (beta)
POST
/issuers/{issuerId}/companies/{customerReference}/addresses
Request body:
- Added property
endDate
(string) - Added property
temporary
(boolean)
Retrieve company's Address information list (beta)
GET
/issuers/{issuerId}/companies/{customerReference}/addresses
Response:
- Changed property
data
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
Retrieve company's address information by address ref (beta)
GET
/issuers/{issuerId}/companies/{customerReference}/addresses/{addressReference}
Response:
- Changed property
data
(objectCompany
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
Retrieve company's address information by address external reference (beta)
GET
/issuers/{issuerId}/companies/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}
Response:
- Changed property
data
(objectCompany
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
Create address for a company by external reference (beta)
POST
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses
Request body:
- Added property
endDate
(string) - Added property
temporary
(boolean)
Retrieve company's Address information list by external reference (beta)
GET
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses
Response:
- Changed property
data
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
Retrieve address information by company external reference (beta)
GET
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}
Response:
- Changed property
data
(objectCompany
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
Retrieve address information by company external reference and address external reference (beta)
GET
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}
Response:
- Changed property
data
(objectCompany
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
Retrieve card contract by external reference
GET
/issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}
Response:
- Changed property
data
(objectCardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
Retrieve cardholder for a card contract by external reference
GET
/issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cardholder
Response:
- Changed property
data
(objectCustomer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
List cards for card contract by external reference
GET
/issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cards
Response:
- Changed property
data
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
Retrieve card contract
GET
/issuers/{issuerId}/card-contracts/{cardContractReference}
Response:
- Changed property
data
(objectCardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
Retrieve cardholder for a card contract
GET
/issuers/{issuerId}/card-contracts/{cardContractReference}/cardholder
Response:
- Changed property
data
(objectCustomer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
List cards for card contract
GET
/issuers/{issuerId}/card-contracts/{cardContractReference}/cards
Response:
- Changed property
data
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
Retrieve card contract for a card by external reference
GET
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/card-contract
Response:
- Changed property
data
(objectCardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
List orders for a card by external reference
GET
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders
Response:
- Changed property
data
(array)- Changed items (object
Order
)- Added property
notExtractedReason
(string) - Added property
notExtractedUpdateDate
(string)
- Changed property
card
(objectCard
)- Added property
orders
(array)
- Changed property
cardContract
(objectCardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Added property
- Added property
- Changed items (object
Retrieve card by cardNumber and sequenceNumber and expiryDate
POST
/issuers/{issuerId}/cards/search
Parameters:
Changed:embed
in query
Response:
- Changed property
data
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
Retrieve card contract for a card
GET
/issuers/{issuerId}/cards/{cardReference}/card-contract
Response:
- Changed property
data
(objectCardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
List orders for a card
GET
/issuers/{issuerId}/cards/{cardReference}/orders
Response:
- Changed property
data
(array)- Changed items (object
Order
)- Added property
notExtractedReason
(string) - Added property
notExtractedUpdateDate
(string)
- Changed property
card
(objectCard
)- Added property
orders
(array)
- Changed property
cardContract
(objectCardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Added property
- Added property
- Changed items (object
Retrieve contract owner for a contract by external reference
GET
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/contract-owner
Response:
- Changed property
data
(objectCustomer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
Retrieve contract owner for a contract
GET
/issuers/{issuerId}/contracts/{contractReference}/contract-owner
Response:
- Changed property
data
(objectCustomer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
Create credit instalment contract
POST
/issuers/{issuerId}/credit-instalments/
Request body:
- New required properties:
payingAccountIdentifier
receivingAccountIdentifier
- New optional properties:
instalmentModelReference
Retrieve customer by external reference
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}
Response:
- Changed property
data
(objectCustomer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
Create address for a customer by external reference
POST
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses
Request body:
- Added property
endDate
(string) - Added property
temporary
(boolean)
List addresses for a customer by external reference
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses
Response:
- Changed property
data
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
Retrieve customer
GET
/issuers/{issuerId}/customers/{customerReference}
Response:
- Changed property
data
(objectCustomer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
Create address for a customer
POST
/issuers/{issuerId}/customers/{customerReference}/addresses
Request body:
- Added property
endDate
(string) - Added property
temporary
(boolean)
List addresses for a customer
GET
/issuers/{issuerId}/customers/{customerReference}/addresses
Response:
- Changed property
data
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
Retrieve contract for an account by external reference
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/contract
Response:
- Changed property
data
(objectContract
)- Changed property
numberOfFreeCardsMembershipFee
(integer-int64 -> integer-int32) - Changed property
numberOfFreeCardsAccountSetupFee
(integer-int64 -> integer-int32) - Changed property
accounts
(array)- Changed items (object
Account
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed items (object
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
contractCustomers
(array)- Changed items (object
Customer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
List operations for an account by external reference
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Added property
loyaltyPoint
(object) - Added property
rewardedOperationIdentifier
(object)
- Added property
- Changed items (object
List operations for last account statement by external reference
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/last/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Added property
loyaltyPoint
(object) - Added property
rewardedOperationIdentifier
(object)
- Added property
- Changed items (object
List operations for next account statement by external reference
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/next/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Added property
loyaltyPoint
(object) - Added property
rewardedOperationIdentifier
(object)
- Added property
- Changed items (object
List operations for an account statement by external reference
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/{cycleClosureDate}/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Added property
loyaltyPoint
(object) - Added property
rewardedOperationIdentifier
(object)
- Added property
- Changed items (object
Retrieve contract for an account
GET
/issuers/{issuerId}/accounts/{accountReference}/contract
Response:
- Changed property
data
(objectContract
)- Changed property
numberOfFreeCardsMembershipFee
(integer-int64 -> integer-int32) - Changed property
numberOfFreeCardsAccountSetupFee
(integer-int64 -> integer-int32) - Changed property
accounts
(array)- Changed items (object
Account
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed items (object
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
contractCustomers
(array)- Changed items (object
Customer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
List operations for an account
GET
/issuers/{issuerId}/accounts/{accountReference}/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Added property
loyaltyPoint
(object) - Added property
rewardedOperationIdentifier
(object)
- Added property
- Changed items (object
List operations for last account statement
GET
/issuers/{issuerId}/accounts/{accountReference}/statements/last/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Added property
loyaltyPoint
(object) - Added property
rewardedOperationIdentifier
(object)
- Added property
- Changed items (object
List operations for next account statement
GET
/issuers/{issuerId}/accounts/{accountReference}/statements/next/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Added property
loyaltyPoint
(object) - Added property
rewardedOperationIdentifier
(object)
- Added property
- Changed items (object
List operations for an account statement
GET
/issuers/{issuerId}/accounts/{accountReference}/statements/{cycleClosureDate}/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Added property
loyaltyPoint
(object) - Added property
rewardedOperationIdentifier
(object)
- Added property
- Changed items (object
Retrieve list of company's information (beta)
GET
/issuers/{issuerId}/companies
Response:
- Changed property
data
(array)- Changed items (object
Company
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
Retrieve contract for a card contract by external reference
GET
/issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/contract
Response:
- Changed property
data
(objectContract
)- Changed property
numberOfFreeCardsMembershipFee
(integer-int64 -> integer-int32) - Changed property
numberOfFreeCardsAccountSetupFee
(integer-int64 -> integer-int32) - Changed property
accounts
(array)- Changed items (object
Account
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed items (object
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
contractCustomers
(array)- Changed items (object
Customer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
Retrieve contract for a card contract
GET
/issuers/{issuerId}/card-contracts/{cardContractReference}/contract
Response:
- Changed property
data
(objectContract
)- Changed property
numberOfFreeCardsMembershipFee
(integer-int64 -> integer-int32) - Changed property
numberOfFreeCardsAccountSetupFee
(integer-int64 -> integer-int32) - Changed property
accounts
(array)- Changed items (object
Account
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed items (object
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
contractCustomers
(array)- Changed items (object
Customer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
Retrieve corporate employee Accounts (beta)
GET
/issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/{accountReference}
Response:
- Changed property
data
(objectCorporateEmployeeAccountResponse
)- Changed property
account
(objectAccount
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
Retrieve corporate employee accounts by account external reference (beta)
GET
/issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Response:
- Changed property
data
(objectCorporateEmployeeAccountResponse
)- Changed property
account
(objectAccount
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
Retrieve corporate employee Accounts by contract external reference and account external reference (beta)
GET
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Response:
- Changed property
data
(objectCorporateEmployeeAccountResponse
)- Changed property
account
(objectAccount
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
Retrieve corporate employee Accounts by contract external reference (beta)
GET
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/{accountReference}
Response:
- Changed property
data
(objectCorporateEmployeeAccountResponse
)- Changed property
account
(objectAccount
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
Update contract by external reference
PATCH
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}
Request body:
- Changed property
numberOfFreeCardsMembershipFee
(integer-int64 -> integer-int32) - Changed property
numberOfFreeCardsAccountSetupFee
(integer-int64 -> integer-int32)
Retrieve contract by external reference
GET
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}
Response:
- Changed property
data
(objectContract
)- Changed property
numberOfFreeCardsMembershipFee
(integer-int64 -> integer-int32) - Changed property
numberOfFreeCardsAccountSetupFee
(integer-int64 -> integer-int32) - Changed property
accounts
(array)- Changed items (object
Account
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed items (object
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
contractCustomers
(array)- Changed items (object
Customer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
List accounts for contract by external reference
GET
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/accounts
Response:
- Changed property
data
(array)- Changed items (object
Account
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed items (object
List card contracts for contract by external reference
GET
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/card-contracts
Response:
- Changed property
data
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
Update addresses of all customers linked to the contract by external reference
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/update-all-customers-addresses
Request body:
- Changed property
addresses
(array)- Changed items (object
ModifyContractCustomersAddressesRequest.Address
)- Added property
invalid
(boolean)
- Added property
- Changed items (object
Update contract
PATCH
/issuers/{issuerId}/contracts/{contractReference}
Request body:
- Changed property
numberOfFreeCardsMembershipFee
(integer-int64 -> integer-int32) - Changed property
numberOfFreeCardsAccountSetupFee
(integer-int64 -> integer-int32)
Retrieve contract
GET
/issuers/{issuerId}/contracts/{contractReference}
Response:
- Changed property
data
(objectContract
)- Changed property
numberOfFreeCardsMembershipFee
(integer-int64 -> integer-int32) - Changed property
numberOfFreeCardsAccountSetupFee
(integer-int64 -> integer-int32) - Changed property
accounts
(array)- Changed items (object
Account
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed items (object
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
contractCustomers
(array)- Changed items (object
Customer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
List accounts for contract
GET
/issuers/{issuerId}/contracts/{contractReference}/accounts
Response:
- Changed property
data
(array)- Changed items (object
Account
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed items (object
List card contracts for contract
GET
/issuers/{issuerId}/contracts/{contractReference}/card-contracts
Response:
- Changed property
data
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
Update addresses of all customers linked to the contract
POST
/issuers/{issuerId}/contracts/{contractReference}/update-all-customers-addresses
Request body:
- Changed property
addresses
(array)- Changed items (object
ModifyContractCustomersAddressesRequest.Address
)- Added property
invalid
(boolean)
- Added property
- Changed items (object
Retrieve list of customer's information
GET
/issuers/{issuerId}/customers
Response:
- Changed property
data
(array)- Changed items (object
Customer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
List accounts for account owner by external reference
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/accounts
Response:
- Changed property
data
(array)- Changed items (object
Account
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed items (object
List card contracts for cardholder by external reference
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/card-contracts
Response:
- Changed property
data
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
List accounts for account owner
GET
/issuers/{issuerId}/customers/{customerReference}/accounts
Response:
- Changed property
data
(array)- Changed items (object
Account
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed items (object
List card contracts for cardholder
GET
/issuers/{issuerId}/customers/{customerReference}/card-contracts
Response:
- Changed property
data
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
Retrieve corporate contract (beta)
GET
/issuers/{issuerId}/corporate-contracts/{contractReference}
Response:
- Changed property
data
(objectCorporateContract
)- Changed property
contractCustomers
(array)- Changed items (object
Customer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
contractCompanies
(array)- Changed items (object
Company
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
corporateContractEntities
(array)- Changed items (object
CorporateContractEntity
)- Changed property
account
(objectAccount
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed property
- Changed items (object
- Changed property
corporateEmployeeAccounts
(array)- Changed items (object
CorporateEmployeeAccount
)- Changed property
account
(objectAccount
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
Retrieve corporate contract by external reference (beta)
GET
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}
Response:
- Changed property
data
(objectCorporateContract
)- Changed property
contractCustomers
(array)- Changed items (object
Customer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
contractCompanies
(array)- Changed items (object
Company
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
corporateContractEntities
(array)- Changed items (object
CorporateContractEntity
)- Changed property
account
(objectAccount
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed property
- Changed items (object
- Changed property
corporateEmployeeAccounts
(array)- Changed items (object
CorporateEmployeeAccount
)- Changed property
account
(objectAccount
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
Retrieve contracts by criteria
POST
/issuers/{issuerId}/contracts/search
Parameters:
Changed:embed
in query
Response:
- Changed property
data
(array)- Changed items (object
Contract
)- Changed property
numberOfFreeCardsMembershipFee
(integer-int64 -> integer-int32) - Changed property
numberOfFreeCardsAccountSetupFee
(integer-int64 -> integer-int32) - Changed property
accounts
(array)- Changed items (object
Account
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed items (object
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
contractCustomers
(array)- Changed items (object
Customer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
List contracts for contract owner by external reference
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contracts
Response:
- Changed property
data
(array)- Changed items (object
Contract
)- Changed property
numberOfFreeCardsMembershipFee
(integer-int64 -> integer-int32) - Changed property
numberOfFreeCardsAccountSetupFee
(integer-int64 -> integer-int32) - Changed property
accounts
(array)- Changed items (object
Account
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed items (object
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
contractCustomers
(array)- Changed items (object
Customer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
List contracts for contract owner
GET
/issuers/{issuerId}/customers/{customerReference}/contracts
Response:
- Changed property
data
(array)- Changed items (object
Contract
)- Changed property
numberOfFreeCardsMembershipFee
(integer-int64 -> integer-int32) - Changed property
numberOfFreeCardsAccountSetupFee
(integer-int64 -> integer-int32) - Changed property
accounts
(array)- Changed items (object
Account
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed items (object
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
contractCustomers
(array)- Changed items (object
Customer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
List corporate contracts for a company (beta)
GET
/issuers/{issuerId}/companies/{customerReference}/corporate-contracts
Response:
- Changed property
data
(array)- Changed items (object
CorporateContract
)- Changed property
contractCustomers
(array)- Changed items (object
Customer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
contractCompanies
(array)- Changed items (object
Company
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
corporateContractEntities
(array)- Changed items (object
CorporateContractEntity
)- Changed property
account
(objectAccount
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed property
- Changed items (object
- Changed property
corporateEmployeeAccounts
(array)- Changed items (object
CorporateEmployeeAccount
)- Changed property
account
(objectAccount
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
List corporate contracts for a company by external reference (beta)
GET
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/corporate-contracts
Response:
- Changed property
data
(array)- Changed items (object
CorporateContract
)- Changed property
contractCustomers
(array)- Changed items (object
Customer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
contractCompanies
(array)- Changed items (object
Company
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
corporateContractEntities
(array)- Changed items (object
CorporateContractEntity
)- Changed property
account
(objectAccount
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed property
- Changed items (object
- Changed property
corporateEmployeeAccounts
(array)- Changed items (object
CorporateEmployeeAccount
)- Changed property
account
(objectAccount
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
Create consumer contract
POST
/issuers/{issuerId}/contracts/create-consumer-contract
Request body:
- Changed property
contract
(objectCreateConsumerContractRequest.Contract
)- Changed property
numberOfFreeCardsMembershipFee
(integer-int64 -> integer-int32) - Changed property
numberOfFreeCardsAccountSetupFee
(integer-int64 -> integer-int32)
- Changed property
What's Deleted
No API deleted.
What's Deprecated
No API deprecated.
Release Notes: Recent Update (temporary page)
Version 2.10.0 to 2.10.1
What's New
POST
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-bonus-operation
The API is used to post manually a Bonus operation to an account. A Bonus operation is used to reward or adjust a given account (in credit or in debit, e.g. in case of too high, too low or missing reward). As an input it must be provided
- the account, identified either by its account reference generated by WL or its issuer external account reference, on which the bonus operation has to be posted
- the related Bonus program, defined for the issuer and the account
- the Bonus operation itself, uniquely identified by its external reference, date and service poster, its amount in currency (monetary) or loyalty point kind (non monetary) Note:
- for monetary bonus the provided currency must be the same than the posting account, for non monetary bonus the provided loyalty point unit must be allowed by the Bonus program
- it is possible to post credit and debit bonus operation
If the Bonus operation is related to an existing initial operation, this latter can be provided.
As a result the Bonus operation is posted to the account. Monetary bonus has an immediate impact on the account balance.
POST
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/reverse-bonus-operation
Reverse a Bonus operation for an account (beta)
The API is used to fully reverse a Bonus operation previously posted on an account.
As an input it must be provided
- the account, identified either by its account reference generated by WL or its issuer external account reference, on which the bonus operation was previously posted
- the Bonus operation to be reversed
- the information related to the reversal operation (reference, date, service poster)
POST
/issuers/{issuerId}/accounts/{accountReference}/post-bonus-operation
Post a Bonus operation for an account (beta)
The API is used to post manually a Bonus operation to an account. A Bonus operation is used to reward or adjust a given account (in credit or in debit, e.g. in case of too high, too low or missing reward). As an input it must be provided
- the account, identified either by its account reference generated by WL or its issuer external account reference, on which the bonus operation has to be posted
- the related Bonus program, defined for the issuer and the account
- the Bonus operation itself, uniquely identified by its external reference, date and service poster, its amount in currency (monetary) or loyalty point kind (non monetary) Note:
- for monetary bonus the provided currency must be the same than the posting account, for non monetary bonus the provided loyalty point unit must be allowed by the Bonus program
- it is possible to post credit and debit bonus operation
If the Bonus operation is related to an existing initial operation, this latter can be provided.
As a result the Bonus operation is posted to the account. Monetary bonus has an immediate impact on the account balance.
POST
/issuers/{issuerId}/accounts/{accountReference}/reverse-bonus-operation
Reverse a Bonus operation for an account (beta)
The API is used to fully reverse a Bonus operation previously posted on an account.
As an input it must be provided
- the account, identified either by its account reference generated by WL or its issuer external account reference, on which the bonus operation was previously posted
- the Bonus operation to be reversed
- the information related to the reversal operation (reference, date, service poster)
POST
/issuers/{issuerId}/subscriptions
Create a new WL Message subscription
GET
/issuers/{issuerId}/subscriptions/search
Search for subscriptions (with non-pci search terms)
GET
/issuers/{issuerId}/subscriptions/{subscriptionReference}
Retrieve subscription by reference
PUT
/issuers/{issuerId}/subscriptions/{subscriptionReference}
Modify subscription by reference
DELETE
/issuers/{issuerId}/subscriptions/{subscriptionReference}
Delete subscription by reference
GET
/issuers/{issuerId}/subscriptions/{subscriptionReference}/services
Retrieve services by subscription reference
POST
/issuers/{issuerId}/subscriptions/{subscriptionReference}/services
Create new service subscription
GET
/issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}
Retrieve services for a subscription
PUT
/issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}
Modify subscription service by reference
DELETE
/issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}
Delete subscription service by reference
GET
/issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}/events
Retrieve subscritpion events by subscription service reference
POST
/issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}/events
Create new event subscription
GET
/issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}/events/{subscriptionEventReference}
Retrieve event for a subscription service
PUT
/issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}/events/{subscriptionEventReference}
Modify subscription event by reference
DELETE
/issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}/events/{subscriptionEventReference}
Delete subscription event by reference
What's Changed
GET
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}
Parameters:
Changed: embed
in query
Response:
- Changed property
data
(objectCard
)- Added property
orders
(array) - Changed property
cardContract
(objectCardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Added property
GET
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders/{orderReference}
Response:
- Changed property
data
(objectOrder
)- Added property
notExtractedReason
(string) - Added property
notExtractedUpdateDate
(string) - Changed property
card
(objectCard
)- Added property
orders
(array) - Changed property
cardContract
(objectCardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Added property
- Added property
GET
/issuers/{issuerId}/cards/{cardReference}
Parameters:
Changed: embed
in query
Response:
- Changed property
data
(objectCard
)- Added property
orders
(array) - Changed property
cardContract
(objectCardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Added property
GET
/issuers/{issuerId}/cards/{cardReference}/orders/{orderReference}
Response:
- Changed property
data
(objectOrder
)- Added property
notExtractedReason
(string) - Added property
notExtractedUpdateDate
(string) - Changed property
card
(objectCard
)- Added property
orders
(array) - Changed property
cardContract
(objectCardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Added property
- Added property
POST
/issuers/{issuerId}/credit-instalments/simulate
Response:
- Changed property
data
(objectCreditInstalmentSimulationResponse
)-
New required properties:
simulationDetails
-
Changed property
simulationDetails
(array)- Changed items (object
CreditInstalmentSimulationResponseSimulationDetails
)- New required properties:
instalmentModelReference
instalmentTerm
interestRate
monthlyRepaymentAmount
totalInterestAmount
- New required properties:
- Changed items (object
-
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}
Response:
- Changed property
data
(objectAddress
)- Added property
temporary
(boolean)
- Added property
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}
Response:
- Changed property
data
(objectAddress
)- Added property
temporary
(boolean)
- Added property
GET
/issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}
Response:
- Changed property
data
(objectAddress
)- Added property
temporary
(boolean)
- Added property
GET
/issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}
Response:
- Changed property
data
(objectAddress
)- Added property
temporary
(boolean)
- Added property
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}
Response:
- Changed property
data
(objectAccount
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-guarantor
Response:
- Changed property
data
(objectCustomer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-owner
Response:
- Changed property
data
(objectCustomer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations/{operationId}
Response:
- Changed property
data
(objectOperation
)- Added property
loyaltyPoint
(object) - Added property
rewardedOperationIdentifier
(object)
- Added property
POST
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/velocity-limits/{velocityLimitReference}/velocity-limit-overrides
Request body:
-
New optional properties:
velocityLimitOverrideIdentifier
-
Deleted property
velocityLimitOverrideIdentifier
(object)
GET
/issuers/{issuerId}/accounts/{accountReference}
Response:
- Changed property
data
(objectAccount
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
GET
/issuers/{issuerId}/accounts/{accountReference}/account-guarantor
Response:
- Changed property
data
(objectCustomer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/accounts/{accountReference}/account-owner
Response:
- Changed property
data
(objectCustomer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/accounts/{accountReference}/operations/{operationId}
Response:
- Changed property
data
(objectOperation
)- Added property
loyaltyPoint
(object) - Added property
rewardedOperationIdentifier
(object)
- Added property
POST
/issuers/{issuerId}/accounts/{accountReference}/velocity-limits/{velocityLimitReference}/velocity-limit-overrides
Request body:
-
New optional properties:
velocityLimitOverrideIdentifier
-
Deleted property
velocityLimitOverrideIdentifier
(object)
GET
/issuers/{issuerId}/companies/{customerReference}
Response:
- Changed property
data
(objectCompany
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}
Response:
- Changed property
data
(objectCompany
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
POST
/issuers/{issuerId}/companies/{customerReference}/addresses
Request body:
- Added property
endDate
(string) - Added property
temporary
(boolean)
GET
/issuers/{issuerId}/companies/{customerReference}/addresses
Response:
- Changed property
data
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
GET
/issuers/{issuerId}/companies/{customerReference}/addresses/{addressReference}
Response:
- Changed property
data
(objectCompany
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/companies/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}
Response:
- Changed property
data
(objectCompany
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
POST
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses
Request body:
- Added property
endDate
(string) - Added property
temporary
(boolean)
GET
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses
Response:
- Changed property
data
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
GET
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}
Response:
- Changed property
data
(objectCompany
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}
Response:
- Changed property
data
(objectCompany
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}
Response:
- Changed property
data
(objectCardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cardholder
Response:
- Changed property
data
(objectCustomer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cards
Response:
- Changed property
data
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
GET
/issuers/{issuerId}/card-contracts/{cardContractReference}
Response:
- Changed property
data
(objectCardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/card-contracts/{cardContractReference}/cardholder
Response:
- Changed property
data
(objectCustomer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/card-contracts/{cardContractReference}/cards
Response:
- Changed property
data
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
GET
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/card-contract
Response:
- Changed property
data
(objectCardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders
Response:
- Changed property
data
(array)- Changed items (object
Order
)- Added property
notExtractedReason
(string) - Added property
notExtractedUpdateDate
(string) - Changed property
card
(objectCard
)- Added property
orders
(array) - Changed property
cardContract
(objectCardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Added property
- Added property
- Changed items (object
POST
/issuers/{issuerId}/cards/search
Parameters:
Changed: embed
in query
Response:
- Changed property
data
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
GET
/issuers/{issuerId}/cards/{cardReference}/card-contract
Response:
- Changed property
data
(objectCardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/cards/{cardReference}/orders
Response:
- Changed property
data
(array)- Changed items (object
Order
)- Added property
notExtractedReason
(string) - Added property
notExtractedUpdateDate
(string) - Changed property
card
(objectCard
)- Added property
orders
(array) - Changed property
cardContract
(objectCardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Added property
- Added property
- Changed items (object
GET
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/contract-owner
Response:
- Changed property
data
(objectCustomer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/contracts/{contractReference}/contract-owner
Response:
- Changed property
data
(objectCustomer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
POST
/issuers/{issuerId}/credit-instalments/
Request body:
-
New required properties:
payingAccountIdentifier
receivingAccountIdentifier
-
New optional properties:
instalmentModelReference
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}
Response:
- Changed property
data
(objectCustomer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
POST
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses
Request body:
- Added property
endDate
(string) - Added property
temporary
(boolean)
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses
Response:
- Changed property
data
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
GET
/issuers/{issuerId}/customers/{customerReference}
Response:
- Changed property
data
(objectCustomer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
POST
/issuers/{issuerId}/customers/{customerReference}/addresses
Request body:
- Added property
endDate
(string) - Added property
temporary
(boolean)
GET
/issuers/{issuerId}/customers/{customerReference}/addresses
Response:
- Changed property
data
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/contract
Response:
- Changed property
data
(objectContract
)- Changed property
numberOfFreeCardsMembershipFee
(integer-int64 -> integer-int32) - Changed property
numberOfFreeCardsAccountSetupFee
(integer-int64 -> integer-int32) - Changed property
accounts
(array)- Changed items (object
Account
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed items (object
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
contractCustomers
(array)- Changed items (object
Customer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Added property
loyaltyPoint
(object) - Added property
rewardedOperationIdentifier
(object)
- Added property
- Changed items (object
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/last/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Added property
loyaltyPoint
(object) - Added property
rewardedOperationIdentifier
(object)
- Added property
- Changed items (object
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/next/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Added property
loyaltyPoint
(object) - Added property
rewardedOperationIdentifier
(object)
- Added property
- Changed items (object
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/{cycleClosureDate}/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Added property
loyaltyPoint
(object) - Added property
rewardedOperationIdentifier
(object)
- Added property
- Changed items (object
GET
/issuers/{issuerId}/accounts/{accountReference}/contract
Response:
- Changed property
data
(objectContract
)- Changed property
numberOfFreeCardsMembershipFee
(integer-int64 -> integer-int32) - Changed property
numberOfFreeCardsAccountSetupFee
(integer-int64 -> integer-int32) - Changed property
accounts
(array)- Changed items (object
Account
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed items (object
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
contractCustomers
(array)- Changed items (object
Customer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/accounts/{accountReference}/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Added property
loyaltyPoint
(object) - Added property
rewardedOperationIdentifier
(object)
- Added property
- Changed items (object
GET
/issuers/{issuerId}/accounts/{accountReference}/statements/last/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Added property
loyaltyPoint
(object) - Added property
rewardedOperationIdentifier
(object)
- Added property
- Changed items (object
GET
/issuers/{issuerId}/accounts/{accountReference}/statements/next/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Added property
loyaltyPoint
(object) - Added property
rewardedOperationIdentifier
(object)
- Added property
- Changed items (object
GET
/issuers/{issuerId}/accounts/{accountReference}/statements/{cycleClosureDate}/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Added property
loyaltyPoint
(object) - Added property
rewardedOperationIdentifier
(object)
- Added property
- Changed items (object
GET
/issuers/{issuerId}/companies
Response:
- Changed property
data
(array)- Changed items (object
Company
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
GET
/issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/contract
Response:
- Changed property
data
(objectContract
)- Changed property
numberOfFreeCardsMembershipFee
(integer-int64 -> integer-int32) - Changed property
numberOfFreeCardsAccountSetupFee
(integer-int64 -> integer-int32) - Changed property
accounts
(array)- Changed items (object
Account
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed items (object
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
contractCustomers
(array)- Changed items (object
Customer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/card-contracts/{cardContractReference}/contract
Response:
- Changed property
data
(objectContract
)- Changed property
numberOfFreeCardsMembershipFee
(integer-int64 -> integer-int32) - Changed property
numberOfFreeCardsAccountSetupFee
(integer-int64 -> integer-int32) - Changed property
accounts
(array)- Changed items (object
Account
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed items (object
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
contractCustomers
(array)- Changed items (object
Customer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/{accountReference}
Response:
- Changed property
data
(objectCorporateEmployeeAccountResponse
)- Changed property
account
(objectAccount
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Response:
- Changed property
data
(objectCorporateEmployeeAccountResponse
)- Changed property
account
(objectAccount
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Response:
- Changed property
data
(objectCorporateEmployeeAccountResponse
)- Changed property
account
(objectAccount
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/{accountReference}
Response:
- Changed property
data
(objectCorporateEmployeeAccountResponse
)- Changed property
account
(objectAccount
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
PATCH
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}
Request body:
- Changed property
numberOfFreeCardsMembershipFee
(integer-int64 -> integer-int32) - Changed property
numberOfFreeCardsAccountSetupFee
(integer-int64 -> integer-int32)
GET
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}
Response:
- Changed property
data
(objectContract
)- Changed property
numberOfFreeCardsMembershipFee
(integer-int64 -> integer-int32) - Changed property
numberOfFreeCardsAccountSetupFee
(integer-int64 -> integer-int32) - Changed property
accounts
(array)- Changed items (object
Account
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed items (object
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
contractCustomers
(array)- Changed items (object
Customer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/accounts
Response:
- Changed property
data
(array)- Changed items (object
Account
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed items (object
GET
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/card-contracts
Response:
- Changed property
data
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/update-all-customers-addresses
Request body:
- Changed property
addresses
(array)- Changed items (object
ModifyContractCustomersAddressesRequest.Address
)- Added property
invalid
(boolean)
- Added property
- Changed items (object
PATCH
/issuers/{issuerId}/contracts/{contractReference}
Request body:
- Changed property
numberOfFreeCardsMembershipFee
(integer-int64 -> integer-int32) - Changed property
numberOfFreeCardsAccountSetupFee
(integer-int64 -> integer-int32)
GET
/issuers/{issuerId}/contracts/{contractReference}
Response:
- Changed property
data
(objectContract
)- Changed property
numberOfFreeCardsMembershipFee
(integer-int64 -> integer-int32) - Changed property
numberOfFreeCardsAccountSetupFee
(integer-int64 -> integer-int32) - Changed property
accounts
(array)- Changed items (object
Account
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed items (object
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
contractCustomers
(array)- Changed items (object
Customer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/contracts/{contractReference}/accounts
Response:
- Changed property
data
(array)- Changed items (object
Account
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed items (object
GET
/issuers/{issuerId}/contracts/{contractReference}/card-contracts
Response:
- Changed property
data
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
POST
/issuers/{issuerId}/contracts/{contractReference}/update-all-customers-addresses
Request body:
- Changed property
addresses
(array)- Changed items (object
ModifyContractCustomersAddressesRequest.Address
)- Added property
invalid
(boolean)
- Added property
- Changed items (object
GET
/issuers/{issuerId}/customers
Response:
- Changed property
data
(array)- Changed items (object
Customer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/accounts
Response:
- Changed property
data
(array)- Changed items (object
Account
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed items (object
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/card-contracts
Response:
- Changed property
data
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
GET
/issuers/{issuerId}/customers/{customerReference}/accounts
Response:
- Changed property
data
(array)- Changed items (object
Account
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed items (object
GET
/issuers/{issuerId}/customers/{customerReference}/card-contracts
Response:
- Changed property
data
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
GET
/issuers/{issuerId}/corporate-contracts/{contractReference}
Response:
- Changed property
data
(objectCorporateContract
)- Changed property
contractCustomers
(array)- Changed items (object
Customer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
contractCompanies
(array)- Changed items (object
Company
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
corporateContractEntities
(array)- Changed items (object
CorporateContractEntity
)- Changed property
account
(objectAccount
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed property
- Changed items (object
- Changed property
corporateEmployeeAccounts
(array)- Changed items (object
CorporateEmployeeAccount
)- Changed property
account
(objectAccount
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}
Response:
- Changed property
data
(objectCorporateContract
)- Changed property
contractCustomers
(array)- Changed items (object
Customer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
contractCompanies
(array)- Changed items (object
Company
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
corporateContractEntities
(array)- Changed items (object
CorporateContractEntity
)- Changed property
account
(objectAccount
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed property
- Changed items (object
- Changed property
corporateEmployeeAccounts
(array)- Changed items (object
CorporateEmployeeAccount
)- Changed property
account
(objectAccount
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
POST
/issuers/{issuerId}/contracts/search
Parameters:
Changed: embed
in query
Response:
- Changed property
data
(array)- Changed items (object
Contract
)- Changed property
numberOfFreeCardsMembershipFee
(integer-int64 -> integer-int32) - Changed property
numberOfFreeCardsAccountSetupFee
(integer-int64 -> integer-int32) - Changed property
accounts
(array)- Changed items (object
Account
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed items (object
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
contractCustomers
(array)- Changed items (object
Customer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contracts
Response:
- Changed property
data
(array)- Changed items (object
Contract
)- Changed property
numberOfFreeCardsMembershipFee
(integer-int64 -> integer-int32) - Changed property
numberOfFreeCardsAccountSetupFee
(integer-int64 -> integer-int32) - Changed property
accounts
(array)- Changed items (object
Account
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed items (object
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
contractCustomers
(array)- Changed items (object
Customer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
GET
/issuers/{issuerId}/customers/{customerReference}/contracts
Response:
- Changed property
data
(array)- Changed items (object
Contract
)- Changed property
numberOfFreeCardsMembershipFee
(integer-int64 -> integer-int32) - Changed property
numberOfFreeCardsAccountSetupFee
(integer-int64 -> integer-int32) - Changed property
accounts
(array)- Changed items (object
Account
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed items (object
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
contractCustomers
(array)- Changed items (object
Customer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
GET
/issuers/{issuerId}/companies/{customerReference}/corporate-contracts
Response:
- Changed property
data
(array)- Changed items (object
CorporateContract
)- Changed property
contractCustomers
(array)- Changed items (object
Customer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
contractCompanies
(array)- Changed items (object
Company
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
corporateContractEntities
(array)- Changed items (object
CorporateContractEntity
)- Changed property
account
(objectAccount
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed property
- Changed items (object
- Changed property
corporateEmployeeAccounts
(array)- Changed items (object
CorporateEmployeeAccount
)- Changed property
account
(objectAccount
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
GET
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/corporate-contracts
Response:
- Changed property
data
(array)- Changed items (object
CorporateContract
)- Changed property
contractCustomers
(array)- Changed items (object
Customer
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
contractCompanies
(array)- Changed items (object
Company
)- Changed property
addresses
(array)- Changed items (object
Address
)- Added property
temporary
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
corporateContractEntities
(array)- Changed items (object
CorporateContractEntity
)- Changed property
account
(objectAccount
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed property
- Changed items (object
- Changed property
corporateEmployeeAccounts
(array)- Changed items (object
CorporateEmployeeAccount
)- Changed property
account
(objectAccount
)- Added property
hierarchyBonusProgramReferences
(array) - Added property
openCycleInformation
(object)
- Added property
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
orders
(array)
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
POST
/issuers/{issuerId}/contracts/create-consumer-contract
Request body:
- Changed property
contract
(objectCreateConsumerContractRequest.Contract
)- Changed property
numberOfFreeCardsMembershipFee
(integer-int64 -> integer-int32) - Changed property
numberOfFreeCardsAccountSetupFee
(integer-int64 -> integer-int32)
- Changed property
What's Deleted
No API deleted.
What's Deprecated
No API deprecated.
Get Started V2

Find the right API
Browse our APIs and get a profound understanding of the value and opportunities they bring to you.

Create an account
Sign up and ask for access to the API to enable the Try-out feature.

Last step before going live
Let our API team know you are ready to take the APIs into production. We will onboard you accordingly and work with you to complete the risk reviews, contracts and billing agreements.
FIDO Wording Guidelines
In order to promote the use of FIDO and to help standardize the user experience, the FIDO Alliance has written some guidelines about how to display information related to FIDO when using it on a website.
However, these guidelines are mainly constructed around the use of FIDO for account log-in. In the case of transaction validation and two factor authentication using WAFL, some of the recommendations are not really applicable.
You will find here what we could extract from this official documentation that is relevant to apply in our context and that we used in our demonstration.
FIDO during the user journey - Our interpretation
-
Until the user is logged-in, no change on the website.
-
Once the user is logged-in, on the their main dashboard, advertise the fact that a new way to Authenticate payments is available, and link to the settings to enable it, but only if the device supports FIDO.
(see how to check that in the implementation guide)
Do not mention FIDO yet, but only biometrics.
Use a fingerprint icon matching the user platform : Apple icon for Mac and iOS; generic icon for other platforms. -
In the user settings, the section dedicated to FIDO activation should :
-
Use proper biometrics icon.
-
Start mentioning FIDO.
-
Offer registration only on supported device.
-
Mention that even though it is supported, it might be necessary to enable it in the device settings, and indicate how to do so. (Ex: Windows Hello can be disabled, but FIDO will appear as supported by the device)
-
Insist on the benefits of using FIDO : it's faster and it's simpler.
-
Display the FIDO logo.
-
At the bottom, add a link to display some FIDO key facts, as provided in the official guidelines.
-
-
During transaction validation, if the user used an other validation method, invite the user to register FIDO after a successful transaction if their device is not registered yet.
Official extracts
Information about Security Keys
-
What is a security key?
A security key is a small, physical device that works in addition to your password on sites that support it. A single key can be used with multiple accounts or sites.
-
Why should I use a security key?
Security keys protect you against imposter websites that try to steal login credentials (like usernames and passwords). Other forms of 2-factor authentication (including text, email, messages, authenticator apps, and push notifications) do not give you the same level of protection as a security key.
-
How security keys work
You must first add security keys using the button above. Once added, you'll be required to use them after signing in with your username and password. Doing this creates one of the strongest forms of authentication available to protect your account.
-
What security technology do security keys use?
Most keys use an authentication "standard" called FIDO® which allows for secure authentication without drivers or software. When a user signs in a website with a key, FIDO® cryptographically signs a challenge from the browser that verifies the website's actual domain name, which provides strong protection against phishing (e.g., when a fake website is used to trick users into sharing personal information). An attacker would need to control the website domain name or the browser to get a usable signature from the key.
-
-
Why do security keys look like thumb drives?
Although hardware security keys may resemble thumb drives and are sometimes inserted into your computer's USB port, they are not storage devices. Your personal information is not trackable or linkable across sites or online accounts when using a security key.
-
What happens if my security key gets stolen?
The key works in addition to your password, not as a replacement for it. If someone steals the key, they still can't get into your bank account without knowing your password (or which sites are registered with your key). You can sign in with a backup method and remove the stolen key from your account.
-
Add more than one security key
Adding multiple security keys is highly recommended. If your security key is lost or stolen and you do not have a registered backup security key (or other backup authentication method), access to your account could be interrupted while we verify your identity. We recommend keeping one key easily accessible and another stored separately in a safe space.
-
Purchase security keys
Security keys vary by manufacturer and can be purchased from mainly online retailers. We recommend FIDO certified keys. See a list of FIDOⓇ certified keys.
-
Name your security keys
Give you security key a friendly "nickname" that only you can see, so you know which key you registered with this account at a later point in time.
Information about Device Unlock
-
How device unlock works
A technology called FIDO lets you sign in securely without relying on a password. Once you've registered your computer's PIN, facial recognition, fingerprint, or security key, FIDO verifies it's really you and doesn't transmit any of your login information over the internet.
-
Why use device unlock
Easy, safe—and private! FIDO makes signing into your online accounts much easier, while keeping your info safe from hackers. Leading companies worldwide in retail, telecommunications, finance and technology are already using FIDO.
-
More information
Registering with FIDO provides you with an additional login option for this device—your password remains valid.
Learn more content
This part contains the information that could be used in any "Learn more" link, tooltip, popup to be displayed under the FIDO icon under Registration or Authentication buttons.
FIDO lets you sign in securely without relying on a password by keeping your login information securely on your device. Nowhere else.
How it works ?
A technology called FIDO lets you sign in securely without relying on a password.
FIDO makes signing into your online accounts much easier, while keeping your info safe from hackers.
Once you’ve registered your computer’s PIN, facial recognition, fingerprint, or security key, FIDO verifies it’s really you and doesn’t transmit any of your login information over the internet.
Easy, safe—and private!
Registering with FIDO provides you with an additional login option for this device—your password remains valid.
Leading companies worldwide in retail, telecommunications, finance and technology are already using FIDO.
FIDO Facts content
This part contains some facts elaborated after some studies involving final users that are designed to improve trust in FIDO.
-
FIDO is a technology built into all leading desktop devices (PC and Mac) and browsers, that allows users to sign in securely without a password.
-
In the same way your phone uses a biometric, FIDO now enables biometric sign-in on websites viewed on your desktop too.
-
FIDO makes sign-in easy, safe, and private!
-
FIDO technology uses your computer’s built-in authentication method (i.e., Windows Hello or Apple Touch ID) to ensure your sign-in information stays safe from hackers because it never leaves your computer.
-
Once you’ve registered your computer’s PIN, facial recognition, fingerprint, or security key, FIDO verifies it’s really you and doesn’t transmit any of your sign-in information over the internet.
-
Registering with FIDO provides you with an additional sign-in option for this device — your password remains valid.
-
Leading companies worldwide in retail, telecommunications, finance, and technology are already using FIDO.