REST API V2 - 2.10.1

  • Version 2.10.0 to 2.10.1
  • What's New
  • What's Changed
  • What's Deleted
  • What's Deprecated

What's New

Post a Bonus operation for an account (beta)

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-bonus-operation

The API is used to post manually a Bonus operation to an account. A Bonus operation is used to reward or adjust a given account (in credit or in debit, e.g. in case of too high, too low or missing reward). As an input it must be provided

  • the account, identified either by its account reference generated by WL or its issuer external account reference, on which the bonus operation has to be posted
  • the related Bonus program, defined for the issuer and the account
  • the Bonus operation itself, uniquely identified by its external reference, date and service poster, its amount in currency (monetary) or loyalty point kind (non monetary) Note:
  • for monetary bonus the provided currency must be the same than the posting account, for non monetary bonus the provided loyalty point unit must be allowed by the Bonus program
  • it is possible to post credit and debit bonus operation If the Bonus operation is related to an existing initial operation, this latter can be provided. As a result the Bonus operation is posted to the account. Monetary bonus has an immediate impact on the account balance.

Reverse a Bonus operation for an account (beta)

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/reverse-bonus-operation

The API is used to fully reverse a Bonus operation previously posted on an account. As an input it must be provided

  • the account, identified either by its account reference generated by WL or its issuer external account reference, on which the bonus operation was previously posted
  • the Bonus operation to be reversed
  • the information related to the reversal operation (reference, date, service poster)

Post a Bonus operation for an account (beta)

POST /issuers/{issuerId}/accounts/{accountReference}/post-bonus-operation

The API is used to post manually a Bonus operation to an account. A Bonus operation is used to reward or adjust a given account (in credit or in debit, e.g. in case of too high, too low or missing reward). As an input it must be provided

  • the account, identified either by its account reference generated by WL or its issuer external account reference, on which the bonus operation has to be posted
  • the related Bonus program, defined for the issuer and the account
  • the Bonus operation itself, uniquely identified by its external reference, date and service poster, its amount in currency (monetary) or loyalty point kind (non monetary) Note:
  • for monetary bonus the provided currency must be the same than the posting account, for non monetary bonus the provided loyalty point unit must be allowed by the Bonus program
  • it is possible to post credit and debit bonus operation If the Bonus operation is related to an existing initial operation, this latter can be provided. As a result the Bonus operation is posted to the account. Monetary bonus has an immediate impact on the account balance.

Reverse a Bonus operation for an account (beta)

POST /issuers/{issuerId}/accounts/{accountReference}/reverse-bonus-operation

The API is used to fully reverse a Bonus operation previously posted on an account. As an input it must be provided

  • the account, identified either by its account reference generated by WL or its issuer external account reference, on which the bonus operation was previously posted
  • the Bonus operation to be reversed
  • the information related to the reversal operation (reference, date, service poster)

Create a new WL Message subscription

POST /issuers/{issuerId}/subscriptions

Search for subscriptions (with non-pci search terms)

GET /issuers/{issuerId}/subscriptions/search

Retrieve subscription by reference

GET /issuers/{issuerId}/subscriptions/{subscriptionReference}

Modify subscription by reference

PUT /issuers/{issuerId}/subscriptions/{subscriptionReference}

Delete subscription by reference

DELETE /issuers/{issuerId}/subscriptions/{subscriptionReference}

Retrieve services by subscription reference

GET /issuers/{issuerId}/subscriptions/{subscriptionReference}/services

Create new service subscription

POST /issuers/{issuerId}/subscriptions/{subscriptionReference}/services

Retrieve services for a subscription

GET /issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}

Modify subscription service by reference

PUT /issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}

Delete subscription service by reference

DELETE /issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}

Retrieve subscritpion events by subscription service reference

GET /issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}/events

Create new event subscription

POST /issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}/events

Retrieve event for a subscription service

GET /issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}/events/{subscriptionEventReference}

Modify subscription event by reference

PUT /issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}/events/{subscriptionEventReference}

Delete subscription event by reference

DELETE /issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}/events/{subscriptionEventReference}

What's Changed

Retrieve card by external reference

GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}
Parameters:

Changed: embed in query

Response:
  • Changed property data (object Card)

    • Added property orders (array)
    • Changed property cardContract (object CardContract)

      • Changed property cards (array)

        • Changed items (object Card)

          • Added property orders (array)

Retrieve card order by external reference

GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders/{orderReference}
Response:
  • Changed property data (object Order)

    • Added property notExtractedReason (string)
    • Added property notExtractedUpdateDate (string)
    • Changed property card (object Card)

      • Added property orders (array)
      • Changed property cardContract (object CardContract)

        • Changed property cards (array)

          • Changed items (object Card)

            • Added property orders (array)

Retrieve card

GET /issuers/{issuerId}/cards/{cardReference}
Parameters:

Changed: embed in query

Response:
  • Changed property data (object Card)

    • Added property orders (array)
    • Changed property cardContract (object CardContract)

      • Changed property cards (array)

        • Changed items (object Card)

          • Added property orders (array)

Retrieve card order

GET /issuers/{issuerId}/cards/{cardReference}/orders/{orderReference}
Response:
  • Changed property data (object Order)

    • Added property notExtractedReason (string)
    • Added property notExtractedUpdateDate (string)
    • Changed property card (object Card)

      • Added property orders (array)
      • Changed property cardContract (object CardContract)

        • Changed property cards (array)

          • Changed items (object Card)

            • Added property orders (array)

Request credit instalment model simulation

POST /issuers/{issuerId}/credit-instalments/simulate
Response:
  • Changed property data (object CreditInstalmentSimulationResponse)

    • New required properties:

      • simulationDetails
    • Changed property simulationDetails (array)

      • Changed items (object CreditInstalmentSimulationResponseSimulationDetails)

        • New required properties:

          • instalmentModelReference
          • instalmentTerm
          • interestRate
          • monthlyRepaymentAmount
          • totalInterestAmount

Retrieve customer address by customer external reference and address external reference

GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}
Response:
  • Changed property data (object Address)

    • Added property temporary (boolean)

Retrieve customer address by customer external reference

GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}
Response:
  • Changed property data (object Address)

    • Added property temporary (boolean)

Retrieve customer address by address external reference

GET /issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}
Response:
  • Changed property data (object Address)

    • Added property temporary (boolean)

Retrieve customer address

GET /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}
Response:
  • Changed property data (object Address)

    • Added property temporary (boolean)

Retrieve account by external reference

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

    • Added property hierarchyBonusProgramReferences (array)
    • Added property openCycleInformation (object)

Retrieve account guarantor for an account by external reference

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

    • Changed property addresses (array)

      • Changed items (object Address)

        • Added property temporary (boolean)

Retrieve account owner for an account by external reference

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

    • Changed property addresses (array)

      • Changed items (object Address)

        • Added property temporary (boolean)

Retrieve operation by external reference

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

    • Added property loyaltyPoint (object)
    • Added property rewardedOperationIdentifier (object)

Create velocity limit override by external account reference

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/velocity-limits/{velocityLimitReference}/velocity-limit-overrides
Request body:
  • New optional properties:

    • velocityLimitOverrideIdentifier
  • Deleted property velocityLimitOverrideIdentifier (object)

Retrieve account

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

    • Added property hierarchyBonusProgramReferences (array)
    • Added property openCycleInformation (object)

Retrieve account guarantor for an account

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

    • Changed property addresses (array)

      • Changed items (object Address)

        • Added property temporary (boolean)

Retrieve account owner for an account

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

    • Changed property addresses (array)

      • Changed items (object Address)

        • Added property temporary (boolean)

Retrieve operation

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

    • Added property loyaltyPoint (object)
    • Added property rewardedOperationIdentifier (object)

Create velocity limit override

POST /issuers/{issuerId}/accounts/{accountReference}/velocity-limits/{velocityLimitReference}/velocity-limit-overrides
Request body:
  • New optional properties:

    • velocityLimitOverrideIdentifier
  • Deleted property velocityLimitOverrideIdentifier (object)

Retrieve company's information (beta)

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

    • Changed property addresses (array)

      • Changed items (object Address)

        • Added property temporary (boolean)

Retrieve company information by external reference (beta)

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

    • Changed property addresses (array)

      • Changed items (object Address)

        • Added property temporary (boolean)

Create address for a company customer (beta)

POST /issuers/{issuerId}/companies/{customerReference}/addresses
Request body:
  • Added property endDate (string)
  • Added property temporary (boolean)

Retrieve company's Address information list (beta)

GET /issuers/{issuerId}/companies/{customerReference}/addresses
Response:
  • Changed property data (array)

    • Changed items (object Address)

      • Added property temporary (boolean)

Retrieve company's address information by address ref (beta)

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

    • Changed property addresses (array)

      • Changed items (object Address)

        • Added property temporary (boolean)

Retrieve company's address information by address external reference (beta)

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

    • Changed property addresses (array)

      • Changed items (object Address)

        • Added property temporary (boolean)

Create address for a company by external reference (beta)

POST /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses
Request body:
  • Added property endDate (string)
  • Added property temporary (boolean)

Retrieve company's Address information list by external reference (beta)

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

    • Changed items (object Address)

      • Added property temporary (boolean)

Retrieve address information by company external reference (beta)

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

    • Changed property addresses (array)

      • Changed items (object Address)

        • Added property temporary (boolean)

Retrieve address information by company external reference and address external reference (beta)

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

    • Changed property addresses (array)

      • Changed items (object Address)

        • Added property temporary (boolean)

Retrieve card contract by external reference

GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}
Response:
  • Changed property data (object CardContract)

    • Changed property cards (array)

      • Changed items (object Card)

        • Added property orders (array)

Retrieve cardholder for a card contract by external reference

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

    • Changed property addresses (array)

      • Changed items (object Address)

        • Added property temporary (boolean)

List cards for card contract by external reference

GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cards
Response:
  • Changed property data (array)

    • Changed items (object Card)

      • Added property orders (array)

Retrieve card contract

GET /issuers/{issuerId}/card-contracts/{cardContractReference}
Response:
  • Changed property data (object CardContract)

    • Changed property cards (array)

      • Changed items (object Card)

        • Added property orders (array)

Retrieve cardholder for a card contract

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

    • Changed property addresses (array)

      • Changed items (object Address)

        • Added property temporary (boolean)

List cards for card contract

GET /issuers/{issuerId}/card-contracts/{cardContractReference}/cards
Response:
  • Changed property data (array)

    • Changed items (object Card)

      • Added property orders (array)

Retrieve card contract for a card by external reference

GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/card-contract
Response:
  • Changed property data (object CardContract)

    • Changed property cards (array)

      • Changed items (object Card)

        • Added property orders (array)

List orders for a card by external reference

GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders
Response:
  • Changed property data (array)

    • Changed items (object Order)

      • Added property notExtractedReason (string)
      • Added property notExtractedUpdateDate (string)
      • Changed property card (object Card)

        • Added property orders (array)
        • Changed property cardContract (object CardContract)

          • Changed property cards (array)

            • Changed items (object Card)

              • Added property orders (array)

Retrieve card by cardNumber and sequenceNumber and expiryDate

POST /issuers/{issuerId}/cards/search
Parameters:

Changed: embed in query

Response:
  • Changed property data (array)

    • Changed items (object Card)

      • Added property orders (array)

Retrieve card contract for a card

GET /issuers/{issuerId}/cards/{cardReference}/card-contract
Response:
  • Changed property data (object CardContract)

    • Changed property cards (array)

      • Changed items (object Card)

        • Added property orders (array)

List orders for a card

GET /issuers/{issuerId}/cards/{cardReference}/orders
Response:
  • Changed property data (array)

    • Changed items (object Order)

      • Added property notExtractedReason (string)
      • Added property notExtractedUpdateDate (string)
      • Changed property card (object Card)

        • Added property orders (array)
        • Changed property cardContract (object CardContract)

          • Changed property cards (array)

            • Changed items (object Card)

              • Added property orders (array)

Retrieve contract owner for a contract by external reference

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

    • Changed property addresses (array)

      • Changed items (object Address)

        • Added property temporary (boolean)

Retrieve contract owner for a contract

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

    • Changed property addresses (array)

      • Changed items (object Address)

        • Added property temporary (boolean)

Create credit instalment contract

POST /issuers/{issuerId}/credit-instalments/
Request body:
  • New required properties:

    • payingAccountIdentifier
    • receivingAccountIdentifier
  • New optional properties:

    • instalmentModelReference

Retrieve customer by external reference

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

    • Changed property addresses (array)

      • Changed items (object Address)

        • Added property temporary (boolean)

Create address for a customer by external reference

POST /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses
Request body:
  • Added property endDate (string)
  • Added property temporary (boolean)

List addresses for a customer by external reference

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

    • Changed items (object Address)

      • Added property temporary (boolean)

Retrieve customer

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

    • Changed property addresses (array)

      • Changed items (object Address)

        • Added property temporary (boolean)

Create address for a customer

POST /issuers/{issuerId}/customers/{customerReference}/addresses
Request body:
  • Added property endDate (string)
  • Added property temporary (boolean)

List addresses for a customer

GET /issuers/{issuerId}/customers/{customerReference}/addresses
Response:
  • Changed property data (array)

    • Changed items (object Address)

      • Added property temporary (boolean)

Retrieve contract for an account by external reference

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

    • Changed property numberOfFreeCardsMembershipFee (integer-int64 -> integer-int32)
    • Changed property numberOfFreeCardsAccountSetupFee (integer-int64 -> integer-int32)
    • Changed property accounts (array)
      • Changed items (object Account)

        • Added property hierarchyBonusProgramReferences (array)
        • Added property openCycleInformation (object)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)

        • Changed property cards (array)

          • Changed items (object Card)

            • Added property orders (array)
    • Changed property contractCustomers (array)
      • Changed items (object Customer)

        • Changed property addresses (array)

          • Changed items (object Address)

            • Added property temporary (boolean)

List operations for an account by external reference

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

    • Changed items (object Operation)

      • Added property loyaltyPoint (object)
      • Added property rewardedOperationIdentifier (object)

List operations for last account statement by external reference

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

    • Changed items (object Operation)

      • Added property loyaltyPoint (object)
      • Added property rewardedOperationIdentifier (object)

List operations for next account statement by external reference

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

    • Changed items (object Operation)

      • Added property loyaltyPoint (object)
      • Added property rewardedOperationIdentifier (object)

List operations for an account statement by external reference

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

    • Changed items (object Operation)

      • Added property loyaltyPoint (object)
      • Added property rewardedOperationIdentifier (object)

Retrieve contract for an account

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

    • Changed property numberOfFreeCardsMembershipFee (integer-int64 -> integer-int32)
    • Changed property numberOfFreeCardsAccountSetupFee (integer-int64 -> integer-int32)
    • Changed property accounts (array)
      • Changed items (object Account)

        • Added property hierarchyBonusProgramReferences (array)
        • Added property openCycleInformation (object)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)

        • Changed property cards (array)

          • Changed items (object Card)

            • Added property orders (array)
    • Changed property contractCustomers (array)
      • Changed items (object Customer)

        • Changed property addresses (array)

          • Changed items (object Address)

            • Added property temporary (boolean)

List operations for an account

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

    • Changed items (object Operation)

      • Added property loyaltyPoint (object)
      • Added property rewardedOperationIdentifier (object)

List operations for last account statement

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

    • Changed items (object Operation)

      • Added property loyaltyPoint (object)
      • Added property rewardedOperationIdentifier (object)

List operations for next account statement

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

    • Changed items (object Operation)

      • Added property loyaltyPoint (object)
      • Added property rewardedOperationIdentifier (object)

List operations for an account statement

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

    • Changed items (object Operation)

      • Added property loyaltyPoint (object)
      • Added property rewardedOperationIdentifier (object)

Retrieve list of company's information (beta)

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

    • Changed items (object Company)

      • Changed property addresses (array)

        • Changed items (object Address)

          • Added property temporary (boolean)

Retrieve contract for a card contract by external reference

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

    • Changed property numberOfFreeCardsMembershipFee (integer-int64 -> integer-int32)
    • Changed property numberOfFreeCardsAccountSetupFee (integer-int64 -> integer-int32)
    • Changed property accounts (array)
      • Changed items (object Account)

        • Added property hierarchyBonusProgramReferences (array)
        • Added property openCycleInformation (object)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)

        • Changed property cards (array)

          • Changed items (object Card)

            • Added property orders (array)
    • Changed property contractCustomers (array)
      • Changed items (object Customer)

        • Changed property addresses (array)

          • Changed items (object Address)

            • Added property temporary (boolean)

Retrieve contract for a card contract

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

    • Changed property numberOfFreeCardsMembershipFee (integer-int64 -> integer-int32)
    • Changed property numberOfFreeCardsAccountSetupFee (integer-int64 -> integer-int32)
    • Changed property accounts (array)
      • Changed items (object Account)

        • Added property hierarchyBonusProgramReferences (array)
        • Added property openCycleInformation (object)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)

        • Changed property cards (array)

          • Changed items (object Card)

            • Added property orders (array)
    • Changed property contractCustomers (array)
      • Changed items (object Customer)

        • Changed property addresses (array)

          • Changed items (object Address)

            • Added property temporary (boolean)

Retrieve corporate employee Accounts (beta)

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

    • Changed property account (object Account)

      • Added property hierarchyBonusProgramReferences (array)
      • Added property openCycleInformation (object)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)

        • Changed property cards (array)

          • Changed items (object Card)

            • Added property orders (array)

Retrieve corporate employee accounts by account external reference (beta)

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 hierarchyBonusProgramReferences (array)
      • Added property openCycleInformation (object)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)

        • Changed property cards (array)

          • Changed items (object Card)

            • Added property orders (array)

Retrieve corporate employee Accounts by contract external reference and account external reference (beta)

GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Response:
  • Changed property data (object CorporateEmployeeAccountResponse)

    • Changed property account (object Account)

      • Added property hierarchyBonusProgramReferences (array)
      • Added property openCycleInformation (object)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)

        • Changed property cards (array)

          • Changed items (object Card)

            • Added property orders (array)

Retrieve corporate employee Accounts by contract external reference (beta)

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 hierarchyBonusProgramReferences (array)
      • Added property openCycleInformation (object)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)

        • Changed property cards (array)

          • Changed items (object Card)

            • Added property orders (array)

Update contract by external reference

PATCH /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}
Request body:
  • Changed property numberOfFreeCardsMembershipFee (integer-int64 -> integer-int32)
  • Changed property numberOfFreeCardsAccountSetupFee (integer-int64 -> integer-int32)

Retrieve contract by external reference

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

    • Changed property numberOfFreeCardsMembershipFee (integer-int64 -> integer-int32)
    • Changed property numberOfFreeCardsAccountSetupFee (integer-int64 -> integer-int32)
    • Changed property accounts (array)
      • Changed items (object Account)

        • Added property hierarchyBonusProgramReferences (array)
        • Added property openCycleInformation (object)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)

        • Changed property cards (array)

          • Changed items (object Card)

            • Added property orders (array)
    • Changed property contractCustomers (array)
      • Changed items (object Customer)

        • Changed property addresses (array)

          • Changed items (object Address)

            • Added property temporary (boolean)

List accounts for contract by external reference

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

    • Changed items (object Account)

      • Added property hierarchyBonusProgramReferences (array)
      • Added property openCycleInformation (object)

List card contracts for contract by external reference

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 orders (array)

Update addresses of all customers linked to the contract by external reference

POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/update-all-customers-addresses
Request body:
  • Changed property addresses (array)

    • Changed items (object ModifyContractCustomersAddressesRequest.Address)

      • Added property invalid (boolean)

Update contract

PATCH /issuers/{issuerId}/contracts/{contractReference}
Request body:
  • Changed property numberOfFreeCardsMembershipFee (integer-int64 -> integer-int32)
  • Changed property numberOfFreeCardsAccountSetupFee (integer-int64 -> integer-int32)

Retrieve contract

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

    • Changed property numberOfFreeCardsMembershipFee (integer-int64 -> integer-int32)
    • Changed property numberOfFreeCardsAccountSetupFee (integer-int64 -> integer-int32)
    • Changed property accounts (array)
      • Changed items (object Account)

        • Added property hierarchyBonusProgramReferences (array)
        • Added property openCycleInformation (object)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)

        • Changed property cards (array)

          • Changed items (object Card)

            • Added property orders (array)
    • Changed property contractCustomers (array)
      • Changed items (object Customer)

        • Changed property addresses (array)

          • Changed items (object Address)

            • Added property temporary (boolean)

List accounts for contract

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

    • Changed items (object Account)

      • Added property hierarchyBonusProgramReferences (array)
      • Added property openCycleInformation (object)

List card contracts for contract

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 orders (array)

Update addresses of all customers linked to the contract

POST /issuers/{issuerId}/contracts/{contractReference}/update-all-customers-addresses
Request body:
  • Changed property addresses (array)

    • Changed items (object ModifyContractCustomersAddressesRequest.Address)

      • Added property invalid (boolean)

Retrieve list of customer's information

GET /issuers/{issuerId}/customers
Response:
  • Changed property data (array)

    • Changed items (object Customer)

      • Changed property addresses (array)

        • Changed items (object Address)

          • Added property temporary (boolean)

List accounts for account owner by external reference

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

    • Changed items (object Account)

      • Added property hierarchyBonusProgramReferences (array)
      • Added property openCycleInformation (object)

List card contracts for cardholder by external reference

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 orders (array)

List accounts for account owner

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

    • Changed items (object Account)

      • Added property hierarchyBonusProgramReferences (array)
      • Added property openCycleInformation (object)

List card contracts for cardholder

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 orders (array)

Retrieve corporate contract (beta)

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

    • Changed property contractCustomers (array)

      • Changed items (object Customer)

        • Changed property addresses (array)

          • Changed items (object Address)

            • Added property temporary (boolean)
    • Changed property contractCompanies (array)
      • Changed items (object Company)

        • Changed property addresses (array)

          • Changed items (object Address)

            • Added property temporary (boolean)
    • Changed property corporateContractEntities (array)
      • Changed items (object CorporateContractEntity)

        • Changed property account (object Account)

          • Added property hierarchyBonusProgramReferences (array)
          • Added property openCycleInformation (object)
    • Changed property corporateEmployeeAccounts (array)
      • Changed items (object CorporateEmployeeAccount)

        • Changed property account (object Account)

          • Added property hierarchyBonusProgramReferences (array)
          • Added property openCycleInformation (object)
        • Changed property cardContracts (array)
          • Changed items (object CardContract)

            • Changed property cards (array)

              • Changed items (object Card)

                • Added property orders (array)

Retrieve corporate contract by external reference (beta)

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

    • Changed property contractCustomers (array)

      • Changed items (object Customer)

        • Changed property addresses (array)

          • Changed items (object Address)

            • Added property temporary (boolean)
    • Changed property contractCompanies (array)
      • Changed items (object Company)

        • Changed property addresses (array)

          • Changed items (object Address)

            • Added property temporary (boolean)
    • Changed property corporateContractEntities (array)
      • Changed items (object CorporateContractEntity)

        • Changed property account (object Account)

          • Added property hierarchyBonusProgramReferences (array)
          • Added property openCycleInformation (object)
    • Changed property corporateEmployeeAccounts (array)
      • Changed items (object CorporateEmployeeAccount)

        • Changed property account (object Account)

          • Added property hierarchyBonusProgramReferences (array)
          • Added property openCycleInformation (object)
        • Changed property cardContracts (array)
          • Changed items (object CardContract)

            • Changed property cards (array)

              • Changed items (object Card)

                • Added property orders (array)

Retrieve contracts by criteria

POST /issuers/{issuerId}/contracts/search
Parameters:

Changed: embed in query

Response:
  • Changed property data (array)

    • Changed items (object Contract)

      • Changed property numberOfFreeCardsMembershipFee (integer-int64 -> integer-int32)
      • Changed property numberOfFreeCardsAccountSetupFee (integer-int64 -> integer-int32)
      • Changed property accounts (array)
        • Changed items (object Account)

          • Added property hierarchyBonusProgramReferences (array)
          • Added property openCycleInformation (object)
      • Changed property cardContracts (array)
        • Changed items (object CardContract)

          • Changed property cards (array)

            • Changed items (object Card)

              • Added property orders (array)
      • Changed property contractCustomers (array)
        • Changed items (object Customer)

          • Changed property addresses (array)

            • Changed items (object Address)

              • Added property temporary (boolean)

List contracts for contract owner by external reference

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

    • Changed items (object Contract)

      • Changed property numberOfFreeCardsMembershipFee (integer-int64 -> integer-int32)
      • Changed property numberOfFreeCardsAccountSetupFee (integer-int64 -> integer-int32)
      • Changed property accounts (array)
        • Changed items (object Account)

          • Added property hierarchyBonusProgramReferences (array)
          • Added property openCycleInformation (object)
      • Changed property cardContracts (array)
        • Changed items (object CardContract)

          • Changed property cards (array)

            • Changed items (object Card)

              • Added property orders (array)
      • Changed property contractCustomers (array)
        • Changed items (object Customer)

          • Changed property addresses (array)

            • Changed items (object Address)

              • Added property temporary (boolean)

List contracts for contract owner

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

    • Changed items (object Contract)

      • Changed property numberOfFreeCardsMembershipFee (integer-int64 -> integer-int32)
      • Changed property numberOfFreeCardsAccountSetupFee (integer-int64 -> integer-int32)
      • Changed property accounts (array)
        • Changed items (object Account)

          • Added property hierarchyBonusProgramReferences (array)
          • Added property openCycleInformation (object)
      • Changed property cardContracts (array)
        • Changed items (object CardContract)

          • Changed property cards (array)

            • Changed items (object Card)

              • Added property orders (array)
      • Changed property contractCustomers (array)
        • Changed items (object Customer)

          • Changed property addresses (array)

            • Changed items (object Address)

              • Added property temporary (boolean)

List corporate contracts for a company (beta)

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

    • Changed items (object CorporateContract)

      • Changed property contractCustomers (array)

        • Changed items (object Customer)

          • Changed property addresses (array)

            • Changed items (object Address)

              • Added property temporary (boolean)
      • Changed property contractCompanies (array)
        • Changed items (object Company)

          • Changed property addresses (array)

            • Changed items (object Address)

              • Added property temporary (boolean)
      • Changed property corporateContractEntities (array)
        • Changed items (object CorporateContractEntity)

          • Changed property account (object Account)

            • Added property hierarchyBonusProgramReferences (array)
            • Added property openCycleInformation (object)
      • Changed property corporateEmployeeAccounts (array)
        • Changed items (object CorporateEmployeeAccount)

          • Changed property account (object Account)

            • Added property hierarchyBonusProgramReferences (array)
            • Added property openCycleInformation (object)
          • Changed property cardContracts (array)
            • Changed items (object CardContract)

              • Changed property cards (array)

                • Changed items (object Card)

                  • Added property orders (array)

List corporate contracts for a company by external reference (beta)

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

    • Changed items (object CorporateContract)

      • Changed property contractCustomers (array)

        • Changed items (object Customer)

          • Changed property addresses (array)

            • Changed items (object Address)

              • Added property temporary (boolean)
      • Changed property contractCompanies (array)
        • Changed items (object Company)

          • Changed property addresses (array)

            • Changed items (object Address)

              • Added property temporary (boolean)
      • Changed property corporateContractEntities (array)
        • Changed items (object CorporateContractEntity)

          • Changed property account (object Account)

            • Added property hierarchyBonusProgramReferences (array)
            • Added property openCycleInformation (object)
      • Changed property corporateEmployeeAccounts (array)
        • Changed items (object CorporateEmployeeAccount)

          • Changed property account (object Account)

            • Added property hierarchyBonusProgramReferences (array)
            • Added property openCycleInformation (object)
          • Changed property cardContracts (array)
            • Changed items (object CardContract)

              • Changed property cards (array)

                • Changed items (object Card)

                  • Added property orders (array)

Create consumer contract

POST /issuers/{issuerId}/contracts/create-consumer-contract
Request body:
  • Changed property contract (object CreateConsumerContractRequest.Contract)

    • Changed property numberOfFreeCardsMembershipFee (integer-int64 -> integer-int32)
    • Changed property numberOfFreeCardsAccountSetupFee (integer-int64 -> integer-int32)

What's Deleted

 

No API deleted.

What's Deprecated

 

No API deprecated.

Enable "on this page" menu on doc section
On