Access Token v2
API version 2.32.0
Release Notes: Recent Update
Version 2.31.0 to 2.32.0
What's New
GET /issuers/{issuerId}/tokens/{tokenReference}/tokenRequestors/{tokenRequestorId}/details
Selfcare : Get token details
This webservice retrieve token information, if existing on G-iTSP side, updated with the tokenProvider data
POST /issuers/{issuerId}/tokens/{tokenReference}/update
Selfcare : Update a token status
This webservice performs update on existing token
POST /issuers/{issuerId}/cards/{cardReference}/click-to-pay-enroll
Click-To-Pay: Enroll a card
Enroll a card into click-to-pay. If account does not exist it will be created. For an account creation (first card) full data must be provided
POST /issuers/{issuerId}/cards/{cardReference}/click-to-pay-remove
Click-To-Pay: Remove a card or complete account
API to remove a card or complete account from click-to-pay
GET /issuers/{issuerId}/cards/{cardReference}/click-to-pay-account-data
Click-To-Pay: Return all data provisioned for a given card
This API will return all data stored into Visa Click-to-Pay for a given card.
GET /issuers/{issuerId}/cards/{cardReference}/emv-commands
**Get Enquire EMV Commands **
What's Changed
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/last
Response:
Changed property data (object Statement)
Added property cycleInformation (object)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/next
Response:
Changed property data (object Statement)
Added property cycleInformation (object)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/{cycleClosureDate}
Response:
Changed property data (object Statement)
Added property cycleInformation (object)
GET /issuers/{issuerId}/accounts/{accountReference}/statements/last
Response:
Changed property data (object Statement)
Added property cycleInformation (object)
GET /issuers/{issuerId}/accounts/{accountReference}/statements/next
Response:
Changed property data (object Statement)
Added property cycleInformation (object)
GET /issuers/{issuerId}/accounts/{accountReference}/statements/{cycleClosureDate}
Response:
Changed property data (object Statement)
Added property cycleInformation (object)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}
Response:
Changed property data (object Account)
Changed property openCycleInformation (object CycleInformation)
Added property cycleDueDate (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements
Response:
Changed property data (array)
Changed items (object Statement)
Added property cycleInformation (object)
GET /issuers/{issuerId}/accounts/{accountReference}
Response:
Changed property data (object Account)
Changed property openCycleInformation (object CycleInformation)
Added property cycleDueDate (string)
GET /issuers/{issuerId}/accounts/{accountReference}/statements
Response:
Changed property data (array)
Changed items (object Statement)
Added property cycleInformation (object)
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/accounts
Response:
Changed property data (array)
Changed items (object Account)
Changed property openCycleInformation (object CycleInformation)
Added property cycleDueDate (string)
GET /issuers/{issuerId}/contracts/{contractReference}/accounts
Response:
Changed property data (array)
Changed items (object Account)
Changed property openCycleInformation (object CycleInformation)
Added property cycleDueDate (string)
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/accounts
Response:
Changed property data (array)
Changed items (object Account)
Changed property openCycleInformation (object CycleInformation)
Added property cycleDueDate (string)
GET /issuers/{issuerId}/customers/{customerReference}/accounts
Response:
Changed property data (array)
Changed items (object Account)
Changed property openCycleInformation (object CycleInformation)
Added property cycleDueDate (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/contract
Response:
Changed property data (object Contract)
Changed property accounts (array)
Changed items (object Account)
Changed property openCycleInformation (object CycleInformation)
Added property cycleDueDate (string)
GET /issuers/{issuerId}/accounts/{accountReference}/contract
Response:
Changed property data (object Contract)
Changed property accounts (array)
Changed items (object Account)
Changed property openCycleInformation (object CycleInformation)
Added property cycleDueDate (string)
GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/contract
Response:
Changed property data (object Contract)
Changed property accounts (array)
Changed items (object Account)
Changed property openCycleInformation (object CycleInformation)
Added property cycleDueDate (string)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}/contract
Response:
Changed property data (object Contract)
Changed property accounts (array)
Changed items (object Account)
Changed property openCycleInformation (object CycleInformation)
Added property cycleDueDate (string)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/{accountReference}
Response:
Changed property data (object CorporateEmployeeAccount)
Changed property account (object Account)
Changed property openCycleInformation (object CycleInformation)
Added property cycleDueDate (string)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Response:
Changed property data (object CorporateEmployeeAccount)
Changed property account (object Account)
Changed property openCycleInformation (object CycleInformation)
Added property cycleDueDate (string)
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Response:
Changed property data (object CorporateEmployeeAccount)
Changed property account (object Account)
Changed property openCycleInformation (object CycleInformation)
Added property cycleDueDate (string)
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/{accountReference}
Response:
Changed property data (object CorporateEmployeeAccount)
Changed property account (object Account)
Changed property openCycleInformation (object CycleInformation)
Added property cycleDueDate (string)
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}
Response:
Changed property data (object Contract)
Changed property accounts (array)
Changed items (object Account)
Changed property openCycleInformation (object CycleInformation)
Added property cycleDueDate (string)
GET /issuers/{issuerId}/contracts/{contractReference}
Response:
Changed property data (object Contract)
Changed property accounts (array)
Changed items (object Account)
Changed property openCycleInformation (object CycleInformation)
Added property cycleDueDate (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/corporate-contract
Response:
Changed property data (object CorporateContract)
Changed property rootAccount (object Account)
Changed property openCycleInformation (object CycleInformation)
Added property cycleDueDate (string)
GET /issuers/{issuerId}/accounts/{accountReference}/corporate-contract
Response:
Changed property data (object CorporateContract)
Changed property rootAccount (object Account)
Changed property openCycleInformation (object CycleInformation)
Added property cycleDueDate (string)
GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/corporate-contract
Response:
Changed property data (object CorporateContract)
Changed property rootAccount (object Account)
Changed property openCycleInformation (object CycleInformation)
Added property cycleDueDate (string)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}/corporate-contract
Response:
Changed property data (object CorporateContract)
Changed property rootAccount (object Account)
Changed property openCycleInformation (object CycleInformation)
Added property cycleDueDate (string)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}
Response:
Changed property data (object CorporateContract)
Changed property rootAccount (object Account)
Changed property openCycleInformation (object CycleInformation)
Added property cycleDueDate (string)
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}
Response:
Changed property data (object CorporateContract)
Changed property rootAccount (object Account)
Changed property openCycleInformation (object CycleInformation)
Added property cycleDueDate (string)
POST /search-contracts
Response:
Changed property data (array)
Changed items (object Contract)
Changed property accounts (array)
Changed items (object Account)
Changed property openCycleInformation (object CycleInformation)
Added property cycleDueDate (string)
POST /issuers/{issuerId}/contracts/search
Response:
Changed property data (array)
Changed items (object Contract)
Changed property accounts (array)
Changed items (object Account)
Changed property openCycleInformation (object CycleInformation)
Added property cycleDueDate (string)
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contracts
Response:
Changed property data (array)
Changed items (object Contract)
Changed property accounts (array)
Changed items (object Account)
Changed property openCycleInformation (object CycleInformation)
Added property cycleDueDate (string)
GET /issuers/{issuerId}/customers/{customerReference}/contracts
Response:
Changed property data (array)
Changed items (object Contract)
Changed property accounts (array)
Changed items (object Account)
Changed property openCycleInformation (object CycleInformation)
Added property cycleDueDate (string)
GET /issuers/{issuerId}/companies/{customerReference}/corporate-contracts
Response:
Changed property data (array)
Changed items (object CorporateContract)
Changed property rootAccount (object Account)
Changed property openCycleInformation (object CycleInformation)
Added property cycleDueDate (string)
GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/corporate-contracts
Response:
Changed property data (array)
Changed items (object CorporateContract)
Changed property rootAccount (object Account)
Changed property openCycleInformation (object CycleInformation)
Added property cycleDueDate (string)
POST /search-corporate-contracts
Request body :
Changed property contractCompany (object GlobalSearchCorporateContractRequest.Company)
New optional properties:
corporateName
Added property customerIdentifier (object)
Response:
Changed property data (array)
Changed items (object CorporateContract)
Changed property rootAccount (object Account)
Changed property openCycleInformation (object CycleInformation)
Added property cycleDueDate (string)
.
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/create-mandate
Response:
New required properties:
responseMetadata
Added property responseMetadata (object)
Added property data (object)
Deleted property accountIdentifier (object)
Deleted property sepaMandateStatus (string)
Deleted property sepaMandateUir (string)
Deleted property sepaMandateUmr (string)
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/cancel-mandate
Response:
New required properties:
responseMetadata
Added property responseMetadata (object)
Added property data (object)
Deleted property accountIdentifier (object)
Deleted property sepaMandateStatus (string)
Deleted property sepaMandateUir (string)
Deleted property sepaMandateUmr (string)
POST /issuers/{issuerId}/accounts/{accountReference}/create-mandate
Response:
New required properties:
responseMetadata
Added property responseMetadata (object)
Added property data (object)
Deleted property accountIdentifier (object)
Deleted property sepaMandateStatus (string)
Deleted property sepaMandateUir (string)
Deleted property sepaMandateUmr (string)
POST /issuers/{issuerId}/accounts/{accountReference}/cancel-mandate
Response:
New required properties:
responseMetadata
Added property responseMetadata (object)
Added property data (object)
Deleted property accountIdentifier (object)
Deleted property sepaMandateStatus (string)
Deleted property sepaMandateUir (string)
Deleted property sepaMandateUmr (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations
Parameters:
Added: excludeOperationKinds in query
GET /issuers/{issuerId}/accounts/{accountReference}/operations
Parameters:
Added: excludeOperationKinds in query
.
GET /info
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/cards/{cardReference}/letters/{letterId}
Parameters:
Added: WL-Username in header
DELETE /issuers/{issuerId}/cards/{cardReference}/letters/{letterId}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/letters/{letterId}
Parameters:
Added: WL-Username in header
DELETE /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/letters/{letterId}
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/cards/{cardReference}/letters/{letterId}/validate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/letters/{letterId}/validate
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/balance
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/credit-limit
Parameters:
Added: WL-Username in header
PUT /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/credit-limit
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-balance-adjustment-operation
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-fee-operation
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/reset-balance
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-payment-operation
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-reimbursement-operation
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-load-operation
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-unload-operation
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/reverse-balance-adjustment-operation
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/reverse-fee-operation
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/reverse-payment-operation
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/last/reprint
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/{cycleClosureDate}/reprint
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/create-mandate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/cancel-mandate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-interest-operation
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/reverse-interest-operation
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-bonus-operation
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/reverse-bonus-operation
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/{accountReference}/account-future-updates/{futureChangeReference}/cancel
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates/{futureChangeReference}/cancel
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/{accountReference}/balance
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/{accountReference}/credit-limit
Parameters:
Added: WL-Username in header
PUT /issuers/{issuerId}/accounts/{accountReference}/credit-limit
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/{accountReference}/post-balance-adjustment-operation
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/{accountReference}/post-fee-operation
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/{accountReference}/reset-balance
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/{accountReference}/post-payment-operation
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/{accountReference}/post-reimbursement-operation
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/{accountReference}/post-load-operation
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/{accountReference}/post-unload-operation
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/{accountReference}/reverse-balance-adjustment-operation
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/{accountReference}/reverse-fee-operation
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/{accountReference}/reverse-payment-operation
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/{accountReference}/statements/last/reprint
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/{accountReference}/statements/{cycleClosureDate}/reprint
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/{accountReference}/create-mandate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/{accountReference}/cancel-mandate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/{accountReference}/post-interest-operation
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/{accountReference}/reverse-interest-operation
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/{accountReference}/post-bonus-operation
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/{accountReference}/reverse-bonus-operation
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/companies/{customerReference}/addresses/{addressReference}/activate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/activate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/companies/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/activate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/activate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/companies/{customerReference}/addresses/{addressReference}/deactivate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/deactivate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/companies/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/deactivate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/deactivate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/activate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/deactivate
Parameters:
Added: WL-Username in header
PATCH /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-contract-entities/{companyEntityExternalReference}
Parameters:
Added: WL-Username in header
PATCH /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-contract-entities/{companyEntityExternalReference}
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders/{orderReference}/release
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/remind-pin
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/unblock
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/cards/{cardReference}/activate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/cards/{cardReference}/deactivate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/cards/declare-counterfeit-card
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/cards/{cardReference}/orders/{orderReference}/release
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/cards/{cardReference}/remind-pin
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/cards/{cardReference}/unblock
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/cards/{cardReference}/advise-product-extension
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/advise-product-extension
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/contracts/advise-product-extension
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/addon-subscriptions/unsubscribe
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/cancel-close
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/cancel-suspend
Parameters:
Added: WL-Username in header
PUT /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/legitimacy-documents/external-customers/{issuerCustomerExternalReference}
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/contracts/{contractReference}/addon-subscriptions/unsubscribe
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/contracts/{contractReference}/cancel-close
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/contracts/{contractReference}/cancel-suspend
Parameters:
Added: WL-Username in header
PUT /issuers/{issuerId}/contracts/{contractReference}/legitimacy-documents/{customerReference}
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/contracts/{contractReference}/refund-fee-on-demand
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/refund-fee-on-demand
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/corporate-contracts/{contractReference}/refund-fee-on-demand
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/addon-subscriptions/unsubscribe
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/corporate-contracts/{contractReference}/addon-subscriptions/unsubscribe
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/refund-fee-on-demand
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/corporate-contracts/{contractReference}/cancel-change-paying-account
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/cancel-change-paying-account
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/credit-transfers
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/credit-transfers/{endToEndId}/cancel
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/invalidate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/invalidate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/invalidate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/invalidate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/activate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/deactivate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/activate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/deactivate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/activate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/deactivate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/activate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/deactivate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/direct-debits
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/direct-debits/{endToEndId}/cancel
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/cards/{cardReference}/create-emergency-card
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/create-emergency-card
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/disputes/{disputeFolderReference}/postings
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/disputes/external-disputes/{issuerDisputeExternalReference}/postings
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/disputes/{disputeFolderReference}/events
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/disputes/external-disputes/{issuerDisputeExternalReference}/events
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/disputes/{disputeFolderReference}/documents
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/disputes/external-disputes/{issuerDisputeExternalReference}/documents
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/disputes/{disputeFolderReference}/generate-chargeback
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/disputes/external-disputes/{issuerDisputeExternalReference}/generate-chargeback
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/companies/{customerReference}/contacts
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/contacts
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/customers/{customerReference}/contacts
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contacts
Parameters:
Added: WL-Username in header
PUT /issuers/{issuerId}/customers/{customerReference}/contacts/{contactReference}
Parameters:
Added: WL-Username in header
DELETE /issuers/{issuerId}/customers/{customerReference}/contacts/{contactReference}
Parameters:
Added: WL-Username in header
PUT /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contacts/{contactReference}
Parameters:
Added: WL-Username in header
DELETE /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contacts/{contactReference}
Parameters:
Added: WL-Username in header
PUT /issuers/{issuerId}/companies/{customerReference}/contacts/{contactReference}
Parameters:
Added: WL-Username in header
DELETE /issuers/{issuerId}/companies/{customerReference}/contacts/{contactReference}
Parameters:
Added: WL-Username in header
PUT /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/contacts/{contactReference}
Parameters:
Added: WL-Username in header
DELETE /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/contacts/{contactReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/transactions/{transactionId}
Parameters:
Added: WL-Username in header
DELETE /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/address-versions/{addressVersionReference}
Parameters:
Added: WL-Username in header
DELETE /issuers/{issuerId}/customers/{customerReference}/external-addresses/{issuerAddressExternalReference}/address-versions/{addressVersionReference}
Parameters:
Added: WL-Username in header
DELETE /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/address-versions/{addressVersionReference}
Parameters:
Added: WL-Username in header
DELETE /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/external-addresses/{issuerAddressExternalReference}/address-versions/{addressVersionReference}
Parameters:
Added: WL-Username in header
GET /issuers
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/cards/letter-templates/{letterTemplateReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates/{futureChangeReference}
Parameters:
Added: WL-Username in header
PATCH /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates/{futureChangeReference}
Parameters:
Added: WL-Username in header
DELETE /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/insurance-contracts/{insurancePackageReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/insurance-contracts/{insurancePackageReference}
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/insurance-contracts/{insurancePackageReference}/insurance-events
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations/{operationId}
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/cancel-delinquency
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/turnover-information
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/turnovers
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/last
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/next
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/{cycleClosureDate}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/temporary-credit-limits
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/temporary-credit-limits
Parameters:
Added: WL-Username in header
DELETE /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/temporary-credit-limits/{temporaryCreditLimitReference}
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/inquire-operation
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/{accountReference}/account-future-updates/{futureChangeReference}
Parameters:
Added: WL-Username in header
PATCH /issuers/{issuerId}/accounts/{accountReference}/account-future-updates/{futureChangeReference}
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/{accountReference}/cancel-delinquency
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/{accountReference}/turnover-information
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/{accountReference}/turnovers
Parameters:
Added: WL-Username in header
DELETE /issuers/{issuerId}/accounts/{accountReference}/insurance-contracts/{insurancePackageReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/{accountReference}/insurance-contracts/{insurancePackageReference}
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/{accountReference}/insurance-contracts/{insurancePackageReference}/insurance-events
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/{accountReference}/operations/{operationId}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/{accountReference}/statements/last
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/{accountReference}/statements/next
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/{accountReference}/statements/{cycleClosureDate}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/{accountReference}/temporary-credit-limits
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/{accountReference}/temporary-credit-limits
Parameters:
Added: WL-Username in header
DELETE /issuers/{issuerId}/accounts/{accountReference}/temporary-credit-limits/{temporaryCreditLimitReference}
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/{accountReference}/inquire-operation
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/companies/{customerReference}/company-history
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/company-history
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/companies/{customerReference}/addresses/{addressReference}/address-usages
Parameters:
Added: WL-Username in header
DELETE /issuers/{issuerId}/companies/{customerReference}/addresses/{addressReference}/address-usages
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/address-usages
Parameters:
Added: WL-Username in header
DELETE /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/address-usages
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/companies/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages
Parameters:
Added: WL-Username in header
DELETE /issuers/{issuerId}/companies/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages
Parameters:
Added: WL-Username in header
DELETE /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/close
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/card-contracts/{cardContractReference}/cancel-close
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cancel-close
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/card-contracts/{cardContractReference}/close
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/cards/block-all
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/block
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/corporate-contracts/{contractReference}/close
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/close
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/new-tan
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders/{orderReference}
Parameters:
Added: WL-Username in header
Response:
Changed property data (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/reorder-pin
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/cards/unblock-all
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/cards/{cardReference}/block
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/cards/{cardReference}/orders/{orderReference}
Parameters:
Added: WL-Username in header
Response:
Changed property data (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
POST /issuers/{issuerId}/cards/{cardReference}/release-orders
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/release-orders
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/cards/{cardReference}/reorder-pin
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/cards/{cardReference}/blocking-information
Parameters:
Added: WL-Username in header
PATCH /issuers/{issuerId}/cards/{cardReference}/blocking-information
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/blocking-information
Parameters:
Added: WL-Username in header
PATCH /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/blocking-information
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/cards/update-all-blocking-information
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/contracts/brand-advice
Parameters:
Added: WL-Username in header
PATCH /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/contract-fees/{accountReference}
Parameters:
Added: WL-Username in header
PATCH /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/contract-fees/external-accounts/{issuerAccountExternalReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/legitimacy-documents
Parameters:
Added: WL-Username in header
PATCH /issuers/{issuerId}/contracts/{contractReference}/contract-fees/{accountReference}
Parameters:
Added: WL-Username in header
PATCH /issuers/{issuerId}/contracts/{contractReference}/contract-fees/external-accounts/{issuerAccountExternalReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/contracts/{contractReference}/legitimacy-documents
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/contracts/{contractReference}/cancel-product-change
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/cancel-product-change
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/credit-transfers/{endToEndId}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}
Parameters:
Added: WL-Username in header
PUT /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages
Parameters:
Added: WL-Username in header
DELETE /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}
Parameters:
Added: WL-Username in header
PUT /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/address-usages
Parameters:
Added: WL-Username in header
DELETE /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/address-usages
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}
Parameters:
Added: WL-Username in header
PUT /issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages
Parameters:
Added: WL-Username in header
DELETE /issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}
Parameters:
Added: WL-Username in header
PUT /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/address-usages
Parameters:
Added: WL-Username in header
DELETE /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/address-usages
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/direct-debits/{endToEndId}
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/operations/{externalOperationReference}/disputes
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/disputes/{disputeFolderReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/operations/{externalOperationReference}/dispute
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/disputes/external-disputes/{issuerDisputeExternalReference}
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/cards/{cardReference}/new-tan
Parameters:
Added: WL-Username in header
POST /search-transactions
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/card-products/{cardTemplateReference}/card-producer-balancing
Parameters:
Added: WL-Username in header
PATCH /issuers/{issuerId}/card-products/{cardTemplateReference}/card-producer-balancing
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/super-folders
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/cards/{cardReference}/create-vts-tokenized-card
Request body :
Deleted property city (string)
Deleted property line1 (string)
Deleted property line2 (string)
Deleted property postalCode (string)
Deleted property state (string)
GET /issuers/{issuerId}/cards/letter-templates
Parameters:
Added: WL-Username in header
PATCH /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-guarantor
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-history
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-owner
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/credit-transfers
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/direct-debits
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/insurance-contracts
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/insurance-contracts
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/last/operations
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/next/operations
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/{cycleClosureDate}/operations
Parameters:
Added: WL-Username in header
PATCH /issuers/{issuerId}/accounts/{accountReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/{accountReference}
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/{accountReference}/account-future-updates
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/{accountReference}/account-future-updates
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/{accountReference}/account-guarantor
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/{accountReference}/account-history
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/{accountReference}/account-owner
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/{accountReference}/credit-transfers
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/{accountReference}/direct-debits
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/accounts/{accountReference}/insurance-contracts
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/{accountReference}/insurance-contracts
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/{accountReference}/operations
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/{accountReference}/statements
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/{accountReference}/statements/last/operations
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/{accountReference}/statements/next/operations
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/{accountReference}/statements/{cycleClosureDate}/operations
Parameters:
Added: WL-Username in header
PUT /issuers/{issuerId}/companies/{customerReference}
Parameters:
Added: WL-Username in header
PATCH /issuers/{issuerId}/companies/{customerReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/companies/{customerReference}
Parameters:
Added: WL-Username in header
PUT /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}
Parameters:
Added: WL-Username in header
PATCH /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/companies/{customerReference}/addresses
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/companies/{customerReference}/addresses
Parameters:
Added: WL-Username in header
PUT /issuers/{issuerId}/companies/{customerReference}/addresses/{addressReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/companies/{customerReference}/addresses/{addressReference}
Parameters:
Added: WL-Username in header
PUT /issuers/{issuerId}/companies/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/companies/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses
Parameters:
Added: WL-Username in header
PUT /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}
Parameters:
Added: WL-Username in header
PUT /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cardholder
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/card-contracts/{cardContractReference}/cardholder
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}
Parameters:
Added: WL-Username in header
Response:
Changed property data (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/card-events
Parameters:
Added: WL-Username in header
PATCH /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-contract-entity/{companyEntityExternalReference}
Parameters:
Added: WL-Username in header
PATCH /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-contract-entity/{companyEntityExternalReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders
Parameters:
Added: WL-Username in header
Response:
Changed property data (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
GET /issuers/{issuerId}/cards/{cardReference}
Parameters:
Added: WL-Username in header
Response:
Changed property data (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
GET /issuers/{issuerId}/cards/{cardReference}/card-events
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/cards/{cardReference}/orders
Parameters:
Added: WL-Username in header
Response:
Changed property data (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
POST /search-operations
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/contracts/brand-advice-config/{issuerProductExternalReference}
Parameters:
Added: WL-Username in header
PATCH /issuers/{issuerId}/contracts/brand-advice-config/{issuerProductExternalReference}
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/addon-subscriptions
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/addon-subscriptions
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/contract-fees
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/contract-owner
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/contracts/{contractReference}/addon-subscriptions
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/contracts/{contractReference}/addon-subscriptions
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/contracts/{contractReference}/contract-fees
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/contracts/{contractReference}/contract-owner
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/addon-subscriptions
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/addon-subscriptions
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/corporate-contracts/{contractReference}/addon-subscriptions
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/corporate-contracts/{contractReference}/addon-subscriptions
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/corporate-contracts/{contractReference}/change-paying-account
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/change-paying-account
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/corporate-contracts/{contractReference}/contract-owner
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/contract-owner
Parameters:
Added: WL-Username in header
PUT /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}
Parameters:
Added: WL-Username in header
PATCH /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/customer-history
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses
Parameters:
Added: WL-Username in header
PUT /issuers/{issuerId}/customers/{customerReference}
Parameters:
Added: WL-Username in header
PATCH /issuers/{issuerId}/customers/{customerReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/customers/{customerReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/customers/{customerReference}/customer-history
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/customers/{customerReference}/addresses-and-subscriptions
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses-and-subscriptions
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/customers/{customerReference}/addresses
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/customers/{customerReference}/addresses
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/cards/{cardReference}/disputes
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/disputes
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/corporate-contracts/{contractReference}/card-contracts/{cardContractReference}/reallocate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/card-contracts/{cardContractReference}/reallocate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/corporate-contracts/{contractReference}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/reallocate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/reallocate
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/contracts/{contractReference}/replace-customer
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/replace-customer
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/address-versions
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/customers/{customerReference}/external-addresses/{issuerAddressExternalReference}/address-versions
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/address-versions
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/external-addresses/{issuerAddressExternalReference}/address-versions
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/products/external-products/{issuerProductExternalReference}/product-extension-balancing
Parameters:
Added: WL-Username in header
PATCH /issuers/{issuerId}/products/external-products/{issuerProductExternalReference}/product-extension-balancing
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/cards/{cardReference}/generate-letter
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/generate-letter
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/cards/{cardReference}/prefilled-letter-templates/{letterTemplateReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/prefilled-letter-templates/{letterTemplateReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/companies
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/companies
Parameters:
Added: WL-Username in header
PATCH /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}
Parameters:
Added: WL-Username in header
Request body :
Added property clickToPayEnrollment (string)
GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}
Parameters:
Added: WL-Username in header
Response:
Changed property data (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cards
Parameters:
Added: WL-Username in header
Response:
Changed property data (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
PATCH /issuers/{issuerId}/card-contracts/{cardContractReference}
Parameters:
Added: WL-Username in header
Request body :
Added property clickToPayEnrollment (string)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}
Parameters:
Added: WL-Username in header
Response:
Changed property data (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}/cards
Parameters:
Added: WL-Username in header
Response:
Changed property data (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/block-and-replace
Parameters:
Added: WL-Username in header
Request body :
Changed property replaceCardRequest (object ReplaceCardRequest)
Changed property cardContract (object ReplaceCardRequest.CardContract)
Added property clickToPayEnrollment (string)
GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/card-contract
Parameters:
Added: WL-Username in header
Response:
Changed property data (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
POST /issuers/{issuerId}/corporate-contracts/{contractReference}/add-corporate-contract-entity
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/add-corporate-contract-entity
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/corporate-contracts/{contractReference}/add-virtual-cards-accounts-service
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/add-virtual-cards-accounts-service
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/replace
Parameters:
Added: WL-Username in header
Request body :
Changed property cardContract (object ReplaceCardRequest.CardContract)
Added property clickToPayEnrollment (string)
POST /issuers/{issuerId}/cards/search
Parameters:
Added: WL-Username in header
Response:
Changed property data (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
POST /issuers/{issuerId}/cards/{cardReference}/block-and-replace
Parameters:
Added: WL-Username in header
Request body :
Changed property replaceCardRequest (object ReplaceCardRequest)
Changed property cardContract (object ReplaceCardRequest.CardContract)
Added property clickToPayEnrollment (string)
GET /issuers/{issuerId}/cards/{cardReference}/card-contract
Parameters:
Added: WL-Username in header
Response:
Changed property data (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
POST /issuers/{issuerId}/cards/{cardReference}/replace
Parameters:
Added: WL-Username in header
Request body :
Changed property cardContract (object ReplaceCardRequest.CardContract)
Added property clickToPayEnrollment (string)
POST /issuers/{issuerId}/contracts/create-consumer-contract
Parameters:
Added: WL-Username in header
Request body :
Changed property addCardsAccounts (object CreateConsumerContractRequest.AddCardsAccounts)
Changed property cardContracts (array)
Changed items (object CreateConsumerContractRequest.CardContract)
Added property clickToPayEnrollment (string)
POST /issuers/{issuerId}/contracts/{contractReference}/sign
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/sign
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/accounts
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/add-cards-accounts
Parameters:
Added: WL-Username in header
Request body :
Changed property cardContracts (array)
Changed items (object CreateConsumerContractRequest.CardContract)
Added property clickToPayEnrollment (string)
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/close
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/update-all-customers-addresses
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/suspend
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/contracts/{contractReference}/accounts
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/contracts/{contractReference}/add-cards-accounts
Parameters:
Added: WL-Username in header
Request body :
Changed property cardContracts (array)
Changed items (object CreateConsumerContractRequest.CardContract)
Added property clickToPayEnrollment (string)
POST /issuers/{issuerId}/contracts/{contractReference}/close
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/contracts/{contractReference}/update-all-customers-addresses
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/contracts/{contractReference}/suspend
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/contracts/{contractReference}/switch-principal-card
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/switch-principal-card
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/customers
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/customers
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/accounts
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/customers/{customerReference}/accounts
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/contract
Parameters:
Added: WL-Username in header
Response:
Changed property data (object Contract)
Changed property cardContracts (array)
Changed items (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
GET /issuers/{issuerId}/accounts/{accountReference}/contract
Parameters:
Added: WL-Username in header
Response:
Changed property data (object Contract)
Changed property cardContracts (array)
Changed items (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
GET /issuers/{issuerId}/card-contracts/
Parameters:
Added: WL-Username in header
Response:
Changed property data (array)
Changed items (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/contract
Parameters:
Added: WL-Username in header
Response:
Changed property data (object Contract)
Changed property cardContracts (array)
Changed items (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}/contract
Parameters:
Added: WL-Username in header
Response:
Changed property data (object Contract)
Changed property cardContracts (array)
Changed items (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
PATCH /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/{accountReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/{accountReference}
Parameters:
Added: WL-Username in header
Response:
Changed property data (object CorporateEmployeeAccount)
Changed property cardContracts (array)
Changed items (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
PATCH /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Parameters:
Added: WL-Username in header
Response:
Changed property data (object CorporateEmployeeAccount)
Changed property cardContracts (array)
Changed items (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
PATCH /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Parameters:
Added: WL-Username in header
Response:
Changed property data (object CorporateEmployeeAccount)
Changed property cardContracts (array)
Changed items (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
PATCH /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/{accountReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/{accountReference}
Parameters:
Added: WL-Username in header
Response:
Changed property data (object CorporateEmployeeAccount)
Changed property cardContracts (array)
Changed items (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
POST /issuers/{issuerId}/corporate-contracts/{contractReference}/add-corporate-employee-cards-accounts
Parameters:
Added: WL-Username in header
Request body :
Changed property addCorporateEmployeeCardsAndAccounts (object CreateCorporateContractRequest.AddCorporateEmployeeCardsAndAccounts)
Changed property corporateEmployeeCards (array)
Changed items (object CreateCorporateContractRequest.CorporateEmployeeCard)
Changed property cardContract (object CreateCorporateContractRequest.CardContract)
Added property clickToPayEnrollment (string)
POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/add-corporate-employee-cards-accounts
Parameters:
Added: WL-Username in header
Request body :
Changed property addCorporateEmployeeCardsAndAccounts (object CreateCorporateContractRequest.AddCorporateEmployeeCardsAndAccounts)
Changed property corporateEmployeeCards (array)
Changed items (object CreateCorporateContractRequest.CorporateEmployeeCard)
Changed property cardContract (object CreateCorporateContractRequest.CardContract)
Added property clickToPayEnrollment (string)
PATCH /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}
Parameters:
Added: WL-Username in header
Response:
Changed property data (object Contract)
Changed property cardContracts (array)
Changed items (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/card-contracts
Parameters:
Added: WL-Username in header
Response:
Changed property data (array)
Changed items (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
PATCH /issuers/{issuerId}/contracts/{contractReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/contracts/{contractReference}
Parameters:
Added: WL-Username in header
Response:
Changed property data (object Contract)
Changed property cardContracts (array)
Changed items (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
GET /issuers/{issuerId}/contracts/{contractReference}/card-contracts
Parameters:
Added: WL-Username in header
Response:
Changed property data (array)
Changed items (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
POST /issuers/{issuerId}/contracts/{contractReference}/change-product
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/change-product
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/contracts/{contractReference}/force-product-change
Parameters:
Added: WL-Username in header
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/force-product-change
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/card-contracts
Parameters:
Added: WL-Username in header
Response:
Changed property data (array)
Changed items (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
GET /issuers/{issuerId}/customers/{customerReference}/card-contracts
Parameters:
Added: WL-Username in header
Response:
Changed property data (array)
Changed items (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/corporate-contract
Parameters:
Added: WL-Username in header
Response:
Changed property data (object CorporateContract)
Changed property corporateEmployeeAccounts (array)
Changed items (object CorporateEmployeeAccount)
Changed property cardContracts (array)
Changed items (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
GET /issuers/{issuerId}/accounts/{accountReference}/corporate-contract
Parameters:
Added: WL-Username in header
Response:
Changed property data (object CorporateContract)
Changed property corporateEmployeeAccounts (array)
Changed items (object CorporateEmployeeAccount)
Changed property cardContracts (array)
Changed items (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/corporate-contract
Parameters:
Added: WL-Username in header
Response:
Changed property data (object CorporateContract)
Changed property corporateEmployeeAccounts (array)
Changed items (object CorporateEmployeeAccount)
Changed property cardContracts (array)
Changed items (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}/corporate-contract
Parameters:
Added: WL-Username in header
Response:
Changed property data (object CorporateContract)
Changed property corporateEmployeeAccounts (array)
Changed items (object CorporateEmployeeAccount)
Changed property cardContracts (array)
Changed items (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
PATCH /issuers/{issuerId}/corporate-contracts/{contractReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/corporate-contracts/{contractReference}
Parameters:
Added: WL-Username in header
Response:
Changed property data (object CorporateContract)
Changed property corporateEmployeeAccounts (array)
Changed items (object CorporateEmployeeAccount)
Changed property cardContracts (array)
Changed items (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
PATCH /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}
Parameters:
Added: WL-Username in header
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}
Parameters:
Added: WL-Username in header
Response:
Changed property data (object CorporateContract)
Changed property corporateEmployeeAccounts (array)
Changed items (object CorporateEmployeeAccount)
Changed property cardContracts (array)
Changed items (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
POST /issuers/{issuerId}/corporate-contracts/create-corporate-contract
Parameters:
Added: WL-Username in header
Request body :
Changed property addCorporateEmployeeCardsAndAccounts (array)
Changed items (object CreateCorporateContractRequest.AddCorporateEmployeeCardsAndAccounts)
Changed property corporateEmployeeCards (array)
Changed items (object CreateCorporateContractRequest.CorporateEmployeeCard)
Changed property cardContract (object CreateCorporateContractRequest.CardContract)
Added property clickToPayEnrollment (string)
POST /search-contracts
Parameters:
Added: WL-Username in header
Response:
Changed property data (array)
Changed items (object Contract)
Changed property cardContracts (array)
Changed items (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
POST /issuers/{issuerId}/contracts/search
Parameters:
Added: WL-Username in header
Response:
Changed property data (array)
Changed items (object Contract)
Changed property cardContracts (array)
Changed items (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contracts
Parameters:
Added: WL-Username in header
Response:
Changed property data (array)
Changed items (object Contract)
Changed property cardContracts (array)
Changed items (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
GET /issuers/{issuerId}/customers/{customerReference}/contracts
Parameters:
Added: WL-Username in header
Response:
Changed property data (array)
Changed items (object Contract)
Changed property cardContracts (array)
Changed items (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
GET /issuers/{issuerId}/companies/{customerReference}/corporate-contracts
Parameters:
Added: WL-Username in header
Response:
Changed property data (array)
Changed items (object CorporateContract)
Changed property corporateEmployeeAccounts (array)
Changed items (object CorporateEmployeeAccount)
Changed property cardContracts (array)
Changed items (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/corporate-contracts
Parameters:
Added: WL-Username in header
Response:
Changed property data (array)
Changed items (object CorporateContract)
Changed property corporateEmployeeAccounts (array)
Changed items (object CorporateEmployeeAccount)
Changed property cardContracts (array)
Changed items (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
POST /search-corporate-contracts
Parameters:
Added: WL-Username in header
Response:
Changed property data (array)
Changed items (object CorporateContract)
Changed property corporateEmployeeAccounts (array)
Changed items (object CorporateEmployeeAccount)
Changed property cardContracts (array)
Changed items (object CardContract)
Added property clickToPayEnrollment (string)
Changed property cards (array)
Changed items (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
Changed property orders (array)
Changed items (object Order)
Changed property card (object Card)
Changed property cardContract (object CardContract)
Added property clickToPayEnrollment (string)
What's Deprecated
POST /issuers/{issuerId}/vts-apple-push-data
Issuer service aimed to generate data specific elements for push provisioning with ApplePay (MBPAD, MBPAC)
POST /issuers/{issuerId}/vts-mobile-banking-auth-code
Issuer service aimed to generate data specific elements for app to app provisioning (MBAAC)
POST /issuers/{issuerId}/vts-payment-instrument-details
Issuer service aimed to generate data specific elements for push provisioning for VTS
API version 2.31.0
REST API V2 - 2.31.0
Version 2.30.1 to 2.31.0
What's New
GET /issuers/{issuerId}/companies/{customerReference}/company-history
Retrieve list of historic updates of a company (beta)
The API allows the company update history of a company to be retrieved. The main input fields requested by the API are: • The issuer ID • The customer for which information is requested : It can be provided by using the customer reference or the issuer customer external reference (as company). A start date and an end date can be provided in order to limit the search of the history. In response, the interface provides a list of changes with the effective date of the update.
GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/company-history
Retrieve list of historic updates of a company by customer external reference (beta)
The API allows the company update history of a company to be retrieved. The main input fields requested by the API are: • The issuer ID • The customer for which information is requested : It can be provided by using the customer reference or the issuer customer external reference (as company). A start date and an end date can be provided in order to limit the search of the history. In response, the interface provides a list of changes with the effective date of the update.
POST /issuers/{issuerId}/cards/{cardReference}/release-orders
Release card orders for a card (beta)
The API allows orders (card order, PIN mailer order, TAN mailer order) related to a card to be released in case a bank validation is required (before starting the embossing process). The bank validation must be configured in the card creation model corresponding to the order reason (in renewal model for renewal treatment…).
The main input fields requested by the API are: o The issuer ID o The card for which the orders release is requested: It can be provided by using the card reference or the issuer external card reference
As a result, the orders related to the requested card are orderable.
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/release-orders
Release card orders for a card by external reference (beta)
The API allows orders (card order, PIN mailer order, TAN mailer order) related to a card to be released in case a bank validation is required (before starting the embossing process). The bank validation must be configured in the card creation model corresponding to the order reason (in renewal model for renewal treatment…).
The main input fields requested by the API are: o The issuer ID o The card for which the orders release is requested: It can be provided by using the card reference or the issuer external card reference
As a result, the orders related to the requested card are orderable.
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/customer-history
Retrieve list of historic updates of a customer by customer external reference (beta)
The API allows the customer update history of a customer to be retrieved. The main input fields requested by the API are: • The issuer ID • The customer for which information is requested : It can be provided by using the customer reference or the issuer customer external reference. A start date and an end date can be provided in order to limit the search of the history. In response, the interface provides a list of changes with the effective date of the update.
GET /issuers/{issuerId}/customers/{customerReference}/customer-history
Retrieve list of historic updates of a customer (beta)
The API allows the customer update history of a customer to be retrieved. The main input fields requested by the API are: • The issuer ID • The customer for which information is requested : It can be provided by using the customer reference or the issuer customer external reference. A start date and an end date can be provided in order to limit the search of the history. In response, the interface provides a list of changes with the effective date of the update.
POST /issuers/{issuerId}/cards/display-pin
Display PIN for a card by PAN + PSN and/or expiry date
POST /issuers/{issuerId}/cards/pin
Set a PIN for a card by PAN + PSN and/or expiry date
POST /issuers/{issuerId}/super-folders
Create a super folder (beta)
This API allows the creation of a super folder from a list of dispute folders. The main input fields are: • The issuer ID • The list of dispute folder identifiers to be attached to the super folder : The dispute folder references must exist in our system and be associated to the same PAN. The issuer can provide the name of the super folder to be created.
As a result, the super folder is created with its own reference calculated by our system.
The API response returns: • The super folder reference • The name of the super folder if provided in the request
What's Changed
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/contract-fees
Response:
Changed property data (array)
Changed items (object ContractFee)
Added property membershipFeeAnniversaryDate (string)
GET /issuers/{issuerId}/contracts/{contractReference}/contract-fees
Response:
Changed property data (array)
Changed items (object ContractFee)
Added property membershipFeeAnniversaryDate (string)
POST /issuers/{issuerId}/contracts/{contractReference}/replace-customer
Request body :
Changed property targetCustomer (object ReplaceCustomerInContractRequest.TargetCustomer)
Changed property newCustomer (object ReplaceCustomerInContractRequest.Customer)
Added property correspondenceName (string)
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/replace-customer
Request body :
Changed property targetCustomer (object ReplaceCustomerInContractRequest.TargetCustomer)
Changed property newCustomer (object ReplaceCustomerInContractRequest.Customer)
Added property correspondenceName (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/contract
Response:
Changed property data (object Contract)
Changed property contractFees (array)
Changed items (object ContractFee)
Added property membershipFeeAnniversaryDate (string)
GET /issuers/{issuerId}/accounts/{accountReference}/contract
Response:
Changed property data (object Contract)
Changed property contractFees (array)
Changed items (object ContractFee)
Added property membershipFeeAnniversaryDate (string)
GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/contract
Response:
Changed property data (object Contract)
Changed property contractFees (array)
Changed items (object ContractFee)
Added property membershipFeeAnniversaryDate (string)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}/contract
Response:
Changed property data (object Contract)
Changed property contractFees (array)
Changed items (object ContractFee)
Added property membershipFeeAnniversaryDate (string)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/{accountReference}
Response:
Changed property data (object CorporateEmployeeAccount)
Changed property contractFee (object ContractFee)
Added property membershipFeeAnniversaryDate (string)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Response:
Changed property data (object CorporateEmployeeAccount)
Changed property contractFee (object ContractFee)
Added property membershipFeeAnniversaryDate (string)
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Response:
Changed property data (object CorporateEmployeeAccount)
Changed property contractFee (object ContractFee)
Added property membershipFeeAnniversaryDate (string)
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/{accountReference}
Response:
Changed property data (object CorporateEmployeeAccount)
Changed property contractFee (object ContractFee)
Added property membershipFeeAnniversaryDate (string)
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}
Response:
Changed property data (object Contract)
Changed property contractFees (array)
Changed items (object ContractFee)
Added property membershipFeeAnniversaryDate (string)
GET /issuers/{issuerId}/contracts/{contractReference}
Response:
Changed property data (object Contract)
Changed property contractFees (array)
Changed items (object ContractFee)
Added property membershipFeeAnniversaryDate (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/corporate-contract
Response:
Changed property data (object CorporateContract)
Changed property corporateEmployeeAccounts (array)
Changed items (object CorporateEmployeeAccount)
Changed property contractFee (object ContractFee)
Added property membershipFeeAnniversaryDate (string)
GET /issuers/{issuerId}/accounts/{accountReference}/corporate-contract
Response:
Changed property data (object CorporateContract)
Changed property corporateEmployeeAccounts (array)
Changed items (object CorporateEmployeeAccount)
Changed property contractFee (object ContractFee)
Added property membershipFeeAnniversaryDate (string)
GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/corporate-contract
Response:
Changed property data (object CorporateContract)
Changed property corporateEmployeeAccounts (array)
Changed items (object CorporateEmployeeAccount)
Changed property contractFee (object ContractFee)
Added property membershipFeeAnniversaryDate (string)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}/corporate-contract
Response:
Changed property data (object CorporateContract)
Changed property corporateEmployeeAccounts (array)
Changed items (object CorporateEmployeeAccount)
Changed property contractFee (object ContractFee)
Added property membershipFeeAnniversaryDate (string)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}
Response:
Changed property data (object CorporateContract)
Changed property corporateEmployeeAccounts (array)
Changed items (object CorporateEmployeeAccount)
Changed property contractFee (object ContractFee)
Added property membershipFeeAnniversaryDate (string)
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}
Response:
Changed property data (object CorporateContract)
Changed property corporateEmployeeAccounts (array)
Changed items (object CorporateEmployeeAccount)
Changed property contractFee (object ContractFee)
Added property membershipFeeAnniversaryDate (string)
POST /search-contracts
Response:
Changed property data (array)
Changed items (object Contract)
Changed property contractFees (array)
Changed items (object ContractFee)
Added property membershipFeeAnniversaryDate (string)
POST /issuers/{issuerId}/contracts/search
Response:
Changed property data (array)
Changed items (object Contract)
Changed property contractFees (array)
Changed items (object ContractFee)
Added property membershipFeeAnniversaryDate (string)
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contracts
Response:
Changed property data (array)
Changed items (object Contract)
Changed property contractFees (array)
Changed items (object ContractFee)
Added property membershipFeeAnniversaryDate (string)
GET /issuers/{issuerId}/customers/{customerReference}/contracts
Response:
Changed property data (array)
Changed items (object Contract)
Changed property contractFees (array)
Changed items (object ContractFee)
Added property membershipFeeAnniversaryDate (string)
GET /issuers/{issuerId}/companies/{customerReference}/corporate-contracts
Response:
Changed property data (array)
Changed items (object CorporateContract)
Changed property corporateEmployeeAccounts (array)
Changed items (object CorporateEmployeeAccount)
Changed property contractFee (object ContractFee)
Added property membershipFeeAnniversaryDate (string)
GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/corporate-contracts
Response:
Changed property data (array)
Changed items (object CorporateContract)
Changed property corporateEmployeeAccounts (array)
Changed items (object CorporateEmployeeAccount)
Changed property contractFee (object ContractFee)
Added property membershipFeeAnniversaryDate (string)
POST /search-corporate-contracts
Response:
Changed property data (array)
Changed items (object CorporateContract)
Changed property corporateEmployeeAccounts (array)
Changed items (object CorporateEmployeeAccount)
Changed property contractFee (object ContractFee)
Added property membershipFeeAnniversaryDate (string)
.
PATCH /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-contract-entities/{companyEntityExternalReference}
Response:
Changed property data (object ModifyCorporateContractEntityResponse)
New required properties:
companyEntityExternalReference
contractIdentifier
PATCH /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-contract-entities/{companyEntityExternalReference}
Response:
Changed property data (object ModifyCorporateContractEntityResponse)
New required properties:
companyEntityExternalReference
contractIdentifier
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/remind-pin
Request body :
Changed property customDeliveryAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
POST /issuers/{issuerId}/cards/{cardReference}/remind-pin
Request body :
Changed property customDeliveryAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
POST /issuers/{issuerId}/companies/{customerReference}/contacts
Request body :
Changed property postalAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Response:
Changed property data (object CreateContactResponse)
Changed property contactIdentifier (string -> object)
POST /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/contacts
Request body :
Changed property postalAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Response:
Changed property data (object CreateContactResponse)
Changed property contactIdentifier (string -> object)
POST /issuers/{issuerId}/customers/{customerReference}/contacts
Request body :
Changed property postalAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Response:
Changed property data (object CreateContactResponse)
Changed property contactIdentifier (string -> object)
POST /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contacts
Request body :
Changed property postalAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Response:
Changed property data (object CreateContactResponse)
Changed property contactIdentifier (string -> object)
PUT /issuers/{issuerId}/customers/{customerReference}/contacts/{contactReference}
Request body :
Changed property postalAddress (object ModifyAddressRequest.MailAddress)
Added property courtesyTitle (string)
Response:
Changed property data (object ModifyContactResponse)
Changed property contactIdentifier (string -> object)
DELETE /issuers/{issuerId}/customers/{customerReference}/contacts/{contactReference}
Response:
Changed property data (object DeleteContactResponse)
Changed property contactIdentifier (string -> object)
PUT /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contacts/{contactReference}
Request body :
Changed property postalAddress (object ModifyAddressRequest.MailAddress)
Added property courtesyTitle (string)
Response:
Changed property data (object ModifyContactResponse)
Changed property contactIdentifier (string -> object)
DELETE /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contacts/{contactReference}
Response:
Changed property data (object DeleteContactResponse)
Changed property contactIdentifier (string -> object)
PUT /issuers/{issuerId}/companies/{customerReference}/contacts/{contactReference}
Request body :
Changed property postalAddress (object ModifyAddressRequest.MailAddress)
Added property courtesyTitle (string)
Response:
Changed property data (object ModifyContactResponse)
Changed property contactIdentifier (string -> object)
DELETE /issuers/{issuerId}/companies/{customerReference}/contacts/{contactReference}
Response:
Changed property data (object DeleteContactResponse)
Changed property contactIdentifier (string -> object)
PUT /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/contacts/{contactReference}
Request body :
Changed property postalAddress (object ModifyAddressRequest.MailAddress)
Added property courtesyTitle (string)
Response:
Changed property data (object ModifyContactResponse)
Changed property contactIdentifier (string -> object)
DELETE /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/contacts/{contactReference}
Response:
Changed property data (object DeleteContactResponse)
Changed property contactIdentifier (string -> object)
GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders/{orderReference}
Response:
Changed property data (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
Changed property card (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/reorder-pin
Request body :
Changed property customDeliveryAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
GET /issuers/{issuerId}/cards/{cardReference}/orders/{orderReference}
Response:
Changed property data (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
Changed property card (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
POST /issuers/{issuerId}/cards/{cardReference}/reorder-pin
Request body :
Changed property customDeliveryAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}
Response:
Changed property data (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
PUT /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}
Request body :
Changed property postalAddress (object ModifyAddressRequest.MailAddress)
Added property courtesyTitle (string)
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}
Response:
Changed property data (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
PUT /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}
Request body :
Changed property postalAddress (object ModifyAddressRequest.MailAddress)
Added property courtesyTitle (string)
GET /issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}
Response:
Changed property data (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
PUT /issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}
Request body :
Changed property postalAddress (object ModifyAddressRequest.MailAddress)
Added property courtesyTitle (string)
GET /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}
Response:
Changed property data (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
PUT /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}
Request body :
Changed property postalAddress (object ModifyAddressRequest.MailAddress)
Added property courtesyTitle (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-guarantor
Response:
Changed property data (object ContractMember)
New optional properties:
offlineRiskCategory
onlineRiskCategory
Added property customer (object)
Added property company (object)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-owner
Response:
Changed property data (object ContractMember)
New optional properties:
offlineRiskCategory
onlineRiskCategory
Added property customer (object)
Added property company (object)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/accounts/{accountReference}/account-guarantor
Response:
Changed property data (object ContractMember)
New optional properties:
offlineRiskCategory
onlineRiskCategory
Added property customer (object)
Added property company (object)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/accounts/{accountReference}/account-owner
Response:
Changed property data (object ContractMember)
New optional properties:
offlineRiskCategory
onlineRiskCategory
Added property customer (object)
Added property company (object)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
PUT /issuers/{issuerId}/companies/{customerReference}
Request body :
Changed property contacts (array)
Changed items (object ModifyCompanyRequestContact)
Changed property postalAddress (object ModifyAddressRequest.MailAddress)
Added property courtesyTitle (string)
PATCH /issuers/{issuerId}/companies/{customerReference}
Request body :
Changed property contacts (array)
Changed items (object ModifyCompanyRequestContact)
Changed property postalAddress (object ModifyAddressRequest.MailAddress)
Added property courtesyTitle (string)
GET /issuers/{issuerId}/companies/{customerReference}
Response:
Changed property data (object Company)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
PUT /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}
Request body :
Changed property contacts (array)
Changed items (object ModifyCompanyRequestContact)
Changed property postalAddress (object ModifyAddressRequest.MailAddress)
Added property courtesyTitle (string)
PATCH /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}
Request body :
Changed property contacts (array)
Changed items (object ModifyCompanyRequestContact)
Changed property postalAddress (object ModifyAddressRequest.MailAddress)
Added property courtesyTitle (string)
GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}
Response:
Changed property data (object Company)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/companies/{customerReference}/addresses
Response:
Changed property data (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
PUT /issuers/{issuerId}/companies/{customerReference}/addresses/{addressReference}
Request body :
Changed property postalAddress (object ModifyAddressRequest.MailAddress)
Added property courtesyTitle (string)
GET /issuers/{issuerId}/companies/{customerReference}/addresses/{addressReference}
Response:
Changed property data (object Company)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
PUT /issuers/{issuerId}/companies/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}
Request body :
Changed property postalAddress (object ModifyAddressRequest.MailAddress)
Added property courtesyTitle (string)
GET /issuers/{issuerId}/companies/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}
Response:
Changed property data (object Company)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses
Response:
Changed property data (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
PUT /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}
Request body :
Changed property postalAddress (object ModifyAddressRequest.MailAddress)
Added property courtesyTitle (string)
GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}
Response:
Changed property data (object Company)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
PUT /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}
Request body :
Changed property postalAddress (object ModifyAddressRequest.MailAddress)
Added property courtesyTitle (string)
GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}
Response:
Changed property data (object Company)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cardholder
Response:
Changed property data (object Customer)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}/cardholder
Response:
Changed property data (object Customer)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}
Response:
Changed property data (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders
Response:
Changed property data (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/cards/{cardReference}
Response:
Changed property data (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/cards/{cardReference}/orders
Response:
Changed property data (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/contract-owner
Response:
Changed property data (object Customer)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/contracts/{contractReference}/contract-owner
Response:
Changed property data (object Customer)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}/contract-owner
Response:
Changed property data (object ContractMember)
New optional properties:
offlineRiskCategory
onlineRiskCategory
Added property customer (object)
Added property company (object)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/contract-owner
Response:
Changed property data (object ContractMember)
New optional properties:
offlineRiskCategory
onlineRiskCategory
Added property customer (object)
Added property company (object)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
PUT /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}
Request body :
Changed property contacts (array)
Changed items (object ModifyCustomerRequestContact)
Changed property postalAddress (object ModifyAddressRequest.MailAddress)
Added property courtesyTitle (string)
PATCH /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}
Request body :
Changed property contacts (array)
Changed items (object ModifyCustomerRequestContact)
Changed property postalAddress (object ModifyAddressRequest.MailAddress)
Added property courtesyTitle (string)
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}
Response:
Changed property data (object Customer)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses
Response:
Changed property data (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
PUT /issuers/{issuerId}/customers/{customerReference}
Request body :
Changed property contacts (array)
Changed items (object ModifyCustomerRequestContact)
Changed property postalAddress (object ModifyAddressRequest.MailAddress)
Added property courtesyTitle (string)
PATCH /issuers/{issuerId}/customers/{customerReference}
Request body :
Changed property contacts (array)
Changed items (object ModifyCustomerRequestContact)
Changed property postalAddress (object ModifyAddressRequest.MailAddress)
Added property courtesyTitle (string)
GET /issuers/{issuerId}/customers/{customerReference}
Response:
Changed property data (object Customer)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
POST /issuers/{issuerId}/customers/{customerReference}/addresses-and-subscriptions
Response:
Changed property data (object CreateAddressAndSubscriptionResponse)
New required properties:
createAddOnSubscriptionResponse
createAddressResponse
Added property createAddressResponse (object)
Added property createAddOnSubscriptionResponse (object)
Deleted property addressIdentifier (object)
POST /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses-and-subscriptions
Response:
Changed property data (object CreateAddressAndSubscriptionResponse)
New required properties:
createAddOnSubscriptionResponse
createAddressResponse
Added property createAddressResponse (object)
Added property createAddOnSubscriptionResponse (object)
Deleted property addressIdentifier (object)
GET /issuers/{issuerId}/customers/{customerReference}/addresses
Response:
Changed property data (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
POST /issuers/{issuerId}/contracts/{contractReference}/replace-customer
Request body :
Changed property targetCustomer (object ReplaceCustomerInContractRequest.TargetCustomer)
Changed property newCustomer (object ReplaceCustomerInContractRequest.Customer)
Changed property addresses (array)
Changed items (object ReplaceCustomerInContractRequest.Address)
Changed property postalAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/replace-customer
Request body :
Changed property targetCustomer (object ReplaceCustomerInContractRequest.TargetCustomer)
Changed property newCustomer (object ReplaceCustomerInContractRequest.Customer)
Changed property addresses (array)
Changed items (object ReplaceCustomerInContractRequest.Address)
Changed property postalAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
GET /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/address-versions
Response:
Changed property data (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/customers/{customerReference}/external-addresses/{issuerAddressExternalReference}/address-versions
Response:
Changed property data (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/address-versions
Response:
Changed property data (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/external-addresses/{issuerAddressExternalReference}/address-versions
Response:
Changed property data (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
POST /issuers/{issuerId}/companies
Parameters:
Added: embed in query
Request body :
Changed property contacts (array)
Changed items (object CreateContactRequest)
Changed property postalAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object CreateConsumerContractRequest.Address)
Changed property postalAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Response:
Changed property data (object CreateCompanyResponse)
Added property company (object)
GET /issuers/{issuerId}/companies
Response:
Changed property data (array)
Changed items (object Company)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}
Response:
Changed property data (object CardContract)
Changed property cards (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cards
Response:
Changed property data (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}
Response:
Changed property data (object CardContract)
Changed property cards (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}/cards
Response:
Changed property data (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/block-and-replace
Request body :
Changed property replaceCardRequest (object ReplaceCardRequest)
Changed property cardContract (object ReplaceCardRequest.CardContract)
Changed property card (object ReplaceCardRequest.CardContract.Card)
Changed property cardOrder (object ReplaceCardRequest.CardOrder)
Changed property customDeliveryAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Changed property pinMailerOrder (object ReplaceCardRequest.PinMailerOrder)
Changed property customDeliveryAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Changed property cardHolder (object ModifyCustomerRequest)
Changed property contacts (array)
Changed items (object ModifyCustomerRequestContact)
Changed property postalAddress (object ModifyAddressRequest.MailAddress)
Added property courtesyTitle (string)
GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/card-contract
Response:
Changed property data (object CardContract)
Changed property cards (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
POST /issuers/{issuerId}/corporate-contracts/{contractReference}/add-corporate-contract-entity
Request body :
Changed property customers (array)
Changed items (object CreateCorporateContractRequest.Customer)
Changed property addresses (array)
Changed items (object CreateCorporateContractRequest.Address)
Changed property postalAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Changed property companies (array)
Changed items (object CreateCorporateContractRequest.Company)
Changed property contacts (array)
Changed items (object CreateCorporateContractRequest.Contact)
Changed property postalAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Changed property addCorporateContractEntity (object CreateCorporateContractRequest.AddCorporateContractEntity)
Changed property corporateContractEntityAccounts (array)
Changed items (object CreateCorporateContractRequest.CorporateContractEntityAccount)
Changed property account (object CreateCorporateContractRequest.Account)
Changed property sepaMandate (object CreateCorporateContractRequest.SepaMandate)
Changed property debtorPostalAddress (object SepaMandateMailAddress)
New required properties:
country
POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/add-corporate-contract-entity
Request body :
Changed property customers (array)
Changed items (object CreateCorporateContractRequest.Customer)
Changed property addresses (array)
Changed items (object CreateCorporateContractRequest.Address)
Changed property postalAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Changed property companies (array)
Changed items (object CreateCorporateContractRequest.Company)
Changed property contacts (array)
Changed items (object CreateCorporateContractRequest.Contact)
Changed property postalAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Changed property addCorporateContractEntity (object CreateCorporateContractRequest.AddCorporateContractEntity)
Changed property corporateContractEntityAccounts (array)
Changed items (object CreateCorporateContractRequest.CorporateContractEntityAccount)
Changed property account (object CreateCorporateContractRequest.Account)
Changed property sepaMandate (object CreateCorporateContractRequest.SepaMandate)
Changed property debtorPostalAddress (object SepaMandateMailAddress)
New required properties:
country
POST /issuers/{issuerId}/corporate-contracts/{contractReference}/add-virtual-cards-accounts-service
Request body :
Changed property customers (array)
Changed items (object CreateCorporateContractRequest.Customer)
Changed property addresses (array)
Changed items (object CreateCorporateContractRequest.Address)
Changed property postalAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/add-virtual-cards-accounts-service
Request body :
Changed property customers (array)
Changed items (object CreateCorporateContractRequest.Customer)
Changed property addresses (array)
Changed items (object CreateCorporateContractRequest.Address)
Changed property postalAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/replace
Request body :
Changed property cardContract (object ReplaceCardRequest.CardContract)
Changed property card (object ReplaceCardRequest.CardContract.Card)
Changed property cardOrder (object ReplaceCardRequest.CardOrder)
Changed property customDeliveryAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Changed property pinMailerOrder (object ReplaceCardRequest.PinMailerOrder)
Changed property customDeliveryAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Changed property cardHolder (object ModifyCustomerRequest)
Changed property contacts (array)
Changed items (object ModifyCustomerRequestContact)
Changed property postalAddress (object ModifyAddressRequest.MailAddress)
Added property courtesyTitle (string)
POST /issuers/{issuerId}/cards/search
Response:
Changed property data (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
POST /issuers/{issuerId}/cards/{cardReference}/block-and-replace
Request body :
Changed property replaceCardRequest (object ReplaceCardRequest)
Changed property cardContract (object ReplaceCardRequest.CardContract)
Changed property card (object ReplaceCardRequest.CardContract.Card)
Changed property cardOrder (object ReplaceCardRequest.CardOrder)
Changed property customDeliveryAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Changed property pinMailerOrder (object ReplaceCardRequest.PinMailerOrder)
Changed property customDeliveryAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Changed property cardHolder (object ModifyCustomerRequest)
Changed property contacts (array)
Changed items (object ModifyCustomerRequestContact)
Changed property postalAddress (object ModifyAddressRequest.MailAddress)
Added property courtesyTitle (string)
GET /issuers/{issuerId}/cards/{cardReference}/card-contract
Response:
Changed property data (object CardContract)
Changed property cards (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
POST /issuers/{issuerId}/cards/{cardReference}/replace
Request body :
Changed property cardContract (object ReplaceCardRequest.CardContract)
Changed property card (object ReplaceCardRequest.CardContract.Card)
Changed property cardOrder (object ReplaceCardRequest.CardOrder)
Changed property customDeliveryAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Changed property pinMailerOrder (object ReplaceCardRequest.PinMailerOrder)
Changed property customDeliveryAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Changed property cardHolder (object ModifyCustomerRequest)
Changed property contacts (array)
Changed items (object ModifyCustomerRequestContact)
Changed property postalAddress (object ModifyAddressRequest.MailAddress)
Added property courtesyTitle (string)
POST /issuers/{issuerId}/contracts/create-consumer-contract
Request body :
Changed property customers (array)
Changed items (object CreateConsumerContractRequest.Customer)
Changed property contacts (array)
Changed items (object CreateConsumerContractRequest.Contact)
Changed property postalAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object CreateConsumerContractRequest.Address)
Changed property postalAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Changed property addCardsAccounts (object CreateConsumerContractRequest.AddCardsAccounts)
Changed property cardContracts (array)
Changed items (object CreateConsumerContractRequest.CardContract)
Changed property card (object CreateConsumerContractRequest.Card)
Changed property cardOrder (object CreateConsumerContractRequest.CardOrder)
Changed property customDeliveryAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Changed property pinMailerOrder (object CreateConsumerContractRequest.PinMailerOrder)
Changed property customDeliveryAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/add-cards-accounts
Request body :
Changed property customers (array)
Changed items (object CreateConsumerContractRequest.Customer)
Changed property contacts (array)
Changed items (object CreateConsumerContractRequest.Contact)
Changed property postalAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object CreateConsumerContractRequest.Address)
Changed property postalAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Changed property cardContracts (array)
Changed items (object CreateConsumerContractRequest.CardContract)
Changed property card (object CreateConsumerContractRequest.Card)
Changed property cardOrder (object CreateConsumerContractRequest.CardOrder)
Changed property customDeliveryAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Changed property pinMailerOrder (object CreateConsumerContractRequest.PinMailerOrder)
Changed property customDeliveryAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/update-all-customers-addresses
Request body :
Changed property addresses (array)
Changed items (object ModifyContractCustomersAddressesRequest.Address)
Changed property postalAddress (object ModifyAddressRequest.MailAddress)
Added property courtesyTitle (string)
POST /issuers/{issuerId}/contracts/{contractReference}/add-cards-accounts
Request body :
Changed property customers (array)
Changed items (object CreateConsumerContractRequest.Customer)
Changed property contacts (array)
Changed items (object CreateConsumerContractRequest.Contact)
Changed property postalAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object CreateConsumerContractRequest.Address)
Changed property postalAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Changed property cardContracts (array)
Changed items (object CreateConsumerContractRequest.CardContract)
Changed property card (object CreateConsumerContractRequest.Card)
Changed property cardOrder (object CreateConsumerContractRequest.CardOrder)
Changed property customDeliveryAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Changed property pinMailerOrder (object CreateConsumerContractRequest.PinMailerOrder)
Changed property customDeliveryAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
POST /issuers/{issuerId}/contracts/{contractReference}/update-all-customers-addresses
Request body :
Changed property addresses (array)
Changed items (object ModifyContractCustomersAddressesRequest.Address)
Changed property postalAddress (object ModifyAddressRequest.MailAddress)
Added property courtesyTitle (string)
GET /issuers/{issuerId}/customers
Response:
Changed property data (array)
Changed items (object Customer)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
POST /issuers/{issuerId}/customers
Request body :
New optional properties:
onlineRiskCategory
Changed property contacts (array)
Changed items (object CreateContactRequest)
Changed property postalAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object CreateCustomerRequest.Address)
Changed property postalAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Response:
Changed property data (object CreateCustomerResponse)
Changed property customer (object Customer)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/contract
Response:
Changed property data (object Contract)
Changed property contractCustomers (array)
Changed items (object Customer)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
Changed property cardContracts (array)
Changed items (object CardContract)
Changed property cards (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/accounts/{accountReference}/contract
Response:
Changed property data (object Contract)
Changed property contractCustomers (array)
Changed items (object Customer)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
Changed property cardContracts (array)
Changed items (object CardContract)
Changed property cards (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/card-contracts/
Response:
Changed property data (array)
Changed items (object CardContract)
Changed property cards (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/contract
Response:
Changed property data (object Contract)
Changed property contractCustomers (array)
Changed items (object Customer)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
Changed property cardContracts (array)
Changed items (object CardContract)
Changed property cards (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}/contract
Response:
Changed property data (object Contract)
Changed property contractCustomers (array)
Changed items (object Customer)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
Changed property cardContracts (array)
Changed items (object CardContract)
Changed property cards (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/{accountReference}
Response:
Changed property data (object CorporateEmployeeAccount)
Changed property customers (array)
Changed items (object Customer)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
Changed property cardContracts (array)
Changed items (object CardContract)
Changed property cards (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Response:
Changed property data (object CorporateEmployeeAccount)
Changed property customers (array)
Changed items (object Customer)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
Changed property cardContracts (array)
Changed items (object CardContract)
Changed property cards (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Response:
Changed property data (object CorporateEmployeeAccount)
Changed property customers (array)
Changed items (object Customer)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
Changed property cardContracts (array)
Changed items (object CardContract)
Changed property cards (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/{accountReference}
Response:
Changed property data (object CorporateEmployeeAccount)
Changed property customers (array)
Changed items (object Customer)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
Changed property cardContracts (array)
Changed items (object CardContract)
Changed property cards (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
POST /issuers/{issuerId}/corporate-contracts/{contractReference}/add-corporate-employee-cards-accounts
Request body :
Changed property customers (array)
Changed items (object CreateCorporateContractRequest.Customer)
Changed property addresses (array)
Changed items (object CreateCorporateContractRequest.Address)
Changed property postalAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Changed property addCorporateEmployeeCardsAndAccounts (object CreateCorporateContractRequest.AddCorporateEmployeeCardsAndAccounts)
Changed property corporateEmployeeAccounts (array)
Changed items (object CreateCorporateContractRequest.CorporateEmployeeAccount)
Changed property account (object CreateCorporateContractRequest.Account)
Changed property sepaMandate (object CreateCorporateContractRequest.SepaMandate)
Changed property debtorPostalAddress (object SepaMandateMailAddress)
New required properties:
country
POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/add-corporate-employee-cards-accounts
Request body :
Changed property customers (array)
Changed items (object CreateCorporateContractRequest.Customer)
Changed property addresses (array)
Changed items (object CreateCorporateContractRequest.Address)
Changed property postalAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Changed property addCorporateEmployeeCardsAndAccounts (object CreateCorporateContractRequest.AddCorporateEmployeeCardsAndAccounts)
Changed property corporateEmployeeAccounts (array)
Changed items (object CreateCorporateContractRequest.CorporateEmployeeAccount)
Changed property account (object CreateCorporateContractRequest.Account)
Changed property sepaMandate (object CreateCorporateContractRequest.SepaMandate)
Changed property debtorPostalAddress (object SepaMandateMailAddress)
New required properties:
country
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}
Response:
Changed property data (object Contract)
Changed property contractCustomers (array)
Changed items (object Customer)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
Changed property cardContracts (array)
Changed items (object CardContract)
Changed property cards (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
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)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/contracts/{contractReference}
Response:
Changed property data (object Contract)
Changed property contractCustomers (array)
Changed items (object Customer)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
Changed property cardContracts (array)
Changed items (object CardContract)
Changed property cards (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/contracts/{contractReference}/card-contracts
Response:
Changed property data (array)
Changed items (object CardContract)
Changed property cards (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
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)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/customers/{customerReference}/card-contracts
Response:
Changed property data (array)
Changed items (object CardContract)
Changed property cards (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/corporate-contract
Response:
Changed property data (object CorporateContract)
Changed property contractCustomers (array)
Changed items (object Customer)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
Changed property corporateEmployeeAccounts (array)
Changed items (object CorporateEmployeeAccount)
Changed property cardContracts (array)
Changed items (object CardContract)
Changed property cards (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/accounts/{accountReference}/corporate-contract
Response:
Changed property data (object CorporateContract)
Changed property contractCustomers (array)
Changed items (object Customer)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
Changed property corporateEmployeeAccounts (array)
Changed items (object CorporateEmployeeAccount)
Changed property cardContracts (array)
Changed items (object CardContract)
Changed property cards (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/corporate-contract
Response:
Changed property data (object CorporateContract)
Changed property contractCustomers (array)
Changed items (object Customer)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
Changed property corporateEmployeeAccounts (array)
Changed items (object CorporateEmployeeAccount)
Changed property cardContracts (array)
Changed items (object CardContract)
Changed property cards (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}/corporate-contract
Response:
Changed property data (object CorporateContract)
Changed property contractCustomers (array)
Changed items (object Customer)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
Changed property corporateEmployeeAccounts (array)
Changed items (object CorporateEmployeeAccount)
Changed property cardContracts (array)
Changed items (object CardContract)
Changed property cards (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}
Response:
Changed property data (object CorporateContract)
Changed property contractCustomers (array)
Changed items (object Customer)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
Changed property corporateEmployeeAccounts (array)
Changed items (object CorporateEmployeeAccount)
Changed property cardContracts (array)
Changed items (object CardContract)
Changed property cards (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}
Response:
Changed property data (object CorporateContract)
Changed property contractCustomers (array)
Changed items (object Customer)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
Changed property corporateEmployeeAccounts (array)
Changed items (object CorporateEmployeeAccount)
Changed property cardContracts (array)
Changed items (object CardContract)
Changed property cards (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
POST /issuers/{issuerId}/corporate-contracts/create-corporate-contract
Request body :
Changed property customers (array)
Changed items (object CreateCorporateContractRequest.Customer)
Changed property addresses (array)
Changed items (object CreateCorporateContractRequest.Address)
Changed property postalAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Changed property companies (array)
Changed items (object CreateCorporateContractRequest.Company)
Changed property contacts (array)
Changed items (object CreateCorporateContractRequest.Contact)
Changed property postalAddress (object CreateAddressRequest.MailAddress)
Added property courtesyTitle (string)
Changed property corporateContract (object CreateCorporateContractRequest.Contract)
Changed property corporateContractRootEntity (object CreateCorporateContractRequest.CorporateContractRootEntity)
Changed property rootAccount (object CreateCorporateContractRequest.Account)
Changed property sepaMandate (object CreateCorporateContractRequest.SepaMandate)
Changed property debtorPostalAddress (object SepaMandateMailAddress)
New required properties:
country
POST /search-contracts
Response:
Changed property data (array)
Changed items (object Contract)
Changed property contractCustomers (array)
Changed items (object Customer)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
Changed property cardContracts (array)
Changed items (object CardContract)
Changed property cards (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
POST /issuers/{issuerId}/contracts/search
Response:
Changed property data (array)
Changed items (object Contract)
Changed property contractCustomers (array)
Changed items (object Customer)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
Changed property cardContracts (array)
Changed items (object CardContract)
Changed property cards (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contracts
Response:
Changed property data (array)
Changed items (object Contract)
Changed property contractCustomers (array)
Changed items (object Customer)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
Changed property cardContracts (array)
Changed items (object CardContract)
Changed property cards (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
GET /issuers/{issuerId}/customers/{customerReference}/contracts
Response:
Changed property data (array)
Changed items (object Contract)
Changed property contractCustomers (array)
Changed items (object Customer)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
Changed property cardContracts (array)
Changed items (object CardContract)
Changed property cards (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
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 contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
Changed property corporateEmployeeAccounts (array)
Changed items (object CorporateEmployeeAccount)
Changed property cardContracts (array)
Changed items (object CardContract)
Changed property cards (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
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 contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
Changed property corporateEmployeeAccounts (array)
Changed items (object CorporateEmployeeAccount)
Changed property cardContracts (array)
Changed items (object CardContract)
Changed property cards (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string)
POST /search-corporate-contracts
Response:
Changed property data (array)
Changed items (object CorporateContract)
Changed property contractCustomers (array)
Changed items (object Customer)
Changed property contacts (array)
Changed items (object Contact)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property addresses (array)
Changed items (object Address)
Changed property postalAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property phone (object PhoneNumber)
Added property internationalPhoneNumber (string)
Changed property corporateEmployeeAccounts (array)
Changed items (object CorporateEmployeeAccount)
Changed property cardContracts (array)
Changed items (object CardContract)
Changed property cards (array)
Changed items (object Card)
Changed property orders (array)
Changed items (object Order)
Changed property customDeliveryAddress (object MailAddress)
Added property countryName (string)
Added property courtesyTitle (string)
Changed property customDeliveryPhone (object PhoneNumber)
Added property internationalPhoneNumber (string).
What's Deprecated
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders/{orderReference}/release
Release a card order waiting for validation by external reference
POST /issuers/{issuerId}/cards/{cardReference}/orders/{orderReference}/release
Release a card order waiting for validation
Digital Signatures
In this section we cover the different ways digital signatures are used for Security in the Open Banking API. There are three main uses :
- Sending authorization requests
- This applies to all Initiating Parties sending requests to the Open Banking Service.
- Sending signed requests and responses (iDEAL 2.0 only)
- This only applies to certain Acquirers in the IDEAL 2.0 service. If not applicable, this section can be skipped.
- Receiving signed requests and responses (iDEAL 2.0 only)
- This refers to the Notification requests that the Initiating Party receives from the Open Banking Service.
- This only applies to certain Acquirers in the IDEAL 2.0 service. If not applicable, this section can be skipped.
Sending authorization requests
On the application level, the Initiating Party is authenticated and authorized by sending a digitally signed request to the POST /token endpoint (see Access Tokens - V1, or Access Tokens - V2). The signature validation allows the Open Banking Service to check the authenticity and integrity of the request.
This is achieved by applying the "Authorization" scheme as described in https://datatracker.ietf.org/doc/html/draft-cavage-http-signatures-12 and further detailed below.
The 'Authorization' field consists of the following elements, see also the examples below
- 'Signature keyId’ = The thumbprint of the public certificate of the Initiating Party, viewed with the SHA1 algorithm.
- 'algorithm' =
algorithm=”rsa-sha256”oralgorithm=”SHA256withRSA” - 'headers' = the headers ”app client id date” which are part of the signature, the sequence which they are placed here should also be used in the 'signature'
- 'signature' = The 'signature' is created with the private key associated with 'keyId' applying the chosen signature 'algorithm'. The string to sign is created by concatenating the lowercased 'headers' field names followed with an ASCII colon `:`, an ASCII space ` `, and the header field value. Leading and trailing optional whitespace (OWS) in the header field value MUST be omitted. If the value is not the last value, then an ASCII newline `\n` is appended. The 'signature' is then created with the private key associated with 'keyId' applying the chosen signature 'algorithm'.
Example: For the request
POST /authorize/token HTTP/1.1
App: IDEAL
Date: Fri, 25 Mar 2022 20:51:35 GMT
Client: idealClient
Id: 434The concatenated "String to sign" would be:
app: IDEAL
client: idealClient
id: 434
date: Fri, 25 Mar 2022 20:51:35 GMTThe complete 'Authorization' field looks like this:
Authorization: Signature keyId="DCAC7209573D506FC56095B8B23E8555A8F38B29", algorithm="SHA256withRSA", headers="app client id date", signature="guoLSHgl/zGRujqkDnmaWCL8kgCVnDazqkKu7nWU/uAHrS+M9eQsI8ueB4uWgxyPOnZps3vpNgkW1f4aBsdFYLS0jYeup4yhCMN6vis2zfMKxUhZFkjELslQkit9Gwc9pqvcyH0IxUnDLbCQwkiYjf6nGbP1YNfoxVXQpfq6i6CbIXCotLfwH2kbkrnSWwAS5skZY77+znmLDjtP3et2K94C36yPo0EEGqGkQ5xkD7owA7YxzA30xzsvkDvU3hzDzTK5wZmsgVsoyjRvMrokG0HrszUpNTwUtxflukcgs0pH7GuT+JrIpQ55f1dpzULqxeBggnCvD9DRSuKeTakqlw=="The Initiating Party must upload the used public certificate in the back office portal so that Open Banking Service is able to validate the signature. If the signature can be validated and the sender has a valid subscription, a response containing an access token is returned.
This access token can be used in all follow-up API requests until it expires. After expiration a new access token must be requested via the POST /token endpoint.
Sending signed requests and responses (iDEAL 2.0 only)
Signing requests and responses could be enforced depending on the Acquirer configuration.
Signing would impact the following cases:
- POST /payments API requests
- GET /payments/{paymentId}/status API requests
- GET /preferences/{id}/ API requests
- Notification API requests received by the Initiating Party
- Responses received by the Initiating Party
In this section, we will be looking into signing POST /payments requests and the responses from the Open Banking Service.
If signatures are enforced by the Initiating Party's Acquirer, the following fields will be mandatory in the API requests sent by the Initiating Party to the Open Banking Service:
- Signature
- Digest
The Signature
The digital signing should be done by the Initiating Party by applying the “Signature” scheme as described in https://datatracker.ietf.org/doc/html/draft-cavage-http-signatures-12.
This is equivalent to the “Authorization” scheme and the same procedure is followed to generate the signature and header parts but it uses the Signature field instead of the Authorization field.
In order to generate the signature string that is signed with a key, the Initiating Party must use the values of following HTTP header fields:
- Digest
- X-Request-ID
- MessageCreateDateTime
The headers used to generate the signature string also have to appear in the `headers` parameter of the Signature field, as shown below:
headers=”digest x-request-id messagecreatedatetime (request-target)”
To include the HTTP request target in the signature calculation, use the special `(request-target)` header field name. You can generate the header field value by concatenating the lowercased :method, an ASCII space, and the :path.
The (request-target) header field value to be used for the different APIs is:
| API | (request-target) header field value |
|---|---|
| POST /payments | post /xs2a/routingservice/services/ob/pis/v3/payments |
| GET /payments/{paymentId}/status | get /xs2a/routingservice/services/ob/pis/v3/payments/{paymentId}/status* |
| GET /preferences/{Psuid} | get /xs2a/routingservice/services/ob/pis/v3/preferences/{psuId}* |
*The placeholders {paymentId} and {psuId} must be substituted with the values as obtained within the respective flows.
The signature string is created by concatenating the lowercased header field names followed with an ASCII colon `:`, an ASCII space ` `, and the header field value. Leading and trailing optional whitespace (OWS) in the header field value MUST be omitted. If the value is not the last value, then an ASCII newline `\n` is appended.
Example: For the payment request with the following required headers
POST /payments HTTP/1.1
digest: SHA-256=B/O1sG0L8+bEAqWF3aMZn3I0rx5YVi8r5cM6JHlTW7Q=
x-request-id: 1aad5e0f-02d7-aefb-61e3-6f4d3322cf71
messagecreatedatetime: 2023-03-15T10:07:26.264ZThe concatenated "Signature String" would be:
digest: SHA-256=B/O1sG0L8+bEAqWF3aMZn3I0rx5YVi8r5cM6JHlTW7Q=
x-request-id: 1aad5e0f-02d7-aefb-61e3-6f4d3322cf71
messagecreatedatetime: 2023-03-15T10:07:26.264Z
(request-target): post /xs2a/routingservice/services/ob/pis/v3/paymentsThe resulting signature parameter of the Signature field would be:
signature="N7kFLMMi/2R5hCd1gdO+GYhS70DOLMl+n8hborf42nFuu0HFjreoqU70gvxFWzgTPaWjdmNYY/7sOAUAQWudsM61Vc536XmaOGrrSxOINlH9l9QBk31xZMlJBf/+1+GtPb1BR26PYBjxKDMbN9W7PEVZLCDoObSnVLkvKbkLRWl0U8a39mDkUBu70Jw8yWusDU0g1OVN+5YRfENPNtC2ZnVD80gxih4JoFV6f4WCcX4HXVl229veFNO5joNQyUc7qOkXUGN2g0omgN4iJxVGnzEJ9BCrNe+vK9T25LC0fwSp/W6A9dDfuHQzMZgDJZZKpaX0Gg34i68etmi5oLrM3A=="The algorithm parameter of the Signature field is:
algorithm=”rsa-sha256” or algorithm=”SHA256withRSA”
The ‘keyId’ parameter of the Signature field is the thumbprint of the used certificate, viewed with the SHA1 algorithm. The private key associated with `keyId` is used to generate a digital signature on the concatenated signature string applying the chosen algorithm. The complete Signature header looks then like this:
Signature: keyId="DCAC7209573D506FC56095B8B23E8555A8F38B29", algorithm="SHA256withRSA", headers="digest x-request-id messagecreatedatetime (request-target)", signature="N7kFLMMi/2R5hCd1gdO+GYhS70DOLMl+n8hborf42nFuu0HFjreoqU70gvxFWzgTPaWjdmNYY/7sOAUAQWudsM61Vc536XmaOGrrSxOINlH9l9QBk31xZMlJBf/+1+GtPb1BR26PYBjxKDMbN9W7PEVZLCDoObSnVLkvKbkLRWl0U8a39mDkUBu70Jw8yWusDU0g1OVN+5YRfENPNtC2ZnVD80gxih4JoFV6f4WCcX4HXVl229veFNO5joNQyUc7qOkXUGN2g0omgN4iJxVGnzEJ9BCrNe+vK9T25LC0fwSp/W6A9dDfuHQzMZgDJZZKpaX0Gg34i68etmi5oLrM3A=="In order for the Open Banking Service to validate the signature, the Initiating Party must upload the public certificate to the back office portal. Once the signature is confirmed and the iDEAL Subscription is authenticated, the Initiating Party will receive a successful response.
The Digest header
Calculate the Digest header as follows:
- Step1: Create a SHA-256 hash of the Payload
- Note-1: if the output is hex-encoded, please make sure to convert it to binary data (convert the hex-encoded string to a byte array)
- Note-2: payload formatting is important. If the Digest is generated by using an unformatted JSON payload, then please make sure that it matches with an unformatted request body used in the API request.
- Step 2: Base64-encode the SHA-256 hash
- Step 3: Prepend 'SHA-256=' to the resulting base64-encoded value
Example payload :
{"PaymentProduct":["IDEAL"],"CommonPaymentData":{"Amount":{"Type":"Fixed","Amount":"10.00","Currency":"EUR"},"RemittanceInformation":"Cookie","RemittanceInformationStructured":{"Reference":"iDEALpurchase21"}},"IDEALPayments":{"UseDebtorToken":false,"FlowType":"Standard"}}Step 1: The SHA-256 hash of this request body is: 0d426d36fca1659980b9e371b25e2f17281bb285a634290d3da04233249b56ca. (Note: this is a hex-encoded representation)
Step 2: The base64-encoded hash (Note: hex to base64 encoding): DUJtNvyhZZmAueNxsl4vFygbsoWmNCkNPaBCMySbVso=
Step 3: The Digest header value: SHA-256=DUJtNvyhZZmAueNxsl4vFygbsoWmNCkNPaBCMySbVso=
Receiving signed requests and responses (iDEAL 2.0 only)
Receiving signed requests and responses could be enforced depending on the Acquirer configuration. In the event the Acquirer enforces Signatures, the following headers will be present in the API requests and responses received by the Initiating Party:
- Signature
- Digest
The digital signing performed by the Open Banking Service is done by applying the same “Signature” scheme as described above.
A notification request or response from Open Banking Service to the Initiating Party may contain the following headers (Signature and Digest included in the example):
Headers: {Authorization=Bearer iDEAL2.0testnotificationtoken, X-Request-ID=7e04be55-f710-4660-8254-a48d0246d56b, MessageCreateDateTime=2024-01-30T17:03:52.111+01:00, Digest=SHA-256=9CfdR8v5UlVl8YHNnpbO4v6uB/1B0EtWGLtnP7t2iVs=, Signature=keyId="3EBEF6033C00730D9C6DA05165A3CAA1F31036FB",algorithm="rsa-sha256",headers="messagecreatedatetime x-request-id digest",signature="v+IzPw8RKwGD3GWgLyuy/4RbA25PVwJxpvzs8QbqfAGLUSvOLhEL9dpQwvZi05DDbC80Z+1H7Kdyh3DumXRdayY7XYnunA05tcirszq1fOmESP5S6iw0It9XoV5u/L8EPTgMvOXYECuDT+zVKDsB0PXRIyfT1p+kS1iKc7kckPvDycVGRYMyfXHATmcrlHY6lSjMuw7WMlBOUo9Ac+dU8AQeqWzpzFjMa2Nd5XZkhd1vyKeVqh5cmWapJ2tZDk4/FwDZnpH3Po9PWKXwX/s+UolR/vlIUcRw+avIhU7L6Qme7JDQDpZlcAgJfj/OpF8ZDlb6yfW32yFFzYnkMyGdYQ==", Content-Type=application/json}In order to ensure that the contents of the sent messages are correct and have not been altered during transmission or storage, the Initiating Party can validate the received signature. For the validation of the signature, the Initiating Party can use the public certificate of the Open Banking Service which can be downloaded from the back office portal.
The high-level steps that a Initiating Party needs to take in order to validate the Signatures are:
- Digest calculation (as Digest is a part of the Signature)
- Signature validation by re-creating the signature string
The above steps (1) and (2) are detailed below to describe the process behind signature validation.
These steps are by default followed if standard signature validation libraries are used by the Initiating Party.
Digest header calculation for Notification requests and API responses
To verify the digest header, calculate the value and ensure you receive the same value as what is in the header of the Request/Response from the Open Banking Service. This is demonstrated below using a Notification request body.
{"PaymentProductUsed":"IDEAL","CommonPaymentData":{"PaymentStatus":"Expired","PaymentId":"141110","AspspPaymentId":"0001115682120510","AspspId":"10002","DebtorInformation":{"Name":"Edsger Wybe Dijkstra - Callback","Agent":"ABNANL2AXXX","Account":{"SchemeName":"IBAN","Identification":"NL44RABO0123456789"}}}}Step 1 : The Open Banking Service always sends unformatted JSON payloads in the Requests/Reponses towards the Initiating Party. However, in case the Initiating Party sees a pretty-printed JSON object (e.g. by viewing logs via a tool), the payload should be converted to an unformatted JSON. All blank spaces should be removed unless they are part of the field value (Example: the debtor name has spaces which can remain).
Step 2 : Create a SHA 256 hash of this payload: b1219370189b7c7d67f64fd6f72168187343d639f3aeada8ea3a2b36e0fac297
Note that this string is hex encoded.
Step 3 : Convert this hex encoding to a base64 encoding : sSGTcBibfH1n9k/W9yFoGHND1jnzrq2o6jorNuD6wpc=
Step 4 : Finally prepend "SHA-256=" to the value. The final value is : SHA-256=sSGTcBibfH1n9k/W9yFoGHND1jnzrq2o6jorNuD6wpc=
This value should match the Digest as sent by the Open Banking Service.
Signature validation in Notification requests and API responses
The digital signing is done by the Open Banking Service by applying the “Signature” scheme as described in https://datatracker.ietf.org/doc/html/draft-cavage-http-signatures-12.
In order to verify the signature header, the Initiating Party should recreate the signature with the steps outlined below:
Re-create signature string
In order to generate the signature string that is signed with a key, the Initiating Party must use the values of HTTP header fields:
- MessageCreateDateTime
- X-Request-ID
- Digest
The headers used to generate the signature string also have to appear in the `headers` parameter of the Signature header, in the fixed order appearing below:
headers=”messagecreatedatetime x-request-id digest”
The signature string is created by concatenating the lowercased HTTP header field names followed with an ASCII colon `:`, an ASCII space ` `, and the HTTP header field value. Leading and trailing optional whitespace (OWS) in the HTTP header field value MUST be omitted. If the value is not the last value, then an ASCII newline `\n` is appended.
Example: For the notification request with the following required headers
POST /notification/status HTTP/1.1
Digest: SHA-256=9CfdR8v5UlVl8YHNnpbO4v6uB/1B0EtWGLtnP7t2iVs=
X-Request-ID: 7e04be55-f710-4660-8254-a48d0246d56b
MessageCreateDateTime: 2024-01-30T17:03:52.111+01:00The concatenated "Signature String" would be:
messagecreatedatetime: 2024-01-30T17:03:52.111+01:00
x-request-id: 7e04be55-f710-4660-8254-a48d0246d56b
digest: SHA-256=9CfdR8v5UlVl8YHNnpbO4v6uB/1B0EtWGLtnP7t2iVs=The string to verify is now defined and it can be validated using the public key of the Open Banking Service which can be downloaded from the Open Banking Service GUI.
Validate signature
The signature parameter of the Signature header sent by the Open Banking Service was:
Base64 encoded signature
signature="v+IzPw8RKwGD3GWgLyuy/4RbA25PVwJxpvzs8QbqfAGLUSvOLhEL9dpQwvZi05DDbC80Z+1H7Kdyh3DumXRdayY7XYnunA05tcirszq1fOmESP5S6iw0It9XoV5u/L8EPTgMvOXYECuDT+zVKDsB0PXRIyfT1p+kS1iKc7kckPvDycVGRYMyfXHATmcrlHY6lSjMuw7WMlBOUo9Ac+dU8AQeqWzpzFjMa2Nd5XZkhd1vyKeVqh5cmWapJ2tZDk4/FwDZnpH3Po9PWKXwX/s+UolR/vlIUcRw+avIhU7L6Qme7JDQDpZlcAgJfj/OpF8ZDlb6yfW32yFFzYnkMyGdYQ=="The signature algorithm used is also contained in the Signature header: algorithm=”SHA256withRSA”
In order to verify a signature, a server MUST:
- Re-create the signature string (see step above)
- Hash the signature string with SHA256
- Verify the signature with the public key of the Open Banking Service.
Notification Bearer Tokens
Notification Bearer Tokens are sent in the Authorization header of notifications sent from the Open Banking Service to the Initiating Party. Currently two Notification types exist:
- Status Notification requests
- Debtor token Callback requests
The Notification Bearer Token can be configured in the back office portal under a specific Subscription. Depending on the subscription one or more options exist:
- Static token
- OAuth Client Credentials (Basic Auth)
- OAuth Client Credentials (Query Parameters)
- OAuth Client Credentials (Form Body)
The 'Static token' does not have a set validity period.
When receiving the notification request, the Initiating Party should verify that the value of the Notification Bearer Token matches what was set in the Subscription to ensure that the request is sent by Worldline.
Access Token - Version 2
To interact with the Open Banking Service securely, you need to retrieve an access token. At the moment a version 2 token can only be used for the VOP service, in the future you will be able to use the same v2 token for multiple services. Via this API JSON Web Tokens (JWT) are granted by the Central Authentication Service, as specified by RFC 7253.
You can retrieve a version 2 token in 2 steps:
Step 1 - Get your Client Id/Secret
The Client Id and the secret will be provided to you by Worldline.
Step 2 - Retrieve an access token using Client Id/Secret
Endpoint : POST /token
Base URL: /realms/merchant-clients/protocol/openid-connect
The tables below explain which fields have to be filled when requesting a token with Client Id/Secret.
Request
| Header fields | Mult. | Type | Description |
| Content-Type | 1..1 | String | Must be filled with "application/x-www-form-urlencoded" If not provided, the Initiating Party can expect to come across the error "415, Unsupported Media Type". |
The URL encoded form fields to be provided in the body of the request can be found in the table below:
| Body fields | Mult. | Type | Description |
| grant_type | 1..1 | String | Must be filled with: client_credentials |
| client_id | 1..1 | String | The Id of the client. The value will be provided to you by Worldline. |
| client_secret | 1..1 | String | Must be filled with the secret. The secret will be provided to you by Worldline. |
| scope | 1..1 | String | The list of the services. At the moment only VOP is allowed. The Open Banking Service checks if you have a valid subscription for the requested service. |
Response
| Body fields | Mult. | Type | Description |
| access_token | 1..1 | String | Json Web Token to be used in further API calls. The contents of the access_token can be viewed by base64 decoding the text between the dots, or a tool like https://jwt.io/ can be used. |
| expires_in | 1..1 | Integer | Expiration time in seconds, relative to when the token was issued. The time the token was issued is stored within the access_token string. Name of the field is 'iat', which is filled with a unix timestamp |
| refresh_expires_in | 1..1 | Integer | There is no refresh supported for Initiating Party Access Tokens. The field will always be filled with: 0 |
| token_type | 1..1 | String | Type of the token. The field will always be filled with: Bearer |
| not-before-policy | 1..1 | Integer | Filled with a unix timestamp. The token cannot be used before this timestamp. This feature is not used at the moment, the token will be valid immediately. The field will be filled with: 0 |
| scope | 1..1 | String | The list of the services for which the token is valid, it's a space separated list. |
Upon a successful request, the Open Banking Service provides you with an access token, which must be used in all future API interactions. The access token allows the Open Banking Service to validate and authorize your API requests.
The Authorization header is constructed as follows:
Authorization: Bearer {access_token}The {access_token} part must be replaced by the value of access_token, for example:
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2l...qaVI-mQ3XeEqDcf4P3OrzMJBiQExample Post /token
Request
grant_type: "client_credentials"
client_id: "ExampleClient-000001"
client_secret: "testtest"
scope: "VOP"Response
ResponseCode: 200Headers: {X-Request-ID=2aa0dc88-21dd-4034-a027-1d98123596f1, MessageCreateDateTime=2024-02-08T18:31:38.385Z, Date=Thu, 08 Feb 2024 18:31:38 GMT, Content-Type=application/json;charset=UTF-8}Payload: {
"access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJnWEpSa0VzdGVHMjVoYnVTU0lOS1ZPZEdGV3B6NkstMlg2MklkVzVOc1BFIn0.eyJleHAiOjE3MjY1MDEzMTIsImlhdCI6MTcyNjUwMTAxMiwianRpIjoiOTU4N2FkYTQtMGI3NC00NjcxLWI5OWItZmU3YjBiMWRkZWQ0IiwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MjgwL2F1dGgvcmVhbG1zL21lcmNoYW50LWNsaWVudHMiLCJzdWIiOiI0ZDllYmUxNi1kZTkwLTRiMjctYjk4ZC1jNWVmYmE0M2E3NDYiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJXb3JsZGxpbmUtMDAwMDIyIiwiYWNyIjoiMSIsInNjb3BlIjoiQUlTIiwiY2xpZW50SWQiOiJXb3JsZGxpbmUtMDAwMDIyIiwiY2xpZW50SG9zdCI6IjE5Mi4xNjguMS4xIiwicm9sZXMiOlsiSU5JVFAiXSwiZW52IjoibWVyY2hhbnQtY2xpZW50cyIsImluaXRpYXRpbmdQYXJ0eSI6IjAwMDAyMiIsImNsaWVudEFkZHJlc3MiOiIxOTIuMTY4LjEuMSIsInRlbmFudCI6IldvcmxkbGluZSJ9.pjro9uLmDcQiqzpIaE2JxpyIbRyVAQ-_CWzoWB0nxzuWXBIzpwWZ__R9RYl6zdNYb2_wBoVNs_bt6mQiTIWn-0oQ-5te5LujLehvCbVJZntK_C9mD80mobEuhDXnJiZCxPVS2hWD4FwYeSpy7mM0Vm3iCMZqtsIERmzm5QFQAY6N1Ym1al_gLIkFgYtaAo1hM-8ZpNCacEB4J8HtBzkOIvNsNegUZ4qdPp7N_Vl2u4pyecxrpNe_VdXPNQftncbQUE9JBOM12jp8G7ncEKW9PH29yKlapKWX_ssMvngGwGSTfZNR-GsQKrcnzef5A_rOjbv8ozUsHeMbLPA4Lh0yDA",
"expires_in": 300,
"refresh_expires_in": 0,
"token_type": "Bearer",
"not-before-policy": 0,
"scope": "VOP"
}The token in the example will grant access to the VOP service.
Validity of access tokens
If you ask for a new token you will get a new token. Older tokens which are valid can still be used.
Access Token - Version 1
To interact with the Open Banking Service securely, you need to retrieve an access token.
This is done by a POST /token call via the Authorization API.
STEP 1 - Upload certificate
Before making the Authorization request, you will first need to upload your public certificate under a specific subscription in our back office portal. You will get access to the back office portal as part of setting your test environment phase.
The certificate can be self signed and should adhere to the following requirements:
- minimum leftover validity: more than 1 month
- maximum validity: 5 years
- key size/length: minimal length 2048, maximum length : 4096
- algorithm: SHA - 256 with RSA
STEP 2 - Retrieve an access token via the Authorization API
Endpoint : POST /token
Base URL: /xs2a/routingservice/services/authorize
To request an access token, you must digitally sign the relevant request headers using the private key associated with the certificate that you have uploaded to the back office portal.
Steps on signing the Authorization requests are available within the section Digital Signatures - Sending authorization requests. You should follow the guidelines in order to properly sign the Authorization requests.
Important Fields for creating API call for Authorization API
Request
Header fields | Type | Description |
Content-Type required | String | To identify the media type of the source. If not provided, the Initiating Party can expect to come across the error "415, Unsupported Media Type". |
Authorization required | String | The signature. It contains the header attributes 'app', 'client', 'id' and 'date' signed with the private key of the client. The signature will be used to sign the authorization request with the private key which corresponds to the certificate provided during the onboarding. Structure
Example
Refer to the chapter Digital Signatures - Sending authorization requests for more information |
App required | String | The name of the service. Only PIS, IDEAL or AIS is allowed. |
Client required | String | The name of the client. This name is provided to the Initiating Party during onboarding. The name of the client is created by the Open Banking Service and will be provided to you. |
Id required | String | The combination of Initiating Party ID and sub Id separated by semi column. In case there is no sub id, no semi column should be provided. You can find these IDs in the back office portal. Example: IP=433, subId=5 -> the ID will be 433:5. IP=434, no subId -> the ID will be 434. |
Date required | Date | Should be filled with the current date. The following date formats are supported: 1. EEE MMM dd HH:mm:ss zzz yyyy 2. ISO DATE: for example 2011-12-03T10:15:30+01:00 3. RFC 1123: for example Tue, 3 Jun 2008 11:05:30 GMT |
Form Data | Mult. | Type | Description |
grant_type | 1..1 | String | To be set to ‘client_credentials’ |
Response
Body fields | Mult. | Type | Description |
access_token | 1..1 | String | Token to be used in further API calls |
token_type | 1..1 | String | Type of the token: Bearer |
expires_in | 1..1 | Integer | Expiration time in seconds. |
Upon a successful request, the Open Banking Service provides you with an access token, which must be used in all future API interactions, such as POST /payments or GET /preferences, etc. This token should be included in the Authorization header of subsequent requests as follows:
Authorization:Bearer 4944daeae6c9115a10dafecbfad4a9c
This access token allows the Open Banking Service to validate and authorize your API requests.
Example: Authorization
Request
Address: https://digitalroutingservice.awltest.de/xs2a/routingservice/services/authorize/token?grant_type=client_credentials
HttpMethod: POST
Headers: {App=IDEAL, Accept=application/json, Date=2024-02-08T18:31:37.548Z, Authorization=Signature KeyID="39d8e82bb33e7e2a09cbcb3ef3eab351ee1c5e8f", algorithm="SHA256withRSA", headers="app client id date", signature= "r0EqeVMfc4au9fq7ZVhOwjfXbMHkf2GShAH/WIQtjMyjl2swlJss10Y0Fjpqt47aLdeBXpG28mVxzPLjwqNHPvnkNPslepJmHzB3W2A6YgXcoiUqFFv+pxzIBmohVoqVEGb5QC4rxTBpAleE178hSzIJrxxbhlCQv/dSAcoI5V1P1M3pU9VqM7vmql8XlB/yXOjmayeXVtB0T93BzqutHokHBwDjxN8ocKlsX40GcFoFjxov9cKoVjlyMZKyfHRkqZ5u1dUkcN+RFeGgJWCcCcaBydXSicK/elbpq55rAgLCTQF4xFldSDPjcrRsswMIYMZmGz0tCycjDV225pGPGg==", content-type=application/x-www-form-urlencoded, Id=000081, Client=Worldline}Response
ResponseCode: 200
Headers: {X-Request-ID=2aa0dc88-21dd-4034-a027-1d98123596f1, MessageCreateDateTime=2024-02-08T18:31:38.385Z, Date=Thu, 08 Feb 2024 18:31:38 GMT, Content-Type=application/json;charset=UTF-8}
Payload: {
"access_token": "bb00ffd85e0b619a7a9da34df24346f8b309dae54383e5e5481bada22aaa000e",
"token_type": "Bearer",
"expires_in": 3600
Validity of access tokens
As a default, tokens are valid for 60 minutes (3600 seconds). After 60 minutes have elapsed, you will need to request for a new token.
There is an overlap period in the last 10 minutes (between 50th minute - 60th minute). This means if you were to request a new token between 50th minute to 60th minute, you would receive a new access token.
However, for those 10 minutes, the previous token would also still be valid.
Transport Level Security
On the transport level, all requests to the Open Banking Service, as well as all requests sent by the Open Banking Service must be encrypted using TLS and be made over HTTPS:
- TLS 1.3 SHOULD be used;
- TLS 1.2 may be used.
- Anything below TLS 1.2 must not be used and will be refused by the Open Banking Service.
The TLS authentication method used is one-way, the server's identity is authenticated by the client. That means in requests to Open Banking Service, the Open Banking Service authenticates itself with its certificate and in case of requests from Open Banking Service to the Initiating Party, the Initiating Party authenticates itself with its certificate. Any connection without TLS encryption, such as plain http will be refused.
Mutual TLS optional
Optionally the TLS authentication can be done two-way, that means that both client and server identities are authenticated mutually. That means that both The Open Banking Service and the Initiating Party identities are authenticated, providing a higher level of security.