API version 2.15.1
Release Notes: : REST API V2 - 2.15.1
Version 2.15.0 to 2.15.1
What's New
POST
/issuers/{issuerId}/contracts/brand-advice
Get a brand selection advice (beta)
This API allows getting an advice on which brand to select for a card creation (either first card along new contract, additional card or replacement card). This is applicable for products on which brand selection is configured. The API returns the product extension for the advised card brand
GET
/issuers/{issuerId}/contracts/brand-advice-config/{issuerProductExternalReference}
Retrieve brand advice algorithm configuration by issuer product external reference (beta)
The API allows the brand advice configuration to be retrieved. The main input fields are:
- The issuer ID
- The issuer product external reference for which the configuration details are requested.
PATCH
/issuers/{issuerId}/contracts/brand-advice-config/{issuerProductExternalReference}
Update brand advice algorithm configuration by issuer product external reference (beta)
The API allows a list of pre-defined parameters (attributes) of a brand advice configuration to be updated. The main input fields are:
- The issuer ID
- The issuer product external reference for which configuration updates are required.
- Parameters to be updated
The brand advice configuration parameters can be retrieved using the Retrieve brand advice detail API. The updated parameters should be consistent with the initial product configuration defined in the system (e.g., the profiles to be updated must exist in the system to be found).
What's Changed
GET
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders/{orderReference}
Response:
- Changed property
data
(objectOrder
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed items (object
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed property
GET
/issuers/{issuerId}/cards/{cardReference}/orders/{orderReference}
Response:
- Changed property
data
(objectOrder
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed items (object
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed property
GET
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}
Response:
- Changed property
data
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed items (object
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders
Response:
- Changed property
data
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed items (object
- Added property
- Changed property
- Changed property
- Changed items (object
GET
/issuers/{issuerId}/cards/{cardReference}
Response:
- Changed property
data
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed items (object
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/cards/{cardReference}/orders
Response:
- Changed property
data
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed items (object
- Added property
- Changed property
- Changed property
- Changed items (object
PATCH
/issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}
Request body :
- Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
GET
/issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}
Response:
- Changed property
data
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Added property
GET
/issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cards
Response:
- Changed property
data
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
PATCH
/issuers/{issuerId}/card-contracts/{cardContractReference}
Request body :
- Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
GET
/issuers/{issuerId}/card-contracts/{cardContractReference}
Response:
- Changed property
data
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Added property
GET
/issuers/{issuerId}/card-contracts/{cardContractReference}/cards
Response:
- Changed property
data
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
GET
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/card-contract
Response:
- Changed property
data
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Added property
POST
/issuers/{issuerId}/cards/search
Response:
- Changed property
data
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
GET
/issuers/{issuerId}/cards/{cardReference}/card-contract
Response:
- Changed property
data
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Added property
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/contract
Response:
- Changed property
data
(objectContract
)- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Added property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/accounts/{accountReference}/contract
Response:
- Changed property
data
(objectContract
)- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Added property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/contract
Response:
- Changed property
data
(objectContract
)- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Added property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/card-contracts/{cardContractReference}/contract
Response:
- Changed property
data
(objectContract
)- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Added property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/{accountReference}
Response:
- Changed property
data
(objectCorporateEmployeeAccountResponse
)- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Added property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Response:
- Changed property
data
(objectCorporateEmployeeAccountResponse
)- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Added property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Response:
- Changed property
data
(objectCorporateEmployeeAccountResponse
)- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Added property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/{accountReference}
Response:
- Changed property
data
(objectCorporateEmployeeAccountResponse
)- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Added property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}
Response:
- Changed property
data
(objectContract
)- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Added property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/card-contracts
Response:
- Changed property
data
(array)- Changed items (object
CardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Added property
- Changed items (object
GET
/issuers/{issuerId}/contracts/{contractReference}
Response:
- Changed property
data
(objectContract
)- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Added property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/contracts/{contractReference}/card-contracts
Response:
- Changed property
data
(array)- Changed items (object
CardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Added property
- Changed items (object
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/card-contracts
Response:
- Changed property
data
(array)- Changed items (object
CardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Added property
- Changed items (object
GET
/issuers/{issuerId}/customers/{customerReference}/card-contracts
Response:
- Changed property
data
(array)- Changed items (object
CardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Added property
- Changed items (object
GET
/issuers/{issuerId}/corporate-contracts/{contractReference}
Response:
- Changed property
data
(objectCorporateContract
)- Changed property
corporateEmployeeAccounts
(array)- Changed items (object
CorporateEmployeeAccount
)- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}
Response:
- Changed property
data
(objectCorporateContract
)- Changed property
corporateEmployeeAccounts
(array)- Changed items (object
CorporateEmployeeAccount
)- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
POST
/issuers/{issuerId}/contracts/create-consumer-contract
Response:
- Changed property
data
(objectCreateConsumerContractResponse
)- Changed property
contract
(objectCreateConsumerContractResponse.Contract
)- Changed property
cardContracts
(array)- Changed items (object
CreateConsumerContractResponse.CardContract
)- Added property
cardContractGroupReference
(string)
- Added property
- Changed items (object
- Changed property
- Changed property
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/add-cards-accounts
Response:
- Changed property
data
(objectAddCardsAccountsResponse
)- Changed property
contract
(objectCreateConsumerContractResponse.Contract
)- Changed property
cardContracts
(array)- Changed items (object
CreateConsumerContractResponse.CardContract
)- Added property
cardContractGroupReference
(string)
- Added property
- Changed items (object
- Changed property
- Changed property
POST
/issuers/{issuerId}/contracts/search
Response:
- Changed property
data
(array)- Changed items (object
Contract
)- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Added property
- Changed items (object
- Changed property
- Changed items (object
POST
/issuers/{issuerId}/contracts/{contractReference}/add-cards-accounts
Response:
- Changed property
data
(objectAddCardsAccountsResponse
)- Changed property
contract
(objectCreateConsumerContractResponse.Contract
)- Changed property
cardContracts
(array)- Changed items (object
CreateConsumerContractResponse.CardContract
)- Added property
cardContractGroupReference
(string)
- Added property
- Changed items (object
- Changed property
- Changed property
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contracts
Response:
- Changed property
data
(array)- Changed items (object
Contract
)- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Added property
- Changed items (object
- Changed property
- Changed items (object
GET
/issuers/{issuerId}/customers/{customerReference}/contracts
Response:
- Changed property
data
(array)- Changed items (object
Contract
)- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Added property
- Changed items (object
- Changed property
- Changed items (object
GET
/issuers/{issuerId}/companies/{customerReference}/corporate-contracts
Response:
- Changed property
data
(array)- Changed items (object
CorporateContract
)- Changed property
corporateEmployeeAccounts
(array)- Changed items (object
CorporateEmployeeAccount
)- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
GET
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/corporate-contracts
Response:
- Changed property
data
(array)- Changed items (object
CorporateContract
)- Changed property
corporateEmployeeAccounts
(array)- Changed items (object
CorporateEmployeeAccount
)- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
POST
/search-corporate-contracts
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
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer) - Changed property
cards
(array)- Changed items (object
Card
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
orders
(array)- Changed items (object
Order
)- Changed property
card
(objectCard
)- Changed property
cardContract
(objectCardContract
)- Added property
cardContractGroupReference
(string) - Added property
deviceTokensNumber
(integer) - Added property
merchantTokensNumber
(integer)
- Added property
- Changed property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
What's Deleted
No API deleted.
What's Deprecated
No API deprecated.
API version 2.15.0
Release Notes: : REST API V2 - 2.15.0
Version 2.14.0 to 2.15.0
What's New
No new API.
What's Changed
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations/{operationId}
Response:
- Changed property
data
(objectOperation
)-
New required properties:
postingAccountIdentifier
-
Added property
disputed
(boolean) -
Added property
printOnStatement
(boolean) -
Added property
cardAcceptorAddress
(string) -
Added property
cardAcceptorStateProvinceRegionCode
(string) -
Added property
subOperationIdentifiers
(array) -
Added property
correction
(boolean) -
Added property
intermediateAmount
(object) -
Added property
billingAmount
(object) -
Added property
overallExhangeRate
(number)
-
GET
/issuers/{issuerId}/accounts/{accountReference}/operations/{operationId}
Response:
- Changed property
data
(objectOperation
)-
New required properties:
postingAccountIdentifier
-
Added property
disputed
(boolean) -
Added property
printOnStatement
(boolean) -
Added property
cardAcceptorAddress
(string) -
Added property
cardAcceptorStateProvinceRegionCode
(string) -
Added property
subOperationIdentifiers
(array) -
Added property
correction
(boolean) -
Added property
intermediateAmount
(object) -
Added property
billingAmount
(object) -
Added property
overallExhangeRate
(number)
-
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)-
New required properties:
postingAccountIdentifier
-
Added property
disputed
(boolean) -
Added property
printOnStatement
(boolean) -
Added property
cardAcceptorAddress
(string) -
Added property
cardAcceptorStateProvinceRegionCode
(string) -
Added property
postingAccountIdentifier
(object)
-
- Changed items (object
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/last/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)-
New required properties:
postingAccountIdentifier
-
Added property
disputed
(boolean) -
Added property
printOnStatement
(boolean) -
Added property
cardAcceptorAddress
(string) -
Added property
cardAcceptorStateProvinceRegionCode
(string) -
Added property
postingAccountIdentifier
(object)
-
- Changed items (object
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/next/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)-
New required properties:
postingAccountIdentifier
-
Added property
disputed
(boolean) -
Added property
printOnStatement
(boolean) -
Added property
cardAcceptorAddress
(string) -
Added property
cardAcceptorStateProvinceRegionCode
(string) -
Added property
postingAccountIdentifier
(object)
-
- Changed items (object
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/{cycleClosureDate}/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)-
New required properties:
postingAccountIdentifier
-
Added property
disputed
(boolean) -
Added property
printOnStatement
(boolean) -
Added property
cardAcceptorAddress
(string) -
Added property
cardAcceptorStateProvinceRegionCode
(string) -
Added property
postingAccountIdentifier
(object)
-
- Changed items (object
GET
/issuers/{issuerId}/accounts/{accountReference}/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)-
New required properties:
postingAccountIdentifier
-
Added property
disputed
(boolean) -
Added property
printOnStatement
(boolean) -
Added property
cardAcceptorAddress
(string) -
Added property
cardAcceptorStateProvinceRegionCode
(string) -
Added property
postingAccountIdentifier
(object)
-
- Changed items (object
GET
/issuers/{issuerId}/accounts/{accountReference}/statements/last/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)-
New required properties:
postingAccountIdentifier
-
Added property
disputed
(boolean) -
Added property
printOnStatement
(boolean) -
Added property
cardAcceptorAddress
(string) -
Added property
cardAcceptorStateProvinceRegionCode
(string) -
Added property
postingAccountIdentifier
(object)
-
- Changed items (object
GET
/issuers/{issuerId}/accounts/{accountReference}/statements/next/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)-
New required properties:
postingAccountIdentifier
-
Added property
disputed
(boolean) -
Added property
printOnStatement
(boolean) -
Added property
cardAcceptorAddress
(string) -
Added property
cardAcceptorStateProvinceRegionCode
(string) -
Added property
postingAccountIdentifier
(object)
-
- Changed items (object
GET
/issuers/{issuerId}/accounts/{accountReference}/statements/{cycleClosureDate}/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)-
New required properties:
postingAccountIdentifier
-
Added property
disputed
(boolean) -
Added property
printOnStatement
(boolean) -
Added property
cardAcceptorAddress
(string) -
Added property
cardAcceptorStateProvinceRegionCode
(string) -
Added property
postingAccountIdentifier
(object)
-
- Changed items (object
What's Deleted
No API deleted.
What's Deprecated
No API deprecated.
Mobile Payment Operations
Worldline proposes to Issuing banks to apply card digitization through its tokenization services.
Worldline proposes to Issuing banks to apply card digitization through its tokenization services. A “token” is a unique set of digits which replaces the usual card PAN number and lowers the payment card risk of compromise. Those tokens of real cards are shared in a secured way with mobile/wearable devices (smartphones with Apple pay or Samsung Pay solutions, watches for Garmin Pay, etc.) so that the cardholder can use them instead of the original card for proximity NFC payments with their devices. They can also be leveraged for the recurrent “Card-on-File” transactions (e.g. Netflix). Each context (devices, e-commerce merchants, etc.) will use a different token.
Our solution exposes a set of APIs to Issuers use cases.
Mobile Banking token provisioning support:
- APP-TO-APP AUTHENTICATION – In this use case, the model is used for Mobile banking App as authentication factor, for identification and verification step
- In App Provisioning – In this use case, Encrypted pass data (for Apple Pay) or payment instrument data (Google wallets) is generated for wallet activation
APP-TO-APP AUTHENTICATION
API Name: generate-crypto-otp
In case of App to App Authentication the cardholder is authenticated via the banking app and the issuer is required to generate a ‘Mobile Banking Authentication Code’ which is delivered via the wallet provider to VTS or MDES for final activation of the token. This Api is common to all Token Requestors, and can be requested by non-sensitive field, either on a specific token (TokenReferenceId), or on a specific card. The choice depends on implementation of mobile banking app.
This service lookup locally to retrieve card data, such as PAN and expiry dates, before computing the activation code, according to either VTS – App to App authentication, or MDES – App to App authentication. We assume that on this step, these data are known, as provisioning flow is already initiated, and on ‘step-up’ before activation.
If the request is done by card, this service requests I-TSP decoupling layer to retrieve card data before computing.
Flow diagram (request by token):
Request data
For Token Reference:
"URI":"https":{
"Root Path"
}"/itsp-add/v2/issuers/9999/tokens/DNITHE301733961114298690/generate-crypto-otp
Payload":{
"tokenProviderID":"VTS"
}
For Card Reference:
"
URI":"https":{
"Root Path"
}"/itsp-add/v2/issuers/9999/cards/52936061AAAP8026/generate-crypto-otp
Payload":{
"tokenProviderID":"MDES"
}
Response data
{
"responseMetadata": {
"correlationId": "QQI8qq6jIKq5gO78BocFzSSMI9cI2ReD",
"statusMessage": "OK",
"statusCode": 200,
"responseDateTime": "2023-01-18T14:15:40.323Z",
"timeTakenMs": 12
},
"data": {
"cryptoOTP": "TUJBQUMtMS0xLTdBRjI5MUM5MUYzRUQ0RUY5MkMxRDQ1RUZGMTI3QzFGOUFCQzEyMzQ3RQ=="
}
In App Provisioning
APPLE PUSH PROVISIONING
API Name: create-apple-tokenized-card
Background for Push Provisioning:
In case the cards are added via the banking app the issuer needs to generate the Payment Instrument Details to push the tokenization via the xPay wallet. In case of Apple Pay the issuer also has to add activation data for additional security. The Payment Instrument Details mainly contain the card number and the expiration date of the card which needs to be tokenized. The Payment Instrument Detail is pushed via the wallet server of the xPay based on the xPay interface specifications. The xPay wallet server than will forward it to VTS or MDES, and processed usually as a green flow.
Service provided by I-TSP for this purpose create-apple-tokenized-card (specific Apple variant), generates the complete Payment Data Payload for ApplePay, requested with non-sensitive card data. This service requests the Card Management System to retrieve card data, before computing the payload, according to either Visa or Mastercard flavors.
Note that Apple wallet returns Apple Certificate to mobile application. The validity of this certificate has to be controlled by Issuer (AC chain, dates, specific OID, CRL), and public key extracted, for addressing this service. They are duty of Issuer back-end. As I-TSP has no direct contractual agreement with Apple, there is no possibility to have details about format of Certificate data returned by Apple Wallet, as well as having valid test vectors. Nevertheless, Apple In-App Provisioning specification (document under NDA) gives details on this step.
Below a sample Java code to extract Public Key from Apple leaf certificate (X.509v3 / PEM format) before passing it to this I-TSP Api:
CertificateFactory certificateFactory = CertificateFactory.getInstance("X.509");
X509Certificate certificate = (X509Certificate) certificateFactory.generateCertificate(new ByteArrayInputStream(certificateBytes));
System.out.println(Base64.toBase64String(certificate.getPublicKey().getEncoded()));
Flow diagram:
Request data
"URI":"https":{
"Root Path"
}"/itsp-add/v2/issuers/9999/cards/52936061AAAP8026/create-apple-tokenized-card
Payload":{
"tokenProviderID":"VTS",
"nonce":"2E1DF468",
"nonceSignature":"401FE09091CE8CB9E8846199587E4417AAE9421F7E9BACB993C57A4E806C4F29716E350060769B0616A11164DF25229D56732A0A5BAEA388F284E5DA369BDA8A2510B86622720808FCA797AAAA8B4B2063",
"applePublicKey":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAELj5cz2uasEvnoi8/rM/ec8h+hxVTlKNIFUCKiWyhijdNrGaa879iIPyGN2f0r0dQfFvCIfxKGYdNrzm0B04+uA=="
}
Response data
{
"responseMetadata":{
"correlationId":"QQI8qq6jIKq5gO78BocFzSSMI9cI2ReD",
"statusMessage":"OK",
"statusCode":200,
"responseDateTime":"2023-01-18'T'14:15:40.323Z",
"timeTakenMs":12
},
"data":{
"encryptedPassData":"aFKevI11muy+D1roaD08NuF2HGnIN5LRKDOGC00nTnERWtkR2IzB6jxe55p8mMc10K3GEjhUPIN2/g4D0wYkzk1GMg9z...",
"activationData":"TUJQQUMtMS1GSy0xLS1UREVBLTgzQjlEOTdCMEEzM0FCRDk5RkQwQkI5NkEwMjM3NTEzNDNCMERDRDA3NTAyNTFFRTk1NTVBMzIzQUE1OTU1QjVGNjU3ODBERTZGNDk4NkI5",
"ephemeralPublicKey":"BPrz+LFGyvw3WbuveJ7rLOUKYC2S0lJXYVFXSUCjYTiiS/pT64+Wri3gp3QUIMx8W7mx+Iab5TMC2UDRqMknICY="
}
}
GOOGLE PUSH PROVISIONING
VTS Push Provisioning
API Name: create-vts-tokenized-card
Background for Push Provisioning:
In case the cards are added via the banking app the issuer needs to generate the Payment Instrument Details to push the tokenization via the xPay wallet. The Payment Instrument Details mainly contain the card number and the expiration date of the card which needs to be tokenized. The Payment Instrument Detail is pushed via the wallet server of the xPay based on the xPay interface specifications. The xPay wallet server than will forward it to VTS or MDES, and processed usually as a green flow.
Service provided by I-TSP for this purpose is create-vts-tokenized-card (generic per Visa specifications).It is used by all non-Apple wallets (for example by Google who calls structure Opaque Payment Data).
The following web service generates the complete Card Provisioning Payload as specified by VTS, requested with non-sensitive card data (issuerCardIdcardReference, that is a Surrogate of the PAN).
This service requests the Card Management System to retrieve card data, before computing the payload, according to Visa “Payment Instrument Details” structure for Push Provisioning.
Flow diagram:
Request data
URI: https://{Root Path}/itsp-add/v2/issuers/9999/cards/52936061AAAP8026/create-vts-tokenized-card
Payload :
{
"clientWalletAccountID": "Lejk2eFZ0gPe9DOFNDAhfHy3",
"clientWalletProvider": "40010075001",
"clientDeviceId": "rdtZyP8u4O5LkQFRgPAB-sHo",
"clientAppID": "de.issuerbanking.mobil",
"country": "DE"
}
Response data
{
"responseMetadata": {
"correlationId": "QQI8qq6jIKq5gO78BocFzSSMI9cI2ReD",
"statusMessage": "OK",
"statusCode": 200,
"responseDateTime": "2023-01-18'T'14:15:40.323Z",
"timeTakenMs": 12
},
"data": {
"paymentInstrumentDetails": "ewoiYWxnIjoiQTI1NkdDTUtXIiwKInR5cCI6IkpPU0UiLAoiaXYiOiJRYVNLdG1qSUpfYnF4OHpzIiwKInRhZyI6IkFweEpuSmJNeTU1OTMzeWZBTFJTY1E9PSIsCiJraWQiOiJOMVdHMThJM1QySDYwOFZHSUZLMjEzUDVKeXdjOFF2WGRUamVBRXR1azdMN0VwZHZ3IiwKImNoYW5uZWxTZWN1cml0eUNvbnRleHQiOiJTSEFSRURfU0VDUkVUIiwKImVuYyI6IkEyNTZHQ00iLAoiaWF0IjoiMTU4NjM1MDkxNCIKfQ.tYYvs2Cdn0qkVNnE5xDAgGkjx-sBQMP7sA-yj1diVL0.1vWxDYGJs5sPqoaa.LzoOgr97kxNUMZfoKdg8L6OsK3HHQvL2dJYRUddqfD-F90LwBNv24Gc5oOfTYuHSjSYqpP82YQcfhPOYexuW7vRWgwxEQo2tT6Vz4n3Zuy5vsT5OFLMSXtMmJpMqqh3ktvZo9D6NCjqzFlIMJFnUpxiX3dUrmUuCq4bGKxoY6C5KLBDhRo4pEyRsjMNugCVSrKTmAW-SnpFmyW8L066a1HfAQoPomMycZ5U26MPPN__x8k57fDycHn8a6BwWm4ssncJP1sHVPxIpmzGkA89g62n_gxIIWkajdA9tA6t9qaokKfL1wqhVvAch-TxhdLTNORhF_UzlZAILmTe3dsDeZlwy8VOzDpih_zo3Jjj5CYbDiR1yOwnjM35pcBByKouKwYTIxlo4L2Pnfk1QaaNjdVAvA4cPMwQSSymG0hUEZfXOjHBJVUyMAlBLZrwcOlkEwV7iQyusKBqT-j0Y9ULTfYoOv5FD_HMf6pNOcVUf5MqMHlONXurje_VaCU1KahR5_F3HB_YCM7Es74DjAtM-UDJ3YHsKX2aNEX5PbCcRophcVlpkgBC1VhUqgYz0Iytq0GkfFepqrGU0hLrk-CrOm9vNRE8.6T00_EU219IJBNreH7rMnQ"
}
}
MDES Push Provisioning
API Name: create-mdes-tokenized-card
Background for Push Provisioning:
In case the cards are added via the banking app the issuer needs to generate the Payment Instrument Details to push the tokenization via the xPay wallet. The Payment Instrument Details mainly contain the card number and the expiration date of the card which needs to be tokenized. The Payment Instrument Detail is pushed via the wallet server of the xPay based on the xPay interface specifications. The xPay wallet server then will forward it to VTS or MDES, and processed.
Service provided by I-TSP for this purpose is create-mdes-tokenized-card. It is used by all non-Apple wallets (for example by Google who calls structure Opaque Payment Data).
The following web service generates the complete Card Provisioning Payload as specified by MDES, requested with non-sensitive card data (issuerCardId, that is a Surrogate of the PAN).
This service requests Card Management system to retrieve card data, before computing the payload, according to Mastercard “Issuer Initiated Digitization Data” structure for Push Provisioning (Funding Account Info + Tokenization Authentication Value).
Flow diagram:
Request data
URI: https://{Root Path}/itsp-add/v2/issuers/9999/cards/52936061AAAP8026/create-mdes-tokenized-card
Payload :
{
"clientWalletProvider": "50120834693"
}
Response data
{
"responseMetadata":{
"correlationId":"QQI8qq6jIKq5gO78BocFzSSMI9cI2ReD",
"statusMessage":"OK",
"statusCode":200,
"responseDateTime":"2023-01-18'T'14:15:40.323Z",
"timeTakenMs":12
},
"data":{
"issuerInitiatedDigitizationData":{
"fundingAccountInfo":{
"encryptedPayload":{
"encryptedData":"4545433044323232363739304532433610DE1D1461475BEB6D815F31764DDC20298BD779FBE37EE5AB3CBDA9F9825E1DDE321469537FE461E824AA55BA67BF6A",
"publicKeyFingerprint":"4c4ead5927f0df8117f178eea9308daa58e27c2b",
"encryptedKey":"A1B2C3D4E5F6112233445566",
"oaepHashingAlgorithm":"SHA512",
"iv":"31323334353637383930313233343536"
}
},
"tokenizationAuthenticationValue":"\"ew0KICAgInZlcnNpb24iOiAiMyIsDQogICAic2lnbmF0dXJlQWxnb3JpdGhtIjogIlJTQS1TSEEyNTYiLA...”
}
}
}"
API version 2.14.0
Release Notes: : REST API V2 - 2.14.0
Version 2.13.2 to 2.14.0
What's New
POST
/search-transactions
Search transactions (beta)
This API allows to search transaction
What's Changed
POST
/issuers/{issuerId}/cards/declare-counterfeit-card
Request body :
-
New optional properties:
ccpFlag
-
Added property
fraudProcess
(string)
POST
/issuers/{issuerId}/credit-transfers/{endToEndId}/cancel
Response:
- Changed property
data
(objectCancelCreditTransferResponse
)- New required properties:
cancellationDate
- New required properties:
POST
/issuers/{issuerId}/direct-debits/{endToEndId}/cancel
Response:
- Changed property
data
(objectCancelDirectDebitResponse
)- New required properties:
cancellationDate
- New required properties:
POST
/issuers/{issuerId}/cards/block-all
Request body :
- Added property
fraudProcess
(string)
POST
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/block
Request body :
- Added property
fraudProcess
(string)
GET
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders/{orderReference}
Response:
- Changed property
data
(objectOrder
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
cardContract
(objectCardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Changed items (object
- Changed property
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Added property
POST
/issuers/{issuerId}/cards/{cardReference}/block
Request body :
- Added property
fraudProcess
(string)
GET
/issuers/{issuerId}/cards/{cardReference}/orders/{orderReference}
Response:
- Changed property
data
(objectOrder
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
cardContract
(objectCardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Changed items (object
- Changed property
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Added property
GET
/issuers/{issuerId}/cards/{cardReference}/blocking-information
Response:
- Changed property
data
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
GET
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/blocking-information
Response:
- Changed property
data
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
PATCH
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}
Request body :
- Added property
hierarchySelectedModels
(array)
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}
Response:
- Changed property
data
(objectAccount
)- Added property
hierarchySelectedModels
(array)
- Added property
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations/{operationId}
Response:
- Changed property
data
(objectOperation
)- Added property
transactionType
(string) - Changed property
pointOfService
(objectPointOfService
)- Added property
cardDataInputCapability
(string) - Added property
cardholderAuthenticationCapability
(string) - Added property
cardCaptureCapability
(string) - Added property
terminalOperatingEnvironment
(string) - Added property
cardholderPresentData
(string) - Added property
cardPresentData
(string) - Added property
cardDataInputMode
(string) - Added property
cardholderAuthenticationMethod
(string) - Added property
cardholderAuthenticationEntity
(string) - Added property
cardDataOutputCapability
(string) - Added property
terminalDataOutputCapability
(string) - Added property
pinCaptureCapability
(string)
- Added property
- Added property
PATCH
/issuers/{issuerId}/accounts/{accountReference}
Request body :
- Added property
hierarchySelectedModels
(array)
GET
/issuers/{issuerId}/accounts/{accountReference}
Response:
- Changed property
data
(objectAccount
)- Added property
hierarchySelectedModels
(array)
- Added property
GET
/issuers/{issuerId}/accounts/{accountReference}/operations/{operationId}
Response:
- Changed property
data
(objectOperation
)- Added property
transactionType
(string) - Changed property
pointOfService
(objectPointOfService
)- Added property
cardDataInputCapability
(string) - Added property
cardholderAuthenticationCapability
(string) - Added property
cardCaptureCapability
(string) - Added property
terminalOperatingEnvironment
(string) - Added property
cardholderPresentData
(string) - Added property
cardPresentData
(string) - Added property
cardDataInputMode
(string) - Added property
cardholderAuthenticationMethod
(string) - Added property
cardholderAuthenticationEntity
(string) - Added property
cardDataOutputCapability
(string) - Added property
terminalDataOutputCapability
(string) - Added property
pinCaptureCapability
(string)
- Added property
- Added property
GET
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}
Response:
- Changed property
data
(objectCard
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
cardContract
(objectCardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Changed items (object
- Changed property
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
GET
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/card-events
Response:
- Changed property
data
(array)- Changed items (object
CardEvent
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
GET
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders
Response:
- Changed property
data
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
cardContract
(objectCardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Changed items (object
- Changed property
- Added property
- Added property
- Changed items (object
GET
/issuers/{issuerId}/cards/{cardReference}
Response:
- Changed property
data
(objectCard
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
cardContract
(objectCardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Changed items (object
- Changed property
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
GET
/issuers/{issuerId}/cards/{cardReference}/card-events
Response:
- Changed property
data
(array)- Changed items (object
CardEvent
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
GET
/issuers/{issuerId}/cards/{cardReference}/orders
Response:
- Changed property
data
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
cardContract
(objectCardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Changed items (object
- Changed property
- Added property
- Added property
- Changed items (object
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Added property
transactionType
(string) - Changed property
pointOfService
(objectPointOfService
)- Added property
cardDataInputCapability
(string) - Added property
cardholderAuthenticationCapability
(string) - Added property
cardCaptureCapability
(string) - Added property
terminalOperatingEnvironment
(string) - Added property
cardholderPresentData
(string) - Added property
cardPresentData
(string) - Added property
cardDataInputMode
(string) - Added property
cardholderAuthenticationMethod
(string) - Added property
cardholderAuthenticationEntity
(string) - Added property
cardDataOutputCapability
(string) - Added property
terminalDataOutputCapability
(string) - Added property
pinCaptureCapability
(string)
- Added property
- Added property
- Changed items (object
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/last/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Added property
transactionType
(string) - Changed property
pointOfService
(objectPointOfService
)- Added property
cardDataInputCapability
(string) - Added property
cardholderAuthenticationCapability
(string) - Added property
cardCaptureCapability
(string) - Added property
terminalOperatingEnvironment
(string) - Added property
cardholderPresentData
(string) - Added property
cardPresentData
(string) - Added property
cardDataInputMode
(string) - Added property
cardholderAuthenticationMethod
(string) - Added property
cardholderAuthenticationEntity
(string) - Added property
cardDataOutputCapability
(string) - Added property
terminalDataOutputCapability
(string) - Added property
pinCaptureCapability
(string)
- Added property
- Added property
- Changed items (object
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/next/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Added property
transactionType
(string) - Changed property
pointOfService
(objectPointOfService
)- Added property
cardDataInputCapability
(string) - Added property
cardholderAuthenticationCapability
(string) - Added property
cardCaptureCapability
(string) - Added property
terminalOperatingEnvironment
(string) - Added property
cardholderPresentData
(string) - Added property
cardPresentData
(string) - Added property
cardDataInputMode
(string) - Added property
cardholderAuthenticationMethod
(string) - Added property
cardholderAuthenticationEntity
(string) - Added property
cardDataOutputCapability
(string) - Added property
terminalDataOutputCapability
(string) - Added property
pinCaptureCapability
(string)
- Added property
- Added property
- Changed items (object
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/{cycleClosureDate}/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Added property
transactionType
(string) - Changed property
pointOfService
(objectPointOfService
)- Added property
cardDataInputCapability
(string) - Added property
cardholderAuthenticationCapability
(string) - Added property
cardCaptureCapability
(string) - Added property
terminalOperatingEnvironment
(string) - Added property
cardholderPresentData
(string) - Added property
cardPresentData
(string) - Added property
cardDataInputMode
(string) - Added property
cardholderAuthenticationMethod
(string) - Added property
cardholderAuthenticationEntity
(string) - Added property
cardDataOutputCapability
(string) - Added property
terminalDataOutputCapability
(string) - Added property
pinCaptureCapability
(string)
- Added property
- Added property
- Changed items (object
GET
/issuers/{issuerId}/accounts/{accountReference}/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Added property
transactionType
(string) - Changed property
pointOfService
(objectPointOfService
)- Added property
cardDataInputCapability
(string) - Added property
cardholderAuthenticationCapability
(string) - Added property
cardCaptureCapability
(string) - Added property
terminalOperatingEnvironment
(string) - Added property
cardholderPresentData
(string) - Added property
cardPresentData
(string) - Added property
cardDataInputMode
(string) - Added property
cardholderAuthenticationMethod
(string) - Added property
cardholderAuthenticationEntity
(string) - Added property
cardDataOutputCapability
(string) - Added property
terminalDataOutputCapability
(string) - Added property
pinCaptureCapability
(string)
- Added property
- Added property
- Changed items (object
GET
/issuers/{issuerId}/accounts/{accountReference}/statements/last/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Added property
transactionType
(string) - Changed property
pointOfService
(objectPointOfService
)- Added property
cardDataInputCapability
(string) - Added property
cardholderAuthenticationCapability
(string) - Added property
cardCaptureCapability
(string) - Added property
terminalOperatingEnvironment
(string) - Added property
cardholderPresentData
(string) - Added property
cardPresentData
(string) - Added property
cardDataInputMode
(string) - Added property
cardholderAuthenticationMethod
(string) - Added property
cardholderAuthenticationEntity
(string) - Added property
cardDataOutputCapability
(string) - Added property
terminalDataOutputCapability
(string) - Added property
pinCaptureCapability
(string)
- Added property
- Added property
- Changed items (object
GET
/issuers/{issuerId}/accounts/{accountReference}/statements/next/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Added property
transactionType
(string) - Changed property
pointOfService
(objectPointOfService
)- Added property
cardDataInputCapability
(string) - Added property
cardholderAuthenticationCapability
(string) - Added property
cardCaptureCapability
(string) - Added property
terminalOperatingEnvironment
(string) - Added property
cardholderPresentData
(string) - Added property
cardPresentData
(string) - Added property
cardDataInputMode
(string) - Added property
cardholderAuthenticationMethod
(string) - Added property
cardholderAuthenticationEntity
(string) - Added property
cardDataOutputCapability
(string) - Added property
terminalDataOutputCapability
(string) - Added property
pinCaptureCapability
(string)
- Added property
- Added property
- Changed items (object
GET
/issuers/{issuerId}/accounts/{accountReference}/statements/{cycleClosureDate}/operations
Response:
- Changed property
data
(array)- Changed items (object
Operation
)- Added property
transactionType
(string) - Changed property
pointOfService
(objectPointOfService
)- Added property
cardDataInputCapability
(string) - Added property
cardholderAuthenticationCapability
(string) - Added property
cardCaptureCapability
(string) - Added property
terminalOperatingEnvironment
(string) - Added property
cardholderPresentData
(string) - Added property
cardPresentData
(string) - Added property
cardDataInputMode
(string) - Added property
cardholderAuthenticationMethod
(string) - Added property
cardholderAuthenticationEntity
(string) - Added property
cardDataOutputCapability
(string) - Added property
terminalDataOutputCapability
(string) - Added property
pinCaptureCapability
(string)
- Added property
- Added property
- Changed items (object
GET
/issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}
Response:
- Changed property
data
(objectCardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cards
Response:
- Changed property
data
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Changed items (object
GET
/issuers/{issuerId}/card-contracts/{cardContractReference}
Response:
- Changed property
data
(objectCardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/card-contracts/{cardContractReference}/cards
Response:
- Changed property
data
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Changed items (object
POST
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/block-and-replace
Request body :
- Changed property
blockCardRequest
(objectBlockCardRequest
)- Added property
fraudProcess
(string)
- Added property
- Changed property
replaceCardRequest
(objectReplaceCardRequest
)- Changed property
cardContract
(objectReplaceCardRequest.CardContract
)- Changed property
card
(objectReplaceCardRequest.CardContract.Card
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Changed property
- Changed property
GET
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/card-contract
Response:
- Changed property
data
(objectCardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Changed items (object
- Changed property
POST
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/replace
Request body :
- Changed property
cardContract
(objectReplaceCardRequest.CardContract
)- Changed property
card
(objectReplaceCardRequest.CardContract.Card
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Changed property
POST
/issuers/{issuerId}/cards/search
Response:
- Changed property
data
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Changed items (object
POST
/issuers/{issuerId}/cards/{cardReference}/block-and-replace
Request body :
- Changed property
blockCardRequest
(objectBlockCardRequest
)- Added property
fraudProcess
(string)
- Added property
- Changed property
replaceCardRequest
(objectReplaceCardRequest
)- Changed property
cardContract
(objectReplaceCardRequest.CardContract
)- Changed property
card
(objectReplaceCardRequest.CardContract.Card
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Changed property
- Changed property
GET
/issuers/{issuerId}/cards/{cardReference}/card-contract
Response:
- Changed property
data
(objectCardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Changed items (object
- Changed property
POST
/issuers/{issuerId}/cards/{cardReference}/replace
Request body :
- Changed property
cardContract
(objectReplaceCardRequest.CardContract
)- Changed property
card
(objectReplaceCardRequest.CardContract.Card
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Changed property
GET
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/accounts
Response:
- Changed property
data
(array)- Changed items (object
Account
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed items (object
GET
/issuers/{issuerId}/contracts/{contractReference}/accounts
Response:
- Changed property
data
(array)- Changed items (object
Account
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed items (object
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/accounts
Response:
- Changed property
data
(array)- Changed items (object
Account
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed items (object
GET
/issuers/{issuerId}/customers/{customerReference}/accounts
Response:
- Changed property
data
(array)- Changed items (object
Account
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed items (object
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/contract
Response:
- Changed property
data
(objectContract
)- Changed property
accounts
(array)- Changed items (object
Account
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed items (object
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/accounts/{accountReference}/contract
Response:
- Changed property
data
(objectContract
)- Changed property
accounts
(array)- Changed items (object
Account
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed items (object
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
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
hierarchySelectedModels
(array)
- Added property
- Changed items (object
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/card-contracts/{cardContractReference}/contract
Response:
- Changed property
data
(objectContract
)- Changed property
accounts
(array)- Changed items (object
Account
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed items (object
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/{accountReference}
Response:
- Changed property
data
(objectCorporateEmployeeAccountResponse
)- Changed property
account
(objectAccount
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Response:
- Changed property
data
(objectCorporateEmployeeAccountResponse
)- Changed property
account
(objectAccount
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Response:
- Changed property
data
(objectCorporateEmployeeAccountResponse
)- Changed property
account
(objectAccount
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/{accountReference}
Response:
- Changed property
data
(objectCorporateEmployeeAccountResponse
)- Changed property
account
(objectAccount
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}
Response:
- Changed property
data
(objectContract
)- Changed property
accounts
(array)- Changed items (object
Account
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed items (object
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/card-contracts
Response:
- Changed property
data
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Changed items (object
- Changed property
- Changed items (object
GET
/issuers/{issuerId}/contracts/{contractReference}
Response:
- Changed property
data
(objectContract
)- Changed property
accounts
(array)- Changed items (object
Account
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed items (object
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/contracts/{contractReference}/card-contracts
Response:
- Changed property
data
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Changed items (object
- Changed property
- Changed items (object
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/card-contracts
Response:
- Changed property
data
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Changed items (object
- Changed property
- Changed items (object
GET
/issuers/{issuerId}/customers/{customerReference}/card-contracts
Response:
- Changed property
data
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Changed items (object
- Changed property
- Changed items (object
GET
/issuers/{issuerId}/corporate-contracts/{contractReference}
Response:
- Changed property
data
(objectCorporateContract
)- Changed property
rootAccount
(objectAccount
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed property
corporateContractEntities
(array)- Changed items (object
CorporateContractEntity
)- Changed property
account
(objectAccount
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed property
- Changed items (object
- Changed property
corporateEmployeeAccounts
(array)- Changed items (object
CorporateEmployeeAccount
)- Changed property
account
(objectAccount
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
GET
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}
Response:
- Changed property
data
(objectCorporateContract
)- Changed property
rootAccount
(objectAccount
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed property
corporateContractEntities
(array)- Changed items (object
CorporateContractEntity
)- Changed property
account
(objectAccount
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed property
- Changed items (object
- Changed property
corporateEmployeeAccounts
(array)- Changed items (object
CorporateEmployeeAccount
)- Changed property
account
(objectAccount
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
POST
/issuers/{issuerId}/contracts/create-consumer-contract
Request body :
- Changed property
contract
(objectCreateConsumerContractRequest.Contract
)- Changed property
accountHierarchy
(objectCreateConsumerContractRequest.AccountHierarchy
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed property
- Changed property
addCardsAccounts
(objectCreateConsumerContractRequest.AddCardsAccounts
)- Changed property
cardContracts
(array)- Changed items (object
CreateConsumerContractRequest.CardContract
)- Added property
selectedModels
(array)
- Added property
- Changed items (object
- Changed property
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/add-cards-accounts
Request body :
- Changed property
cardContracts
(array)- Changed items (object
CreateConsumerContractRequest.CardContract
)- Added property
selectedModels
(array)
- Added property
- Changed items (object
POST
/issuers/{issuerId}/contracts/search
Response:
- Changed property
data
(array)- Changed items (object
Contract
)- Changed property
accounts
(array)- Changed items (object
Account
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed items (object
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
POST
/issuers/{issuerId}/contracts/{contractReference}/add-cards-accounts
Request body :
- Changed property
cardContracts
(array)- Changed items (object
CreateConsumerContractRequest.CardContract
)- Added property
selectedModels
(array)
- Added property
- Changed items (object
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
hierarchySelectedModels
(array)
- Added property
- Changed items (object
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
GET
/issuers/{issuerId}/customers/{customerReference}/contracts
Response:
- Changed property
data
(array)- Changed items (object
Contract
)- Changed property
accounts
(array)- Changed items (object
Account
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed items (object
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
GET
/issuers/{issuerId}/companies/{customerReference}/corporate-contracts
Response:
- Changed property
data
(array)- Changed items (object
CorporateContract
)- Changed property
rootAccount
(objectAccount
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed property
corporateContractEntities
(array)- Changed items (object
CorporateContractEntity
)- Changed property
account
(objectAccount
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed property
- Changed items (object
- Changed property
corporateEmployeeAccounts
(array)- Changed items (object
CorporateEmployeeAccount
)- Changed property
account
(objectAccount
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
GET
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/corporate-contracts
Response:
- Changed property
data
(array)- Changed items (object
CorporateContract
)- Changed property
rootAccount
(objectAccount
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed property
corporateContractEntities
(array)- Changed items (object
CorporateContractEntity
)- Changed property
account
(objectAccount
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed property
- Changed items (object
- Changed property
corporateEmployeeAccounts
(array)- Changed items (object
CorporateEmployeeAccount
)- Changed property
account
(objectAccount
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
POST
/search-corporate-contracts
Response:
- Changed property
data
(array)- Changed items (object
CorporateContract
)- Changed property
rootAccount
(objectAccount
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed property
corporateContractEntities
(array)- Changed items (object
CorporateContractEntity
)- Changed property
account
(objectAccount
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed property
- Changed items (object
- Changed property
corporateEmployeeAccounts
(array)- Changed items (object
CorporateEmployeeAccount
)- Changed property
account
(objectAccount
)- Added property
hierarchySelectedModels
(array)
- Added property
- Changed property
cardContracts
(array)- Changed items (object
CardContract
)- Changed property
cards
(array)- Changed items (object
Card
)- Added property
cardDeactivationRuleOverride
(string) - Changed property
statusHistory
(array)- Changed items (object
CardStatusHistory
)- Changed property
blockingInformation
(objectCardBlockingInformation
)- Added property
fraudProcess
(string)
- Added property
- Changed property
- Changed items (object
- Changed property
orders
(array)- Changed items (object
Order
)- Added property
waitingPin
(boolean) - Changed property
card
(objectCard
)- Added property
cardDeactivationRuleOverride
(string)
- Added property
- Added property
- Changed items (object
- Added property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
- Changed property
- Changed items (object
What's Deleted
No API deleted.
What's Deprecated
No API deprecated.
API version 2.13.2
Release Notes: : REST API V2 - 2.13.2
Version 2.13.1 to 2.13.2
What's New
GET
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/addon-subscriptions
List add-on services subscriptions for a corporate contract by external reference (beta)
Get addon service information by issuer contract external reference
POST
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/addon-subscriptions
Subscribe to add-on for a corporate contract by external reference (beta)
Subscribe addon by issuer contract external reference
GET
/issuers/{issuerId}/corporate-contracts/{contractReference}/addon-subscriptions
List add-on services subscriptions for a corporate contract (beta)
Get addon service information by contract reference
POST
/issuers/{issuerId}/corporate-contracts/{contractReference}/addon-subscriptions
Subscribe to add-on for a corporate contract (beta)
Subscribe addon by contract reference
POST
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/addon-subscriptions/unsubscribe
Unsubscribe add-on for a corporate contract by external reference (beta)
Unsubscribe addon by issuer contract external reference
POST
/issuers/{issuerId}/corporate-contracts/{contractReference}/addon-subscriptions/unsubscribe
Unsubscribe add-on for a corporate contract (beta)
Unsubscribe addon by contract reference
What's Changed
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-business-cases/{businessCaseId}
Response:
- Changed property
data
(objectGetBusinessCaseResponse
)- Added property
status
(string)
- Added property
GET
/issuers/{issuerId}/accounts/{accountReference}/authorization-business-cases/{businessCaseId}
Response:
- Changed property
data
(objectGetBusinessCaseResponse
)- Added property
status
(string)
- Added property
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-business-cases
Response:
- Changed property
data
(array)- Changed items (object
BusinessCase
)- Added property
status
(string)
- Added property
- Changed items (object
GET
/issuers/{issuerId}/accounts/{accountReference}/authorization-business-cases
Response:
- Changed property
data
(array)- Changed items (object
BusinessCase
)- Added property
status
(string)
- Added property
- Changed items (object
GET
/issuers/{issuerId}/accounts/{accountReference}/reserves
Response:
- Changed property
data
(array)- Changed items (object
BusinessCase
)- Added property
status
(string)
- Added property
- Changed items (object
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/reserves
Response:
- Changed property
data
(array)- Changed items (object
BusinessCase
)- Added property
status
(string)
- Added property
- Changed items (object
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
corporateContractAddOnsSubscriptions
(array)
- Added property
- Changed property
- Changed items (object
- Changed property
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
corporateContractAddOnsSubscriptions
(array)
- Added property
- Changed property
- Changed items (object
- Changed property
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
corporateContractAddOnsSubscriptions
(array)
- Added property
- Changed property
- Changed items (object
- Changed property
corporateEmployeeCards
(array)- Changed items (object
CreateCorporateContractRequest.CorporateEmployeeCard
)- Changed property
cardContract
(objectCreateCorporateContractRequest.CardContract
)- Added property
corporateContractAddOnsSubscriptions
(array)
- Added property
- Changed property
- Changed items (object
- Changed property
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
corporateContractAddOnsSubscriptions
(array)
- Added property
- Changed property
- Changed items (object
- Changed property
corporateEmployeeCards
(array)- Changed items (object
CreateCorporateContractRequest.CorporateEmployeeCard
)- Changed property
cardContract
(objectCreateCorporateContractRequest.CardContract
)- Added property
corporateContractAddOnsSubscriptions
(array)
- Added property
- Changed property
- Changed items (object
- Changed property
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
corporateContractAddOnsSubscriptions
(array)
- Added property
- Changed property
- Changed property
- Changed property
addCorporateEmployeeCardsAndAccounts
(array)- Changed items (object
CreateCorporateContractRequest.AddCorporateEmployeeCardsAndAccounts
)- Changed property
corporateEmployeeCards
(array)- Changed items (object
CreateCorporateContractRequest.CorporateEmployeeCard
)- Changed property
cardContract
(objectCreateCorporateContractRequest.CardContract
)- Added property
corporateContractAddOnsSubscriptions
(array)
- Added property
- Changed property
- Changed items (object
- Changed property
- Changed items (object
What's Deleted
No API deleted.
What's Deprecated
No API deprecated.