REST API V2 - 2.8.1

  • Version 2.8.0 to 2.8.1
  • What's New
  • What's Changed
  • What's Deleted
  • What's Deprecated

What's New

Cancel close card contract

POST /issuers/{issuerId}/card-contracts/{cardContractReference}/cancel-close

The API allows to cancel card contract closing. The main input fields are:

  • The issuer ID
  • The card contract for which the cancel closure is requested: It can be provided by using the card contract reference or the issuer card contract external reference.

Cancel close card contract

POST /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cancel-close

The API allows to cancel card contract closing. The main input fields are:

  • The issuer ID
  • The card contract for which the cancel closure is requested: It can be provided by using the card contract reference or the issuer card contract external reference.

Retrieve corporate contract by external contract ref

GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}

This API allows retrieving a particular corporate contract from its reference or its issuer external reference. The API response contains contract information such as:

  • contract identifier with the contract reference and the issuer external contract reference if previously provided
  • product change information if any, such as its current status (scheduled, done, cancelled), new product, new contract if it exists
  • embedded fields if requested such as list of all customers or identifiers linked to this contract (e.g. contract owner, root account owner, cardholder(s)), card contracts, cards

Modify Corporate contract by ext ref

PATCH /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}

The API allows to modify a corporate contract

Change paying account structure for a corporate contract

POST /issuers/{issuerId}/corporate-contracts/{contractReference}/change-paying-account

Change paying account structure for a corporate contract

POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/change-paying-account

The API allows to add an entity to a corporate contract identified by the Contract reference.

Modify Corporate contract

PATCH /issuers/{issuerId}/corporate-contracts/{contractReference}

The API allows to modify a corporate contract.

What's Changed

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations/{operationId}
Response:
  • Changed property data (object Operation)
    • Added property posDataCode (string)
    • Added property pointOfService (object)
    • Added property acquirerId (string)
    • Added property detailedFeeAmounts (array)
GET /issuers/{issuerId}/accounts/{accountReference}/operations/{operationId}
Response:
  • Changed property data (object Operation)
    • Added property posDataCode (string)
    • Added property pointOfService (object)
    • Added property acquirerId (string)
    • Added property detailedFeeAmounts (array)
POST /issuers/{issuerId}/cards/{cardReference}/create-emergency-card
Response:
  • Changed property data (object CreateEmergencyCardResponse)
    • Added property embossingName2ndLine (string)
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/create-emergency-card
Response:
  • Changed property data (object CreateEmergencyCardResponse)
    • Added property embossingName2ndLine (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}
Response:
  • Changed property data (object Account)
    • Added property defaultResetCreditLimit (string)
    • Added property lastImpactDate (string)
    • Added property coBrander (string)
    • Added property resetLimitBalance (object)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-history
Response:
  • Changed property data (array)
    • Changed items (object AccountHistory)
      • Added property noOtbCheck (boolean)
      • Added property resetCreditLimit (boolean)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations
Response:
  • Changed property data (array)
    • Changed items (object Operation)
      • Added property posDataCode (string)
      • Added property pointOfService (object)
      • Added property acquirerId (string)
      • Added property detailedFeeAmounts (array)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/last/operations
Response:
  • Changed property data (array)
    • Changed items (object Operation)
      • Added property posDataCode (string)
      • Added property pointOfService (object)
      • Added property acquirerId (string)
      • Added property detailedFeeAmounts (array)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/next/operations
Response:
  • Changed property data (array)
    • Changed items (object Operation)
      • Added property posDataCode (string)
      • Added property pointOfService (object)
      • Added property acquirerId (string)
      • Added property detailedFeeAmounts (array)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/{cycleClosureDate}/operations
Response:
  • Changed property data (array)
    • Changed items (object Operation)
      • Added property posDataCode (string)
      • Added property pointOfService (object)
      • Added property acquirerId (string)
      • Added property detailedFeeAmounts (array)
GET /issuers/{issuerId}/accounts/{accountReference}
Response:
  • Changed property data (object Account)
    • Added property defaultResetCreditLimit (string)
    • Added property lastImpactDate (string)
    • Added property coBrander (string)
    • Added property resetLimitBalance (object)
GET /issuers/{issuerId}/accounts/{accountReference}/account-history
Response:
  • Changed property data (array)
    • Changed items (object AccountHistory)
      • Added property noOtbCheck (boolean)
      • Added property resetCreditLimit (boolean)
GET /issuers/{issuerId}/accounts/{accountReference}/operations
Response:
  • Changed property data (array)
    • Changed items (object Operation)
      • Added property posDataCode (string)
      • Added property pointOfService (object)
      • Added property acquirerId (string)
      • Added property detailedFeeAmounts (array)
GET /issuers/{issuerId}/accounts/{accountReference}/statements/last/operations
Response:
  • Changed property data (array)
    • Changed items (object Operation)
      • Added property posDataCode (string)
      • Added property pointOfService (object)
      • Added property acquirerId (string)
      • Added property detailedFeeAmounts (array)
GET /issuers/{issuerId}/accounts/{accountReference}/statements/next/operations
Response:
  • Changed property data (array)
    • Changed items (object Operation)
      • Added property posDataCode (string)
      • Added property pointOfService (object)
      • Added property acquirerId (string)
      • Added property detailedFeeAmounts (array)
GET /issuers/{issuerId}/accounts/{accountReference}/statements/{cycleClosureDate}/operations
Response:
  • Changed property data (array)
    • Changed items (object Operation)
      • Added property posDataCode (string)
      • Added property pointOfService (object)
      • Added property acquirerId (string)
      • Added property detailedFeeAmounts (array)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/contract
Response:
  • Changed property data (object Contract)
    • Added property coBrander (string)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Added property defaultResetCreditLimit (string)
        • Added property lastImpactDate (string)
        • Added property coBrander (string)
        • Added property resetLimitBalance (object)
GET /issuers/{issuerId}/accounts/{accountReference}/contract
Response:
  • Changed property data (object Contract)
    • Added property coBrander (string)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Added property defaultResetCreditLimit (string)
        • Added property lastImpactDate (string)
        • Added property coBrander (string)
        • Added property resetLimitBalance (object)
GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/contract
Response:
  • Changed property data (object Contract)
    • Added property coBrander (string)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Added property defaultResetCreditLimit (string)
        • Added property lastImpactDate (string)
        • Added property coBrander (string)
        • Added property resetLimitBalance (object)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}/contract
Response:
  • Changed property data (object Contract)
    • Added property coBrander (string)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Added property defaultResetCreditLimit (string)
        • Added property lastImpactDate (string)
        • Added property coBrander (string)
        • Added property resetLimitBalance (object)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/{accountReference}
Response:
  • Changed property data (object CorporateEmployeeAccountResponse)
    • Changed property account (object Account)
      • Added property defaultResetCreditLimit (string)
      • Added property lastImpactDate (string)
      • Added property coBrander (string)
      • Added property resetLimitBalance (object)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Response:
  • Changed property data (object CorporateEmployeeAccountResponse)
    • Changed property account (object Account)
      • Added property defaultResetCreditLimit (string)
      • Added property lastImpactDate (string)
      • Added property coBrander (string)
      • Added property resetLimitBalance (object)
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Response:
  • Changed property data (object CorporateEmployeeAccountResponse)
    • Changed property account (object Account)
      • Added property defaultResetCreditLimit (string)
      • Added property lastImpactDate (string)
      • Added property coBrander (string)
      • Added property resetLimitBalance (object)
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/{accountReference}
Response:
  • Changed property data (object CorporateEmployeeAccountResponse)
    • Changed property account (object Account)
      • Added property defaultResetCreditLimit (string)
      • Added property lastImpactDate (string)
      • Added property coBrander (string)
      • Added property resetLimitBalance (object)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}
Parameters:

Added: embed in query

Response:
  • Changed property data (object CorporateContract)
    • Added property statusDate (string)
    • Added property contractCompanies (array)
    • Added property productIdentifier (object)
    • Deleted property accounts (array)
    • Deleted property cardContractIdentifiers (array)
    • Deleted property cardContracts (array)
    • Changed property corporateContractEntities (array)
      • Changed items (object CorporateContractEntity)
        • Added property account (object)
    • Changed property corporateEmployeeAccounts (array)
      • Changed items (object CorporateEmployeeAccount)
        • Added property account (object)
        • Added property parentCompanyEntityExternalReference (string)
        • Added property cardContracts (array)
        • Added property contractFee (object)
        • Deleted property contractFees (object)
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}
Response:
  • Changed property data (object Contract)
    • Added property coBrander (string)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Added property defaultResetCreditLimit (string)
        • Added property lastImpactDate (string)
        • Added property coBrander (string)
        • Added property resetLimitBalance (object)
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/accounts
Response:
  • Changed property data (array)
    • Changed items (object Account)
      • Added property defaultResetCreditLimit (string)
      • Added property lastImpactDate (string)
      • Added property coBrander (string)
      • Added property resetLimitBalance (object)
GET /issuers/{issuerId}/contracts/{contractReference}
Response:
  • Changed property data (object Contract)
    • Added property coBrander (string)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Added property defaultResetCreditLimit (string)
        • Added property lastImpactDate (string)
        • Added property coBrander (string)
        • Added property resetLimitBalance (object)
GET /issuers/{issuerId}/contracts/{contractReference}/accounts
Response:
  • Changed property data (array)
    • Changed items (object Account)
      • Added property defaultResetCreditLimit (string)
      • Added property lastImpactDate (string)
      • Added property coBrander (string)
      • Added property resetLimitBalance (object)
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/accounts
Response:
  • Changed property data (array)
    • Changed items (object Account)
      • Added property defaultResetCreditLimit (string)
      • Added property lastImpactDate (string)
      • Added property coBrander (string)
      • Added property resetLimitBalance (object)
GET /issuers/{issuerId}/customers/{customerReference}/accounts
Response:
  • Changed property data (array)
    • Changed items (object Account)
      • Added property defaultResetCreditLimit (string)
      • Added property lastImpactDate (string)
      • Added property coBrander (string)
      • Added property resetLimitBalance (object)
GET /issuers/{issuerId}/companies/{customerReference}/corporate-contracts
Response:
  • Changed property data (array)
    • Changed items (object CorporateContract)
      • Added property statusDate (string)
      • Added property contractCompanies (array)
      • Added property productIdentifier (object)
      • Deleted property accounts (array)
      • Deleted property cardContractIdentifiers (array)
      • Deleted property cardContracts (array)
      • Changed property corporateContractEntities (array)
        • Changed items (object CorporateContractEntity)
          • Added property account (object)
      • Changed property corporateEmployeeAccounts (array)
        • Changed items (object CorporateEmployeeAccount)
          • Added property account (object)
          • Added property parentCompanyEntityExternalReference (string)
          • Added property cardContracts (array)
          • Added property contractFee (object)
          • Deleted property contractFees (object)
GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/corporate-contracts
Response:
  • Changed property data (array)
    • Changed items (object CorporateContract)
      • Added property statusDate (string)
      • Added property contractCompanies (array)
      • Added property productIdentifier (object)
      • Deleted property accounts (array)
      • Deleted property cardContractIdentifiers (array)
      • Deleted property cardContracts (array)
      • Changed property corporateContractEntities (array)
        • Changed items (object CorporateContractEntity)
          • Added property account (object)
      • Changed property corporateEmployeeAccounts (array)
        • Changed items (object CorporateEmployeeAccount)
          • Added property account (object)
          • Added property parentCompanyEntityExternalReference (string)
          • Added property cardContracts (array)
          • Added property contractFee (object)
          • Deleted property contractFees (object)
POST /issuers/{issuerId}/contracts/search
Response:
  • Changed property data (array)
    • Changed items (object Contract)
      • Added property coBrander (string)
      • Changed property accounts (array)
        • Changed items (object Account)
          • Added property defaultResetCreditLimit (string)
          • Added property lastImpactDate (string)
          • Added property coBrander (string)
          • Added property resetLimitBalance (object)
POST /issuers/{issuerId}/contracts/{contractReference}/change-product
Request body:
  • New optional properties:
    • productChangeTrigger
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/change-product
Request body:
  • New optional properties:
    • productChangeTrigger
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contracts
Response:
  • Changed property data (array)
    • Changed items (object Contract)
      • Added property coBrander (string)
      • Changed property accounts (array)
        • Changed items (object Account)
          • Added property defaultResetCreditLimit (string)
          • Added property lastImpactDate (string)
          • Added property coBrander (string)
          • Added property resetLimitBalance (object)
GET /issuers/{issuerId}/customers/{customerReference}/contracts
Response:
  • Changed property data (array)
    • Changed items (object Contract)
      • Added property coBrander (string)
      • Changed property accounts (array)
        • Changed items (object Account)
          • Added property defaultResetCreditLimit (string)
          • Added property lastImpactDate (string)
          • Added property coBrander (string)
          • Added property resetLimitBalance (object)
POST /issuers/{issuerId}/contracts/create-consumer-contract
Request body:
  • Changed property contract (object CreateConsumerContractRequest.Contract)
    • Added property coBrander (string)

What's Deleted

Change paying account structure for a corporate contract

POST /issuers/{issuerId}/contracts/{contractReference}/change-paying-account

Change paying account structure for a corporate contract

POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/change-paying-account

What's Deprecated

 

No API deprecated.

Enable "on this page" menu on doc section
On