Release Notes: : REST API V2 - 2.13.1

REST API V2 - 2.13.1

Version 2.13.0 to 2.13.1

What's New

 

API Reference

POST /issuers/{issuerId}/contracts/{contractReference}/refund-fee-on-demand

Refund fee by contract reference (beta)

The API is used to trigger an on demand pro rata refund of Account Setup fee or Membership fee for the unutilised period

What's Changed

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-guarantor
Response:
  • Changed property data (object Customer)

    • Added property preferredCorrespondenceLanguage (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-owner
Response:
  • Changed property data (object Customer)

    • Added property preferredCorrespondenceLanguage (string)
GET /issuers/{issuerId}/accounts/{accountReference}/account-guarantor
Response:
  • Changed property data (object Customer)

    • Added property preferredCorrespondenceLanguage (string)
GET /issuers/{issuerId}/accounts/{accountReference}/account-owner
Response:
  • Changed property data (object Customer)

    • Added property preferredCorrespondenceLanguage (string)
GET /issuers/{issuerId}/companies/{customerReference}
Response:
  • Changed property data (object Company)

    • Added property preferredCorrespondenceLanguage (string)
    • Deleted property preferredCorrespondanceLanguage (string)
GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}
Response:
  • Changed property data (object Company)

    • Added property preferredCorrespondenceLanguage (string)
    • Deleted property preferredCorrespondanceLanguage (string)
GET /issuers/{issuerId}/companies/{customerReference}/addresses/{addressReference}
Response:
  • Changed property data (object Company)

    • Added property preferredCorrespondenceLanguage (string)
    • Deleted property preferredCorrespondanceLanguage (string)
GET /issuers/{issuerId}/companies/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}
Response:
  • Changed property data (object Company)

    • Added property preferredCorrespondenceLanguage (string)
    • Deleted property preferredCorrespondanceLanguage (string)
GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}
Response:
  • Changed property data (object Company)

    • Added property preferredCorrespondenceLanguage (string)
    • Deleted property preferredCorrespondanceLanguage (string)
GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}
Response:
  • Changed property data (object Company)

    • Added property preferredCorrespondenceLanguage (string)
    • Deleted property preferredCorrespondanceLanguage (string)
GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cardholder
Response:
  • Changed property data (object Customer)

    • Added property preferredCorrespondenceLanguage (string)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}/cardholder
Response:
  • Changed property data (object Customer)

    • Added property preferredCorrespondenceLanguage (string)
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/contract-owner
Response:
  • Changed property data (object Customer)

    • Added property preferredCorrespondenceLanguage (string)
GET /issuers/{issuerId}/contracts/{contractReference}/contract-owner
Response:
  • Changed property data (object Customer)

    • Added property preferredCorrespondenceLanguage (string)
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}
Response:
  • Changed property data (object Customer)

    • Added property preferredCorrespondenceLanguage (string)
GET /issuers/{issuerId}/customers/{customerReference}
Response:
  • Changed property data (object Customer)

    • Added property preferredCorrespondenceLanguage (string)
GET /issuers/{issuerId}/companies
Response:
  • Changed property data (array)

    • Changed items (object Company)

      • Added property preferredCorrespondenceLanguage (string)
      • Deleted property preferredCorrespondanceLanguage (string)
GET /issuers/{issuerId}/customers
Response:
  • Changed property data (array)

    • Changed items (object Customer)

      • Added property preferredCorrespondenceLanguage (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/contract
Response:
  • Changed property data (object Contract)

    • Changed property contractCustomers (array)

      • Changed items (object Customer)

        • Added property preferredCorrespondenceLanguage (string)
GET /issuers/{issuerId}/accounts/{accountReference}/contract
Response:
  • Changed property data (object Contract)

    • Changed property contractCustomers (array)

      • Changed items (object Customer)

        • Added property preferredCorrespondenceLanguage (string)
GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/contract
Response:
  • Changed property data (object Contract)

    • Changed property contractCustomers (array)

      • Changed items (object Customer)

        • Added property preferredCorrespondenceLanguage (string)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}/contract
Response:
  • Changed property data (object Contract)

    • Changed property contractCustomers (array)

      • Changed items (object Customer)

        • Added property preferredCorrespondenceLanguage (string)
POST /issuers/{issuerId}/corporate-contracts/{contractReference}/add-corporate-contract-entity
Request body :
  • Changed property companies (array)

    • Changed items (object CreateCorporateContractRequest.Company)

      • Added property preferredCorrespondenceLanguage (string)
      • Deleted property preferredCorrespondanceLanguage (string)
  • Changed property customers (array)
    • Changed items (object CreateCorporateContractRequest.Customer)

      • Added property preferredCorrespondenceLanguage (string)
      • Deleted property preferredCorrespondanceLanguage (string)
POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/add-corporate-contract-entity
Request body :
  • Changed property companies (array)

    • Changed items (object CreateCorporateContractRequest.Company)

      • Added property preferredCorrespondenceLanguage (string)
      • Deleted property preferredCorrespondanceLanguage (string)
  • Changed property customers (array)
    • Changed items (object CreateCorporateContractRequest.Customer)

      • Added property preferredCorrespondenceLanguage (string)
      • Deleted property preferredCorrespondanceLanguage (string)
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}
Response:
  • Changed property data (object Contract)

    • Changed property contractCustomers (array)

      • Changed items (object Customer)

        • Added property preferredCorrespondenceLanguage (string)
GET /issuers/{issuerId}/contracts/{contractReference}
Response:
  • Changed property data (object Contract)

    • Changed property contractCustomers (array)

      • Changed items (object Customer)

        • Added property preferredCorrespondenceLanguage (string)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}
Response:
  • Changed property data (object CorporateContract)

    • Changed property contractCompanies (array)

      • Changed items (object Company)

        • Added property preferredCorrespondenceLanguage (string)
        • Deleted property preferredCorrespondanceLanguage (string)
    • Changed property contractCustomers (array)
      • Changed items (object Customer)

        • Added property preferredCorrespondenceLanguage (string)
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}
Response:
  • Changed property data (object CorporateContract)

    • Changed property contractCompanies (array)

      • Changed items (object Company)

        • Added property preferredCorrespondenceLanguage (string)
        • Deleted property preferredCorrespondanceLanguage (string)
    • Changed property contractCustomers (array)
      • Changed items (object Customer)

        • Added property preferredCorrespondenceLanguage (string)
POST /issuers/{issuerId}/contracts/search
Response:
  • Changed property data (array)

    • Changed items (object Contract)

      • Changed property contractCustomers (array)

        • Changed items (object Customer)

          • Added property preferredCorrespondenceLanguage (string)
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contracts
Response:
  • Changed property data (array)

    • Changed items (object Contract)

      • Changed property contractCustomers (array)

        • Changed items (object Customer)

          • Added property preferredCorrespondenceLanguage (string)
GET /issuers/{issuerId}/customers/{customerReference}/contracts
Response:
  • Changed property data (array)

    • Changed items (object Contract)

      • Changed property contractCustomers (array)

        • Changed items (object Customer)

          • Added property preferredCorrespondenceLanguage (string)
GET /issuers/{issuerId}/companies/{customerReference}/corporate-contracts
Response:
  • Changed property data (array)

    • Changed items (object CorporateContract)

      • Changed property contractCompanies (array)

        • Changed items (object Company)

          • Added property preferredCorrespondenceLanguage (string)
          • Deleted property preferredCorrespondanceLanguage (string)
      • Changed property contractCustomers (array)
        • Changed items (object Customer)

          • Added property preferredCorrespondenceLanguage (string)
GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/corporate-contracts
Response:
  • Changed property data (array)

    • Changed items (object CorporateContract)

      • Changed property contractCompanies (array)

        • Changed items (object Company)

          • Added property preferredCorrespondenceLanguage (string)
          • Deleted property preferredCorrespondanceLanguage (string)
      • Changed property contractCustomers (array)
        • Changed items (object Customer)

          • Added property preferredCorrespondenceLanguage (string)
POST /search-corporate-contracts
Response:
  • Changed property data (array)

    • Changed items (object CorporateContract)

      • Changed property contractCompanies (array)

        • Changed items (object Company)

          • Added property preferredCorrespondenceLanguage (string)
          • Deleted property preferredCorrespondanceLanguage (string)
      • Changed property contractCustomers (array)
        • Changed items (object Customer)

          • Added property preferredCorrespondenceLanguage (string)
POST /issuers/{issuerId}/corporate-contracts/{contractReference}/add-corporate-employee-cards-accounts
Request body :
  • Changed property customers (array)

    • Changed items (object CreateCorporateContractRequest.Customer)

      • Added property preferredCorrespondenceLanguage (string)
      • Deleted property preferredCorrespondanceLanguage (string)
POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/add-corporate-employee-cards-accounts
Request body :
  • Changed property customers (array)

    • Changed items (object CreateCorporateContractRequest.Customer)

      • Added property preferredCorrespondenceLanguage (string)
      • Deleted property preferredCorrespondanceLanguage (string)
POST /issuers/{issuerId}/corporate-contracts/create-corporate-contract
Request body :
  • Changed property companies (array)

    • Changed items (object CreateCorporateContractRequest.Company)

      • Added property preferredCorrespondenceLanguage (string)
      • Deleted property preferredCorrespondanceLanguage (string)
  • Changed property customers (array)
    • Changed items (object CreateCorporateContractRequest.Customer)

      • Added property preferredCorrespondenceLanguage (string)
      • Deleted property preferredCorrespondanceLanguage (string)

What's Deleted

POST /issuers/{issuerId}/contract/{contractReference}/refund-fee-on-demand

Refund fee by contract reference (beta)

The API is used to trigger an on demand pro rata refund of Account Setup fee or Membership fee for the unutilised period

What's Deprecated

 

No API deprecated.

Enable "on this page" menu on doc section
On

Release Notes: REST API V2 - 2.13.0

REST API V2 - 2.13.0

Version 2.12.0 to 2.13.0

What's New

 

API Reference

POST /issuers/{issuerId}/customers/{customerReference}/addresses-and-subscriptions

Create address for a customer and subscribe to add-on (beta)

The API allows to create either a permanent address or a temporary address for the customer, identified with his reference, and to subscribe to an add-on service for a contract . An address includes the following information: • the issuer address external reference • the label (eg MAIN_POSTAL_ADDRESS), • the type (mail address, phone number, email) and the corresponding data • the address usages • the start date (optional, by default, the current date is used) • the end date (conditional, only used when defining a temporary address)

When creating a temporary address, If a temporary address already exists with an overlap on the activity period then only the newly created address will be kept and the old one will be removed.

For information, the main postal address is mandatory. In return, the API provides the address Reference calculated by the system.

 

POST /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses-and-subscriptions

Create address for a customer and subscribe to add-on by external reference (beta)

The API allows to create either a permanent address or a temporary address for the customer, identified with his reference, and to subscribe to an add-on service for a contract . An address includes the following information: • the issuer address external reference • the label (eg MAIN_POSTAL_ADDRESS), • the type (mail address, phone number, email) and the corresponding data • the address usages • the start date (optional, by default, the current date is used) • the end date (conditional, only used when defining a temporary address)

When creating a temporary address, If a temporary address already exists with an overlap on the activity period then only the newly created address will be kept and the old one will be removed.

For information, the main postal address is mandatory. In return, the API provides the address Reference calculated by the system.

 

POST /issuers/{issuerId}/corporate-contracts/{contractReference}/card-contracts/{cardContractReference}/reallocate

Reallocate employee (beta)

Reallocate employee by contract reference and card contract reference

 

POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/card-contracts/{cardContractReference}/reallocate

Reallocate employee by issuer contract external reference (beta)

Reallocate employee by issuer contract external reference and card contract reference

 

POST /issuers/{issuerId}/corporate-contracts/{contractReference}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/reallocate

Reallocate employee by issuer card contract external reference (beta)

Reallocate employee by contract reference and issuer card contract external reference

 

POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/reallocate

Reallocate employee by issuer contract external reference and issuer card contract external reference (beta)

Reallocate employee by issuer contract external reference and issuer card contract external reference

What's Changed

POST /issuers/{issuerId}/accounts/{accountReference}/account-future-updates/{futureChangeReference}/cancel
Response:
  • Changed property data (object CancelAccountFutureUpdateResponse)

    • New required properties:

      • updateStatus
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates/{futureChangeReference}/cancel
Response:
  • Changed property data (object CancelAccountFutureUpdateResponse)

    • New required properties:

      • updateStatus
PATCH /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates/{futureChangeReference}
Response:
  • Changed property data (object ModifyAccountFutureUpdateResponse)

    • New required properties:

      • accountFutureUpdateIdentifier
      • accountIdentifier
      • futureChangeDate
      • lastUpdateDate
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/temporary-credit-limits
Response:
  • Changed property data (object CreateTemporaryCreditLimitResponse)

    • New required properties:

      • accountIdentifier
      • activationEndTime
      • activationStartTime
      • root
      • temporaryCreditLimitAmount
      • temporaryCreditLimitIdentifier

    • Changed property relatedTemporaryCreditLimits (array)

      • Changed items (object RelatedTemporaryCreditLimit)

        • New required properties:

          • accountIdentifier
          • root
          • temporaryCreditLimitIdentifier
DELETE /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/temporary-credit-limits/{temporaryCreditLimitReference}
Response:
  • Changed property data (object DeleteTemporaryCreditLimitResponse)

    • New required properties:

      • accountIdentifier
      • root

    • Changed property relatedTemporaryCreditLimits (array)

      • Changed items (object RelatedTemporaryCreditLimit)

        • New required properties:

          • accountIdentifier
          • root
          • temporaryCreditLimitIdentifier
PATCH /issuers/{issuerId}/accounts/{accountReference}/account-future-updates/{futureChangeReference}
Response:
  • Changed property data (object ModifyAccountFutureUpdateResponse)

    • New required properties:

      • accountFutureUpdateIdentifier
      • accountIdentifier
      • futureChangeDate
      • lastUpdateDate
POST /issuers/{issuerId}/accounts/{accountReference}/temporary-credit-limits
Response:
  • Changed property data (object CreateTemporaryCreditLimitResponse)

    • New required properties:

      • accountIdentifier
      • activationEndTime
      • activationStartTime
      • root
      • temporaryCreditLimitAmount
      • temporaryCreditLimitIdentifier

    • Changed property relatedTemporaryCreditLimits (array)

      • Changed items (object RelatedTemporaryCreditLimit)

        • New required properties:

          • accountIdentifier
          • root
          • temporaryCreditLimitIdentifier
DELETE /issuers/{issuerId}/accounts/{accountReference}/temporary-credit-limits/{temporaryCreditLimitReference}
Response:
  • Changed property data (object DeleteTemporaryCreditLimitResponse)

    • New required properties:

      • accountIdentifier
      • root

    • Changed property relatedTemporaryCreditLimits (array)

      • Changed items (object RelatedTemporaryCreditLimit)

        • New required properties:

          • accountIdentifier
          • root
          • temporaryCreditLimitIdentifier
POST /issuers/{issuerId}/cards/{cardReference}/create-emergency-card
Response:
  • Changed property data (object CreateEmergencyCardResponse)

    • New required properties:

      • panReference
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/create-emergency-card
Response:
  • Changed property data (object CreateEmergencyCardResponse)

    • New required properties:

      • panReference
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}
Response:
  • Changed property data (object Account)

    • Added property originalAccountIdentifierType (string)
    • Added property changedAccountIdentifierType (string)
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates
Response:
  • Changed property data (object CreateAccountFutureUpdateResponse)

    • New required properties:

      • accountFutureUpdateIdentifier
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations/{operationId}
Response:
  • Changed property data (object Operation)

    • Added property schemeTransactionIdentifier (string)
GET /issuers/{issuerId}/accounts/{accountReference}
Response:
  • Changed property data (object Account)

    • Added property originalAccountIdentifierType (string)
    • Added property changedAccountIdentifierType (string)
POST /issuers/{issuerId}/accounts/{accountReference}/account-future-updates
Response:
  • Changed property data (object CreateAccountFutureUpdateResponse)

    • New required properties:

      • accountFutureUpdateIdentifier
GET /issuers/{issuerId}/accounts/{accountReference}/operations/{operationId}
Response:
  • Changed property data (object Operation)

    • Added property schemeTransactionIdentifier (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations
Response:
  • Changed property data (array)

    • Changed items (object Operation)

      • Added property schemeTransactionIdentifier (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/last/operations
Response:
  • Changed property data (array)

    • Changed items (object Operation)

      • Added property schemeTransactionIdentifier (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/next/operations
Response:
  • Changed property data (array)

    • Changed items (object Operation)

      • Added property schemeTransactionIdentifier (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/{cycleClosureDate}/operations
Response:
  • Changed property data (array)

    • Changed items (object Operation)

      • Added property schemeTransactionIdentifier (string)
GET /issuers/{issuerId}/accounts/{accountReference}/operations
Response:
  • Changed property data (array)

    • Changed items (object Operation)

      • Added property schemeTransactionIdentifier (string)
GET /issuers/{issuerId}/accounts/{accountReference}/statements/last/operations
Response:
  • Changed property data (array)

    • Changed items (object Operation)

      • Added property schemeTransactionIdentifier (string)
GET /issuers/{issuerId}/accounts/{accountReference}/statements/next/operations
Response:
  • Changed property data (array)

    • Changed items (object Operation)

      • Added property schemeTransactionIdentifier (string)
GET /issuers/{issuerId}/accounts/{accountReference}/statements/{cycleClosureDate}/operations
Response:
  • Changed property data (array)

    • Changed items (object Operation)

      • Added property schemeTransactionIdentifier (string)
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/accounts
Response:
  • Changed property data (array)

    • Changed items (object Account)

      • Added property originalAccountIdentifierType (string)
      • Added property changedAccountIdentifierType (string)
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/close
Response:
  • Changed property data (object CloseContractResponse)

    • Changed property contract (object CloseContractResponse.Contract)

      • Changed property cardContracts (array)

        • Changed items (object CloseContractResponse.CardContract)

          • Changed property cards (array)

            • Changed items (object CloseContractResponse.Card)

              • New required properties:

                • panReference
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/suspend
Response:
  • Changed property data (object SuspendContractResponse)

    • Changed property contract (object SuspendContractResponse.Contract)

      • Changed property cardContracts (array)

        • Changed items (object SuspendContractResponse.CardContract)

          • Changed property cards (array)

            • Changed items (object SuspendContractResponse.Card)

              • New required properties:

                • panReference
GET /issuers/{issuerId}/contracts/{contractReference}/accounts
Response:
  • Changed property data (array)

    • Changed items (object Account)

      • Added property originalAccountIdentifierType (string)
      • Added property changedAccountIdentifierType (string)
POST /issuers/{issuerId}/contracts/{contractReference}/close
Response:
  • Changed property data (object CloseContractResponse)

    • Changed property contract (object CloseContractResponse.Contract)

      • Changed property cardContracts (array)

        • Changed items (object CloseContractResponse.CardContract)

          • Changed property cards (array)

            • Changed items (object CloseContractResponse.Card)

              • New required properties:

                • panReference
POST /issuers/{issuerId}/contracts/{contractReference}/suspend
Response:
  • Changed property data (object SuspendContractResponse)

    • Changed property contract (object SuspendContractResponse.Contract)

      • Changed property cardContracts (array)

        • Changed items (object SuspendContractResponse.CardContract)

          • Changed property cards (array)

            • Changed items (object SuspendContractResponse.Card)

              • New required properties:

                • panReference
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/accounts
Response:
  • Changed property data (array)

    • Changed items (object Account)

      • Added property originalAccountIdentifierType (string)
      • Added property changedAccountIdentifierType (string)
GET /issuers/{issuerId}/customers/{customerReference}/accounts
Response:
  • Changed property data (array)

    • Changed items (object Account)

      • Added property originalAccountIdentifierType (string)
      • Added property changedAccountIdentifierType (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/contract
Response:
  • Changed property data (object Contract)

    • Changed property accounts (array)

      • Changed items (object Account)

        • Added property originalAccountIdentifierType (string)
        • Added property changedAccountIdentifierType (string)
GET /issuers/{issuerId}/accounts/{accountReference}/contract
Response:
  • Changed property data (object Contract)

    • Changed property accounts (array)

      • Changed items (object Account)

        • Added property originalAccountIdentifierType (string)
        • Added property changedAccountIdentifierType (string)
GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/contract
Response:
  • Changed property data (object Contract)

    • Changed property accounts (array)

      • Changed items (object Account)

        • Added property originalAccountIdentifierType (string)
        • Added property changedAccountIdentifierType (string)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}/contract
Response:
  • Changed property data (object Contract)

    • Changed property accounts (array)

      • Changed items (object Account)

        • Added property originalAccountIdentifierType (string)
        • Added property changedAccountIdentifierType (string)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/{accountReference}
Response:
  • Changed property data (object CorporateEmployeeAccountResponse)

    • Changed property account (object Account)

      • Added property originalAccountIdentifierType (string)
      • Added property changedAccountIdentifierType (string)
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 originalAccountIdentifierType (string)
      • Added property changedAccountIdentifierType (string)
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 originalAccountIdentifierType (string)
      • Added property changedAccountIdentifierType (string)
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 originalAccountIdentifierType (string)
      • Added property changedAccountIdentifierType (string)
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}
Response:
  • Changed property data (object Contract)

    • Changed property accounts (array)

      • Changed items (object Account)

        • Added property originalAccountIdentifierType (string)
        • Added property changedAccountIdentifierType (string)
GET /issuers/{issuerId}/contracts/{contractReference}
Response:
  • Changed property data (object Contract)

    • Changed property accounts (array)

      • Changed items (object Account)

        • Added property originalAccountIdentifierType (string)
        • Added property changedAccountIdentifierType (string)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}
Response:
  • Changed property data (object CorporateContract)

    • Changed property rootAccount (object Account)

      • Added property originalAccountIdentifierType (string)
      • Added property changedAccountIdentifierType (string)
    • Changed property corporateContractEntities (array)
      • Changed items (object CorporateContractEntity)

        • Changed property account (object Account)

          • Added property originalAccountIdentifierType (string)
          • Added property changedAccountIdentifierType (string)
    • Changed property corporateEmployeeAccounts (array)
      • Changed items (object CorporateEmployeeAccount)

        • Changed property account (object Account)

          • Added property originalAccountIdentifierType (string)
          • Added property changedAccountIdentifierType (string)
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}
Response:
  • Changed property data (object CorporateContract)

    • Changed property rootAccount (object Account)

      • Added property originalAccountIdentifierType (string)
      • Added property changedAccountIdentifierType (string)
    • Changed property corporateContractEntities (array)
      • Changed items (object CorporateContractEntity)

        • Changed property account (object Account)

          • Added property originalAccountIdentifierType (string)
          • Added property changedAccountIdentifierType (string)
    • Changed property corporateEmployeeAccounts (array)
      • Changed items (object CorporateEmployeeAccount)

        • Changed property account (object Account)

          • Added property originalAccountIdentifierType (string)
          • Added property changedAccountIdentifierType (string)
POST /issuers/{issuerId}/contracts/search
Response:
  • Changed property data (array)

    • Changed items (object Contract)

      • Changed property accounts (array)

        • Changed items (object Account)

          • Added property originalAccountIdentifierType (string)
          • Added property changedAccountIdentifierType (string)
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contracts
Response:
  • Changed property data (array)

    • Changed items (object Contract)

      • Changed property accounts (array)

        • Changed items (object Account)

          • Added property originalAccountIdentifierType (string)
          • Added property changedAccountIdentifierType (string)
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 originalAccountIdentifierType (string)
          • Added property changedAccountIdentifierType (string)
GET /issuers/{issuerId}/companies/{customerReference}/corporate-contracts
Response:
  • Changed property data (array)

    • Changed items (object CorporateContract)

      • Changed property rootAccount (object Account)

        • Added property originalAccountIdentifierType (string)
        • Added property changedAccountIdentifierType (string)
      • Changed property corporateContractEntities (array)
        • Changed items (object CorporateContractEntity)

          • Changed property account (object Account)

            • Added property originalAccountIdentifierType (string)
            • Added property changedAccountIdentifierType (string)
      • Changed property corporateEmployeeAccounts (array)
        • Changed items (object CorporateEmployeeAccount)

          • Changed property account (object Account)

            • Added property originalAccountIdentifierType (string)
            • Added property changedAccountIdentifierType (string)
GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/corporate-contracts
Response:
  • Changed property data (array)

    • Changed items (object CorporateContract)

      • Changed property rootAccount (object Account)

        • Added property originalAccountIdentifierType (string)
        • Added property changedAccountIdentifierType (string)
      • Changed property corporateContractEntities (array)
        • Changed items (object CorporateContractEntity)

          • Changed property account (object Account)

            • Added property originalAccountIdentifierType (string)
            • Added property changedAccountIdentifierType (string)
      • Changed property corporateEmployeeAccounts (array)
        • Changed items (object CorporateEmployeeAccount)

          • Changed property account (object Account)

            • Added property originalAccountIdentifierType (string)
            • Added property changedAccountIdentifierType (string)
POST /search-corporate-contracts
Response:
  • Changed property data (array)

    • Changed items (object CorporateContract)

      • Changed property rootAccount (object Account)

        • Added property originalAccountIdentifierType (string)
        • Added property changedAccountIdentifierType (string)
      • Changed property corporateContractEntities (array)
        • Changed items (object CorporateContractEntity)

          • Changed property account (object Account)

            • Added property originalAccountIdentifierType (string)
            • Added property changedAccountIdentifierType (string)
      • Changed property corporateEmployeeAccounts (array)
        • Changed items (object CorporateEmployeeAccount)

          • Changed property account (object Account)

            • Added property originalAccountIdentifierType (string)
            • Added property changedAccountIdentifierType (string)

What's Deleted

POST /issuers/{issuerId}/customers/{customerReference}/addressesAndSubscriptions

Create address for a customer and subscribe to add-on (beta)

The API allows to create either a permanent address or a temporary address for the customer, identified with his reference, and to subscribe to an add-on service for a contract . An address includes the following information: • the issuer address external reference • the label (eg MAIN_POSTAL_ADDRESS), • the type (mail address, phone number, email) and the corresponding data • the address usages • the start date (optional, by default, the current date is used) • the end date (conditional, only used when defining a temporary address)

When creating a temporary address, If a temporary address already exists with an overlap on the activity period then only the newly created address will be kept and the old one will be removed.

For information, the main postal address is mandatory. In return, the API provides the address Reference calculated by the system.

 

POST /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addressesAndSubscriptions

Create address for a customer and subscribe to add-on (beta)

The API allows to create either a permanent address or a temporary address for the customer, identified with his reference, and to subscribe to an add-on service for a contract . An address includes the following information: • the issuer address external reference • the label (eg MAIN_POSTAL_ADDRESS), • the type (mail address, phone number, email) and the corresponding data • the address usages • the start date (optional, by default, the current date is used) • the end date (conditional, only used when defining a temporary address)

When creating a temporary address, If a temporary address already exists with an overlap on the activity period then only the newly created address will be kept and the old one will be removed.

For information, the main postal address is mandatory. In return, the API provides the address Reference calculated by the system.

What's Deprecated

 

No API deprecated.

Enable "on this page" menu on doc section
On

ob-p-ideal-refund

Refund Processing

Refunds are reversal transactions wherein complete or partial money is moved back to customer’s source account (account from which actual payment was made). Refund can only be created for a successful or settled transaction: 

  • Customer initiated refunds (returns or cancellation) - e.g. if the Customer has changed his mind about consumption of product pre/post order delivery.
  • Initiating Party initiated refunds - e.g. if a product/service is out of stock or there is a mismatch in transaction status between payment and Initiating Party wherein transaction is failed state at merchant's end but is successful at payments end. 

For the refund processing the data from the original iDEAL request / response are used, so that the resulting refund transaction can be reconciled with the original transaction.

Offline Refunds

As part of the transaction processing we offer a secure Offline Refund Processing (via API's or the Backoffice). The activity diagram below describes the process. 

Refund option for iDEAL

The Backoffice GUI can be used to register and export refunds to a pain.001 file. This pain.001 file has to be provided to the bank of the merchant. This delivery is not done by the Open Banking Service, therefore this refund method is named 'offline'.

Enable "on this page" menu on doc section
On

ob-p-a2a-refund

Refund Processing

Refunds are reversal transactions wherein complete or partial money is moved back to customer’s source account (account from which actual payment was made). Refund can only be created for a successful or settled transaction: 

  • Customer initiated refunds (returns or cancellation) - e.g. if the Customer has changed his mind about consumption of product pre/post order delivery.
  • Initiating Party initiated refunds - e.g. if a product/service is out of stock or there is a mismatch in transaction status between payment and Initiating Party wherein transaction is failed state at merchant's end but is successful at payments end. 

For the refund processing the data from the original Account-to-Account request / response are used, so that the resulting refund transaction can be reconciled with the original transaction.

As part of the transaction processing we offer a secure Refund Processing Online (via API's) or Offline (via API's or the Backoffice). The activity diagram below describes the difference between those two processes. Note: Online and Offline refunds both offer API's, those API's are different.

Refund options

Please note: The Refund processing allows either Online or Offline Refunds.

Online Refunds 

Endpoint: POST /refunds

Use the API's to initiate payments of refunds. Multiple refunds can be payed in one go, if the merchant bank supports bulk-payments.

Offline Refunds

The Backoffice GUI can be used to register and export refunds to a pain.001 file. This pain.001 file has to be provided to the bank of the merchant. This delivery is not done by the Open Banking Service, therefore this refund method is named 'offline'.

Enable "on this page" menu on doc section
On

ob-data-ais-notification

Notification API

API Reference

The Push Notification APIs described in this chapter need to be implemented on the Initiating Party side, if the Initiating Party decides to use them. The Open Banking Service will post notifications to these endpoints.

POST Status

Endpoint: POST /status

This API will notify the initiating party about the status of the consent. A different request will be sent for the Payment and Data. More details about the fields can be found in the API reference.

Request Data (ConsentDetailedInformation)

Post status request data

Response

HTML 204 (No Content)

Post status response

 

Enable "on this page" menu on doc section
On

ob-data-overview

Data Overview

Account Data Products

Our Account Data Products allow to get banking data of your clients based on account holder's consent.

For faster integration and better user experience we offer a set of predefined screens that could be customised with your branding allowing to choose the user bank and handling the complexity of different PSD2 authorization flows (redirect / decoupled / embedded), so that you will be able to focus on your product and leave the boring stuff to us.

Depending on the implemented product, the consent can be for one-time or for ongoing up to approximately 6 months access  to the data. Once the consent is expired you can prompt the user to renew the consent to ensure uninterrupted data access.

The data retrieved also depends on the implemented product and could consist of account details (e.g. account name or IBAN), balances and the list of transactions. 

Whenever a recurring consent is granted, you can access the information as many times per day as needed as long as the user is actively using your software. In case you would like to perform a background data refresh, you can do so up to 4 times per day by either polling the banking data and identifying the new transactions by yourself or by letting Worldline to pull the updated banking data multiple times per day based on a predefined schedule, comparing the results to historical data and notifying you only on the differences.

To implement Bank  Connect, Account Validation or Business Financial Management products, please review Account information section. We have a dedicated section for Credit Insight implementation.

Need help?

Please get in touch with us and we will  help you to integrate our APIs.

Enable "on this page" menu on doc section
On

Release Notes: REST API V2 - 2.12.0

REST API V2 - 2.12.0

Version 2.11.2 to 2.12.0

What's New

 

API Reference

PATCH /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates/{futureChangeReference}

Update future changes of the account by external reference (beta)

Update future changes of the account by future change reference

 

PATCH /issuers/{issuerId}/accounts/{accountReference}/account-future-updates/{futureChangeReference}

Update future changes of the account (beta)

Update future changes of the account by future change reference

 

What's Changed

 

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/balance
Response:
  • Changed property data (object AccountBalance)

    • Added property activeCreditLimit (object)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/credit-limit
Response:
  • Changed property data (object CreditLimit)

    • Added property startDate (string)
DELETE /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/temporary-credit-limits/{temporaryCreditLimitReference}
Response:
  • Changed property data (object DeleteTemporaryCreditLimitResponse)

    • Added property accountIdentifier (object)
    • Added property root (boolean)
    • Added property relatedTemporaryCreditLimits (array)
GET /issuers/{issuerId}/accounts/{accountReference}/balance
Response:
  • Changed property data (object AccountBalance)

    • Added property activeCreditLimit (object)
GET /issuers/{issuerId}/accounts/{accountReference}/credit-limit
Response:
  • Changed property data (object CreditLimit)

    • Added property startDate (string)
DELETE /issuers/{issuerId}/accounts/{accountReference}/temporary-credit-limits/{temporaryCreditLimitReference}
Response:
  • Changed property data (object DeleteTemporaryCreditLimitResponse)

    • Added property accountIdentifier (object)
    • Added property root (boolean)
    • Added property relatedTemporaryCreditLimits (array)
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/temporary-credit-limits
Response:
  • Changed property data (object CreateTemporaryCreditLimitResponse)

    • Added property accountIdentifier (object)
    • Added property root (boolean)
    • Added property relatedTemporaryCreditLimits (array)
POST /issuers/{issuerId}/accounts/{accountReference}/temporary-credit-limits
Response:
  • Changed property data (object CreateTemporaryCreditLimitResponse)

    • Added property accountIdentifier (object)
    • Added property root (boolean)
    • Added property relatedTemporaryCreditLimits (array)
POST /issuers/{issuerId}/cards/{cardReference}/create-emergency-card
Response:
  • Changed property data (object CreateEmergencyCardResponse)

    • New required properties:

      • embossingName
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/create-emergency-card
Response:
  • Changed property data (object CreateEmergencyCardResponse)

    • New required properties:

      • embossingName
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations/{operationId}
Parameters:

Changed: embed in query

Response:
  • Changed property data (object Operation)

    • Added property destinationId (string)
    • Added property lodgingInformation (object)
    • Added property carRentalInformation (object)
    • Added property airItineraryInformation (object)
GET /issuers/{issuerId}/accounts/{accountReference}/operations/{operationId}
Parameters:

Changed: embed in query

Response:
  • Changed property data (object Operation)

    • Added property destinationId (string)
    • Added property lodgingInformation (object)
    • Added property carRentalInformation (object)
    • Added property airItineraryInformation (object)
POST /issuers/{issuerId}/contracts/{contractReference}/cancel-product-change
Request body :
  • Added property feeReimbursementAtCardContractClosingForChangedContract (boolean)
  • Deleted property feeReimbursementAtCardContractClosingForNewContract (boolean)
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/cancel-product-change
Request body :
  • Added property feeReimbursementAtCardContractClosingForChangedContract (boolean)
  • Deleted property feeReimbursementAtCardContractClosingForNewContract (boolean)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations
Parameters:

Changed: embed in query

Response:
  • Changed property data (array)

    • Changed items (object Operation)

      • Added property destinationId (string)
      • Added property lodgingInformation (object)
      • Added property carRentalInformation (object)
      • Added property airItineraryInformation (object)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/last/operations
Response:
  • Changed property data (array)

    • Changed items (object Operation)

      • Added property destinationId (string)
      • Added property lodgingInformation (object)
      • Added property carRentalInformation (object)
      • Added property airItineraryInformation (object)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/next/operations
Response:
  • Changed property data (array)

    • Changed items (object Operation)

      • Added property destinationId (string)
      • Added property lodgingInformation (object)
      • Added property carRentalInformation (object)
      • Added property airItineraryInformation (object)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/{cycleClosureDate}/operations
Response:
  • Changed property data (array)

    • Changed items (object Operation)

      • Added property destinationId (string)
      • Added property lodgingInformation (object)
      • Added property carRentalInformation (object)
      • Added property airItineraryInformation (object)
GET /issuers/{issuerId}/accounts/{accountReference}/operations
Parameters:

Changed: embed in query

Response:
  • Changed property data (array)

    • Changed items (object Operation)

      • Added property destinationId (string)
      • Added property lodgingInformation (object)
      • Added property carRentalInformation (object)
      • Added property airItineraryInformation (object)
GET /issuers/{issuerId}/accounts/{accountReference}/statements/last/operations
Response:
  • Changed property data (array)

    • Changed items (object Operation)

      • Added property destinationId (string)
      • Added property lodgingInformation (object)
      • Added property carRentalInformation (object)
      • Added property airItineraryInformation (object)
GET /issuers/{issuerId}/accounts/{accountReference}/statements/next/operations
Response:
  • Changed property data (array)

    • Changed items (object Operation)

      • Added property destinationId (string)
      • Added property lodgingInformation (object)
      • Added property carRentalInformation (object)
      • Added property airItineraryInformation (object)
GET /issuers/{issuerId}/accounts/{accountReference}/statements/{cycleClosureDate}/operations
Response:
  • Changed property data (array)

    • Changed items (object Operation)

      • Added property destinationId (string)
      • Added property lodgingInformation (object)
      • Added property carRentalInformation (object)
      • Added property airItineraryInformation (object)
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/suspend
Response:
  • Changed property data (object SuspendContractResponse)

    • Changed property contract (object SuspendContractResponse.Contract)

      • Changed property cardContracts (array)

        • Changed items (object SuspendContractResponse.CardContract)

          • Added property blockingRenewalReasonCode (string)
          • Added property blockingReplacementReasonCode (string)
POST /issuers/{issuerId}/contracts/{contractReference}/suspend
Response:
  • Changed property data (object SuspendContractResponse)

    • Changed property contract (object SuspendContractResponse.Contract)

      • Changed property cardContracts (array)

        • Changed items (object SuspendContractResponse.CardContract)

          • Added property blockingRenewalReasonCode (string)
          • Added property blockingReplacementReasonCode (string)
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/card-contracts
Parameters:

Added: embed in query

GET /issuers/{issuerId}/customers/{customerReference}/card-contracts
Parameters:

Added: embed in query

What's Deleted

 

No API deleted.

 

What's Deprecated

 

No API deprecated.

Enable "on this page" menu on doc section
On

Release Notes: REST API V2 - 2.11.2

REST API V2 - 2.11.2

Version 2.11.1 to 2.11.2

 

What's New

 

API Reference

No new API.

What's Changed

POST /issuers/{issuerId}/contracts/{contractReference}/cancel-product-change
Request body (required -> optional) 
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/cancel-product-change
Request body (required -> optional) 

What's Deleted

 

No API deleted.

 

What's Deprecated

 

No API deprecated.

Enable "on this page" menu on doc section
On
Subscribe to