- Version 2.10.1 to 2.11.0
- What's New
- What's Changed
- What's Deleted
- What's Deprecated
What's New
Cancel future changes of the account by future change reference (beta)
POST
/issuers/{issuerId}/accounts/{accountReference}/account-future-updates/{futureChangeReference}/cancel
Cancel future changes of the account by future change reference
Cancel future changes of the account by future change reference (beta)
POST
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates/{futureChangeReference}/cancel
Cancel future changes of the account by future change reference
Create address for a customer and subscribe to add-on (beta)
POST
/issuers/{issuerId}/customers/{customerReference}/addressesAndSubscriptions
The API allows to create either a permanent address or a temporary address for the customer, identified with his reference, and to subscribe to an add-on service for a contract . An address includes the following information: • the issuer address external reference • the label (eg MAIN_POSTAL_ADDRESS), • the type (mail address, phone number, email) and the corresponding data • the address usages • the start date (optional, by default, the current date is used) • the end date (conditional, only used when defining a temporary address) When creating a temporary address, If a temporary address already exists with an overlap on the activity period then only the newly created address will be kept and the old one will be removed. For information, the main postal address is mandatory. In return, the API provides the address Reference calculated by the system.
Create address for a customer and subscribe to add-on (beta)
POST
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addressesAndSubscriptions
The API allows to create either a permanent address or a temporary address for the customer, identified with his reference, and to subscribe to an add-on service for a contract . An address includes the following information: • the issuer address external reference • the label (eg MAIN_POSTAL_ADDRESS), • the type (mail address, phone number, email) and the corresponding data • the address usages • the start date (optional, by default, the current date is used) • the end date (conditional, only used when defining a temporary address) When creating a temporary address, If a temporary address already exists with an overlap on the activity period then only the newly created address will be kept and the old one will be removed. For information, the main postal address is mandatory. In return, the API provides the address Reference calculated by the system.
Search corporate contracts (beta)
POST
/search-corporate-contracts
This API allows to search corporate contracts
What's Changed
Retrieve financial information by external reference
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/balance
Response:
- Changed property
data
(objectAccountBalance
)- Added property
liableBalance
(object)
- Added property
Create mandate by external reference
POST
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/create-mandate
Request body:
- New optional properties:
debtorBic
debtorEmail
debtorIban
debtorId
debtorName
debtorPostalAddress
mandateContractId
mandateNatureType
mandateSignCity
mandateSignDate
sepaCreditorId
sepaMandateUir
- Added property
iban
(string) - Added property
bic
(string) - Added property
ibanOwnerName
(string)
Cancel mandate by external reference
POST
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/cancel-mandate
Request body:
- New optional properties:
cancelMandateOnExternalSystem
validateMandate
- Added property
cancellationDate
(string)
Retrieve financial information
GET
/issuers/{issuerId}/accounts/{accountReference}/balance
Response:
- Changed property
data
(objectAccountBalance
)- Added property
liableBalance
(object)
- Added property
Create mandate
POST
/issuers/{issuerId}/accounts/{accountReference}/create-mandate
Request body:
- New optional properties:
debtorBic
debtorEmail
debtorIban
debtorId
debtorName
debtorPostalAddress
mandateContractId
mandateNatureType
mandateSignCity
mandateSignDate
sepaCreditorId
sepaMandateUir
- Added property
iban
(string) - Added property
bic
(string) - Added property
ibanOwnerName
(string)
Cancel mandate
POST
/issuers/{issuerId}/accounts/{accountReference}/cancel-mandate
Request body:
- New optional properties:
cancelMandateOnExternalSystem
validateMandate
- Added property
cancellationDate
(string)
Cancel a pending ProductChange
POST
/issuers/{issuerId}/contracts/{contractReference}/cancel-product-change
Request body:
New content type : `*/*`Response:
- Changed property
data
(objectCancelProductChangeResponse
)- Added property
originalContract
(object) - Added property
changedContract
(object)
- Added property
Cancel a pending ProductChange by external reference
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/cancel-product-change
Request body:
New content type : `*/*`Response:
- Changed property
data
(objectCancelProductChangeResponse
)- Added property
originalContract
(object) - Added property
changedContract
(object)
- Added property
Retrieve future changes for the account by external reference
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates/{creationDate}
Response:
- Changed property
data
(objectAccountFutureUpdate
)- Added property
updateStatus
(string) - Added property
accountFutureUpdateIdentifier
(object) - Added property
updateReason
(string) - Added property
lastUpdateDate
(string) - Added property
sepaCreditorId
(string) - Added property
sepaMandateStatus
(string) - Added property
sepaMandateUir
(string) - Added property
sepaMandateUmr
(string) - Added property
debtorPhoneNumber
(string) - Added property
debtorEmail
(string) - Added property
debtorPostalAddress
(object) - Added property
mandateContractId
(string) - Added property
mandateNatureType
(string) - Added property
mandateSignDate
(string) - Added property
mandateSignCity
(string)
- Added property
Create a temporary credit limit by external reference
POST
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/temporary-credit-limits
Request body:
- Added property
manageOverlap
(boolean)
Retrieve future changes for the account
GET
/issuers/{issuerId}/accounts/{accountReference}/account-future-updates/{creationDate}
Response:
- Changed property
data
(objectAccountFutureUpdate
)- Added property
updateStatus
(string) - Added property
accountFutureUpdateIdentifier
(object) - Added property
updateReason
(string) - Added property
lastUpdateDate
(string) - Added property
sepaCreditorId
(string) - Added property
sepaMandateStatus
(string) - Added property
sepaMandateUir
(string) - Added property
sepaMandateUmr
(string) - Added property
debtorPhoneNumber
(string) - Added property
debtorEmail
(string) - Added property
debtorPostalAddress
(object) - Added property
mandateContractId
(string) - Added property
mandateNatureType
(string) - Added property
mandateSignDate
(string) - Added property
mandateSignCity
(string)
- Added property
Create a temporary credit limit
POST
/issuers/{issuerId}/accounts/{accountReference}/temporary-credit-limits
Request body:
- Added property
manageOverlap
(boolean)
Retrieve account by external reference
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}
Response:
- Changed property
data
(objectAccount
)- Added property
isChangeOfPayerAtNextCycle
(boolean)
- Added property
Schedule new account parameters update in future by external reference
POST
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates
Request body:
- Added property
accountFutureUpdateIdentifier
(object) - Added property
sepaMandate
(object) - Added property
updateReason
(string)
Response:
- Changed property
data
(objectCreateAccountFutureUpdateResponse
)- Added property
accountFutureUpdateIdentifier
(object)
- Added property
Retrieve list of future changes of the account by external reference
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates
Response:
- Changed property
data
(array)- Changed items (object
AccountFutureUpdate
)- Added property
updateStatus
(string) - Added property
accountFutureUpdateIdentifier
(object) - Added property
updateReason
(string) - Added property
lastUpdateDate
(string) - Added property
sepaCreditorId
(string) - Added property
sepaMandateStatus
(string) - Added property
sepaMandateUir
(string) - Added property
sepaMandateUmr
(string) - Added property
debtorPhoneNumber
(string) - Added property
debtorEmail
(string) - Added property
debtorPostalAddress
(object) - Added property
mandateContractId
(string) - Added property
mandateNatureType
(string) - Added property
mandateSignDate
(string) - Added property
mandateSignCity
(string)
- Added property
- Changed items (object
Retrieve operation by external reference
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations/{operationId}
Response:
- Changed property
data
(objectOperation
)- Changed property
detailedFeeAmounts
(array)- Changed items (object
DetailedFeeAmount
)- Added property
includeInOtherDetailFeeAmount
(boolean)
- Added property
- Changed items (object
- Changed property
Create velocity limit override by external account reference
POST
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/velocity-limits/{velocityLimitReference}/velocity-limit-overrides
Request body:
- New required properties:
velocityLimitOverrideIdentifier
- Added property
velocityLimitOverrideIdentifier
(object)
Retrieve account
GET
/issuers/{issuerId}/accounts/{accountReference}
Response:
- Changed property
data
(objectAccount
)- Added property
isChangeOfPayerAtNextCycle
(boolean)
- Added property
Schedule new account parameters update in future
POST
/issuers/{issuerId}/accounts/{accountReference}/account-future-updates
Request body:
- Added property
accountFutureUpdateIdentifier
(object) - Added property
sepaMandate
(object) - Added property
updateReason
(string)
Response:
- Changed property
data
(objectCreateAccountFutureUpdateResponse
)- Added property
accountFutureUpdateIdentifier
(object)
- Added property
Retrieve list of future changes of the account
GET
/issuers/{issuerId}/accounts/{accountReference}/account-future-updates
Response:
- Changed property
data
(array)- Changed items (object
AccountFutureUpdate
)- Added property
updateStatus
(string) - Added property
accountFutureUpdateIdentifier
(object) - Added property
updateReason
(string) - Added property
lastUpdateDate
(string) - Added property
sepaCreditorId
(string) - Added property
sepaMandateStatus
(string) - Added property
sepaMandateUir
(string) - Added property
sepaMandateUmr
(string) - Added property
debtorPhoneNumber
(string) - Added property
debtorEmail
(string) - Added property
debtorPostalAddress
(object) - Added property
mandateContractId
(string) - Added property
mandateNatureType
(string) - Added property
mandateSignDate
(string) - Added property
mandateSignCity
(string)
- Added property
- Changed items (object
Retrieve operation
GET
/issuers/{issuerId}/accounts/{accountReference}/operations/{operationId}
Response:
- Changed property
data
(objectOperation
)- Changed property
detailedFeeAmounts
(array)- Changed items (object
DetailedFeeAmount
)- Added property
includeInOtherDetailFeeAmount
(boolean)
- Added property
- Changed items (object
- Changed property
Create velocity limit override
POST
/issuers/{issuerId}/accounts/{accountReference}/velocity-limits/{velocityLimitReference}/velocity-limit-overrides
Request body:
- New required properties:
velocityLimitOverrideIdentifier
- Added property
velocityLimitOverrideIdentifier
(object)
Retrieve contract for an account by external reference
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/contract
Response:
- Changed property
data
(objectContract
)- Changed property
accounts
(array)- Changed items (object
Account
)- Added property
isChangeOfPayerAtNextCycle
(boolean)
- Added property
- Changed items (object
- Changed property
List operations for an account by external reference
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Changed property
detailedFeeAmounts
(array)- Changed items (object
DetailedFeeAmount
)- Added property
includeInOtherDetailFeeAmount
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
List operations for last account statement by external reference
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/last/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Changed property
detailedFeeAmounts
(array)- Changed items (object
DetailedFeeAmount
)- Added property
includeInOtherDetailFeeAmount
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
List operations for next account statement by external reference
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/next/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Changed property
detailedFeeAmounts
(array)- Changed items (object
DetailedFeeAmount
)- Added property
includeInOtherDetailFeeAmount
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
List operations for an account statement by external reference
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/{cycleClosureDate}/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Changed property
detailedFeeAmounts
(array)- Changed items (object
DetailedFeeAmount
)- Added property
includeInOtherDetailFeeAmount
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
Retrieve contract for an account
GET
/issuers/{issuerId}/accounts/{accountReference}/contract
Response:
- Changed property
data
(objectContract
)- Changed property
accounts
(array)- Changed items (object
Account
)- Added property
isChangeOfPayerAtNextCycle
(boolean)
- Added property
- Changed items (object
- Changed property
List operations for an account
GET
/issuers/{issuerId}/accounts/{accountReference}/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Changed property
detailedFeeAmounts
(array)- Changed items (object
DetailedFeeAmount
)- Added property
includeInOtherDetailFeeAmount
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
List operations for last account statement
GET
/issuers/{issuerId}/accounts/{accountReference}/statements/last/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Changed property
detailedFeeAmounts
(array)- Changed items (object
DetailedFeeAmount
)- Added property
includeInOtherDetailFeeAmount
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
List operations for next account statement
GET
/issuers/{issuerId}/accounts/{accountReference}/statements/next/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Changed property
detailedFeeAmounts
(array)- Changed items (object
DetailedFeeAmount
)- Added property
includeInOtherDetailFeeAmount
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
List operations for an account statement
GET
/issuers/{issuerId}/accounts/{accountReference}/statements/{cycleClosureDate}/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Changed property
detailedFeeAmounts
(array)- Changed items (object
DetailedFeeAmount
)- Added property
includeInOtherDetailFeeAmount
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
Retrieve list of company's information (beta)
GET
/issuers/{issuerId}/companies
Parameters:
Added:streetName
in query
Changed: corporateName
in query
Retrieve contract for a card contract by external reference
GET
/issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/contract
Response:
- Changed property
data
(objectContract
)- Changed property
accounts
(array)- Changed items (object
Account
)- Added property
isChangeOfPayerAtNextCycle
(boolean)
- Added property
- Changed items (object
- Changed property
Retrieve contract for a card contract
GET
/issuers/{issuerId}/card-contracts/{cardContractReference}/contract
Response:
- Changed property
data
(objectContract
)- Changed property
accounts
(array)- Changed items (object
Account
)- Added property
isChangeOfPayerAtNextCycle
(boolean)
- Added property
- Changed items (object
- Changed property
Retrieve corporate employee Accounts (beta)
GET
/issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/{accountReference}
Parameters:
Changed:embed
in query
Response:
- Changed property
data
(objectCorporateEmployeeAccountResponse
)- Changed property
account
(objectAccount
)- Added property
isChangeOfPayerAtNextCycle
(boolean)
- Added property
- Changed property
Retrieve corporate employee accounts by account external reference (beta)
GET
/issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Parameters:
Changed:embed
in query
Response:
- Changed property
data
(objectCorporateEmployeeAccountResponse
)- Changed property
account
(objectAccount
)- Added property
isChangeOfPayerAtNextCycle
(boolean)
- Added property
- Changed property
Retrieve corporate employee Accounts by contract external reference and account external reference (beta)
GET
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Parameters:
Changed:embed
in query
Response:
- Changed property
data
(objectCorporateEmployeeAccountResponse
)- Changed property
account
(objectAccount
)- Added property
isChangeOfPayerAtNextCycle
(boolean)
- Added property
- Changed property
Retrieve corporate employee Accounts by contract external reference (beta)
GET
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/{accountReference}
Parameters:
Changed:embed
in query
Response:
- Changed property
data
(objectCorporateEmployeeAccountResponse
)- Changed property
account
(objectAccount
)- Added property
isChangeOfPayerAtNextCycle
(boolean)
- Added property
- Changed property
Retrieve contract by external reference
GET
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}
Response:
- Changed property
data
(objectContract
)- Changed property
accounts
(array)- Changed items (object
Account
)- Added property
isChangeOfPayerAtNextCycle
(boolean)
- Added property
- Changed items (object
- Changed property
List accounts for contract by external reference
GET
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/accounts
Response:
- Changed property
data
(array)- Changed items (object
Account
)- Added property
isChangeOfPayerAtNextCycle
(boolean)
- Added property
- Changed items (object
Retrieve contract
GET
/issuers/{issuerId}/contracts/{contractReference}
Response:
- Changed property
data
(objectContract
)- Changed property
accounts
(array)- Changed items (object
Account
)- Added property
isChangeOfPayerAtNextCycle
(boolean)
- Added property
- Changed items (object
- Changed property
List accounts for contract
GET
/issuers/{issuerId}/contracts/{contractReference}/accounts
Response:
- Changed property
data
(array)- Changed items (object
Account
)- Added property
isChangeOfPayerAtNextCycle
(boolean)
- Added property
- Changed items (object
List accounts for account owner by external reference
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/accounts
Response:
- Changed property
data
(array)- Changed items (object
Account
)- Added property
isChangeOfPayerAtNextCycle
(boolean)
- Added property
- Changed items (object
List accounts for account owner
GET
/issuers/{issuerId}/customers/{customerReference}/accounts
Response:
- Changed property
data
(array)- Changed items (object
Account
)- Added property
isChangeOfPayerAtNextCycle
(boolean)
- Added property
- Changed items (object
Retrieve corporate contract (beta)
GET
/issuers/{issuerId}/corporate-contracts/{contractReference}
Parameters:
Changed:embed
in query
Response:
- Changed property
data
(objectCorporateContract
)- Added property
rootAccount
(object)
- Changed property
corporateContractEntities
(array)- Changed items (object
CorporateContractEntity
)- Changed property
account
(objectAccount
)- Added property
isChangeOfPayerAtNextCycle
(boolean)
- Added property
- Changed property
- Changed items (object
- Changed property
corporateEmployeeAccounts
(array)- Changed items (object
CorporateEmployeeAccount
)- Changed property
account
(objectAccount
)- Added property
isChangeOfPayerAtNextCycle
(boolean)
- Added property
- Changed property
- Changed items (object
- Added property
Retrieve corporate contract by external reference (beta)
GET
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}
Parameters:
Changed:embed
in query
Response:
- Changed property
data
(objectCorporateContract
)- Added property
rootAccount
(object)
- Changed property
corporateContractEntities
(array)- Changed items (object
CorporateContractEntity
)- Changed property
account
(objectAccount
)- Added property
isChangeOfPayerAtNextCycle
(boolean)
- Added property
- Changed property
- Changed items (object
- Changed property
corporateEmployeeAccounts
(array)- Changed items (object
CorporateEmployeeAccount
)- Changed property
account
(objectAccount
)- Added property
isChangeOfPayerAtNextCycle
(boolean)
- Added property
- Changed property
- Changed items (object
- Added property
Retrieve contracts by criteria
POST
/issuers/{issuerId}/contracts/search
Response:
- Changed property
data
(array)- Changed items (object
Contract
)- Changed property
accounts
(array)- Changed items (object
Account
)- Added property
isChangeOfPayerAtNextCycle
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
List contracts for contract owner by external reference
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contracts
Response:
- Changed property
data
(array)- Changed items (object
Contract
)- Changed property
accounts
(array)- Changed items (object
Account
)- Added property
isChangeOfPayerAtNextCycle
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
List contracts for contract owner
GET
/issuers/{issuerId}/customers/{customerReference}/contracts
Response:
- Changed property
data
(array)- Changed items (object
Contract
)- Changed property
accounts
(array)- Changed items (object
Account
)- Added property
isChangeOfPayerAtNextCycle
(boolean)
- Added property
- Changed items (object
- Changed property
- Changed items (object
List corporate contracts for a company (beta)
GET
/issuers/{issuerId}/companies/{customerReference}/corporate-contracts
Response:
- Changed property
data
(array)- Changed items (object
CorporateContract
)- Added property
rootAccount
(object)
- Changed property
corporateContractEntities
(array)- Changed items (object
CorporateContractEntity
)- Changed property
account
(objectAccount
)- Added property
isChangeOfPayerAtNextCycle
(boolean)
- Added property
- Changed property
- Changed items (object
- Changed property
corporateEmployeeAccounts
(array)- Changed items (object
CorporateEmployeeAccount
)- Changed property
account
(objectAccount
)- Added property
isChangeOfPayerAtNextCycle
(boolean)
- Added property
- Changed property
- Changed items (object
- Added property
- Changed items (object
List corporate contracts for a company by external reference (beta)
GET
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/corporate-contracts
Response:
- Changed property
data
(array)- Changed items (object
CorporateContract
)- Added property
rootAccount
(object)
- Changed property
corporateContractEntities
(array)- Changed items (object
CorporateContractEntity
)- Changed property
account
(objectAccount
)- Added property
isChangeOfPayerAtNextCycle
(boolean)
- Added property
- Changed property
- Changed items (object
- Changed property
corporateEmployeeAccounts
(array)- Changed items (object
CorporateEmployeeAccount
)- Changed property
account
(objectAccount
)- Added property
isChangeOfPayerAtNextCycle
(boolean)
- Added property
- Changed property
- Changed items (object
- Added property
- Changed items (object
Add an entity to a Corporate contract (beta)
POST
/issuers/{issuerId}/corporate-contracts/{contractReference}/add-corporate-contract-entity
Request body:
- Changed property
addCorporateContractEntity
(objectCreateCorporateContractRequest.AddCorporateContractEntity
)- Changed property
corporateContractEntityAccounts
(array)- Changed items (object
CreateCorporateContractRequest.CorporateContractEntityAccount
)- Changed property
account
(objectCreateCorporateContractRequest.Account
)- Added property
ibanOwnerName
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
Add an entity to a Corporate contract by external reference (beta)
POST
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/add-corporate-contract-entity
Request body:
- Changed property
addCorporateContractEntity
(objectCreateCorporateContractRequest.AddCorporateContractEntity
)- Changed property
corporateContractEntityAccounts
(array)- Changed items (object
CreateCorporateContractRequest.CorporateContractEntityAccount
)- Changed property
account
(objectCreateCorporateContractRequest.Account
)- Added property
ibanOwnerName
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
Create consumer contract
POST
/issuers/{issuerId}/contracts/create-consumer-contract
Request body:
- Changed property
addCardsAccounts
(objectCreateConsumerContractRequest.AddCardsAccounts
)- Changed property
accounts
(array)- Changed items (object
CreateConsumerContractRequest.Account
)- New optional properties:
iban
- Added property
ibanOwnerName
(string)
- Changed property
sepaMandate
(objectCreateConsumerContractRequest.SepaMandate
)- New optional properties:
debtorName
- New optional properties:
- New optional properties:
- Changed items (object
- Changed property
cardContracts
(array)- Changed items (object
CreateConsumerContractRequest.CardContract
)- Changed property
card
(objectCreateConsumerContractRequest.Card
)- Changed property
cardOrder
(objectCreateConsumerContractRequest.CardOrder
)- Added property
customDeliveryAddressee
(string) - Added property
customDeliveryAddress
(object)
- Added property
- Changed property
pinMailerOrder
(objectCreateConsumerContractRequest.PinMailerOrder
)- Added property
customDeliveryAddressee
(string) - Added property
customDeliveryAddress
(object)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed property
contract
(objectCreateConsumerContractRequest.Contract
)- Changed property
accountHierarchy
(objectCreateConsumerContractRequest.AccountHierarchy
)- Changed property
accounts
(array)- Changed items (object
CreateConsumerContractRequest.Account
)- New optional properties:
iban
- Added property
ibanOwnerName
(string)
- Changed property
sepaMandate
(objectCreateConsumerContractRequest.SepaMandate
)- New optional properties:
debtorName
- New optional properties:
- New optional properties:
- Changed items (object
- Changed property
- Changed property
cardContracts
(array)- Changed items (object
CreateConsumerContractRequest.CardContract
)- Changed property
card
(objectCreateConsumerContractRequest.Card
)- Changed property
cardOrder
(objectCreateConsumerContractRequest.CardOrder
)- Added property
customDeliveryAddressee
(string) - Added property
customDeliveryAddress
(object)
- Added property
- Changed property
pinMailerOrder
(objectCreateConsumerContractRequest.PinMailerOrder
)- Added property
customDeliveryAddressee
(string) - Added property
customDeliveryAddress
(object)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
Add cards and accounts to a contract by external reference
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/add-cards-accounts
Request body:
- Changed property
cardContracts
(array)- Changed items (object
CreateConsumerContractRequest.CardContract
)- Changed property
card
(objectCreateConsumerContractRequest.Card
)- Changed property
cardOrder
(objectCreateConsumerContractRequest.CardOrder
)- Added property
customDeliveryAddressee
(string) - Added property
customDeliveryAddress
(object)
- Added property
- Changed property
pinMailerOrder
(objectCreateConsumerContractRequest.PinMailerOrder
)- Added property
customDeliveryAddressee
(string) - Added property
customDeliveryAddress
(object)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
accountHierarchy
(objectAddCardsAccountsRequest.AccountHierarchy
)- Changed property
accounts
(array)- Changed items (object
CreateConsumerContractRequest.Account
)- New optional properties:
iban
- Added property
ibanOwnerName
(string)
- Changed property
sepaMandate
(objectCreateConsumerContractRequest.SepaMandate
)- New optional properties:
debtorName
- New optional properties:
- New optional properties:
- Changed items (object
- Changed property
Add cards and accounts to a contract
POST
/issuers/{issuerId}/contracts/{contractReference}/add-cards-accounts
Request body:
- Changed property
cardContracts
(array)- Changed items (object
CreateConsumerContractRequest.CardContract
)- Changed property
card
(objectCreateConsumerContractRequest.Card
)- Changed property
cardOrder
(objectCreateConsumerContractRequest.CardOrder
)- Added property
customDeliveryAddressee
(string) - Added property
customDeliveryAddress
(object)
- Added property
- Changed property
pinMailerOrder
(objectCreateConsumerContractRequest.PinMailerOrder
)- Added property
customDeliveryAddressee
(string) - Added property
customDeliveryAddress
(object)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
accountHierarchy
(objectAddCardsAccountsRequest.AccountHierarchy
)- Changed property
accounts
(array)- Changed items (object
CreateConsumerContractRequest.Account
)- New optional properties:
iban
- Added property
ibanOwnerName
(string)
- Changed property
sepaMandate
(objectCreateConsumerContractRequest.SepaMandate
)- New optional properties:
debtorName
- New optional properties:
- New optional properties:
- Changed items (object
- Changed property
Add an employee and its card(s) and account(s) to a Corporate contract (beta)
POST
/issuers/{issuerId}/corporate-contracts/{contractReference}/add-corporate-employee-cards-accounts
Request body:
- Changed property
addCorporateEmployeeCardsAndAccounts
(objectCreateCorporateContractRequest.AddCorporateEmployeeCardsAndAccounts
)- Changed property
corporateEmployeeAccounts
(array)- Changed items (object
CreateCorporateContractRequest.CorporateEmployeeAccount
)- Changed property
account
(objectCreateCorporateContractRequest.Account
)- Added property
ibanOwnerName
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
Add an employee and its card(s) and account(s) to a Corporate contract by external reference (beta)
POST
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/add-corporate-employee-cards-accounts
Request body:
- Changed property
addCorporateEmployeeCardsAndAccounts
(objectCreateCorporateContractRequest.AddCorporateEmployeeCardsAndAccounts
)- Changed property
corporateEmployeeAccounts
(array)- Changed items (object
CreateCorporateContractRequest.CorporateEmployeeAccount
)- Changed property
account
(objectCreateCorporateContractRequest.Account
)- Added property
ibanOwnerName
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
Create a Corporate contract (beta)
POST
/issuers/{issuerId}/corporate-contracts/create-corporate-contract
Request body:
- Changed property
corporateContract
(objectCreateCorporateContractRequest.Contract
)- Changed property
corporateContractRootEntity
(objectCreateCorporateContractRequest.CorporateContractRootEntity
)- Changed property
rootAccount
(objectCreateCorporateContractRequest.Account
)- Added property
ibanOwnerName
(string)
- Added property
- Changed property
- Changed property
- Changed property
addCorporateContractEntities
(array)- Changed items (object
CreateCorporateContractRequest.AddCorporateContractEntity
)- Changed property
corporateContractEntityAccounts
(array)- Changed items (object
CreateCorporateContractRequest.CorporateContractEntityAccount
)- Changed property
account
(objectCreateCorporateContractRequest.Account
)- Added property
ibanOwnerName
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
addCorporateEmployeeCardsAndAccounts
(array)- Changed items (object
CreateCorporateContractRequest.AddCorporateEmployeeCardsAndAccounts
)- Changed property
corporateEmployeeAccounts
(array)- Changed items (object
CreateCorporateContractRequest.CorporateEmployeeAccount
)- Changed property
account
(objectCreateCorporateContractRequest.Account
)- Added property
ibanOwnerName
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
What's Deleted
No API deleted.
What's Deprecated
No API deprecated.