Release Notes: REST API V2 - 2.9.0

REST API V2 - 2.9.0

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

What's New


Add an entity to a Corporate contract

POST /issuers/{issuerId}/corporate-contracts/{contractReference}/add-corporate-contract-entity

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

Modify an entity of a Corporate contract

PATCH /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-contract-entity/{companyEntityExternalReference}

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

modify an entity of a Corporate contract

PATCH /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-contract-entity/{companyEntityExternalReference}

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

Add an entity to a Corporate contract

POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/add-corporate-contract-entity

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

Add an employee and its card(s) and account(s) to a Corporate contract

POST /issuers/{issuerId}/corporate-contracts/{contractReference}/add-corporate-employee-cards-accounts

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

Add an employee and its card(s) and account(s) to a Corporate contract

POST /issuers/{issuerId}/corporate-contracts/{contractReference}/add-corporate-employee-cards-accounts

The API allows to add an employee and its card(s) and account(s) to a corporate contract identified by the Contract reference.

 

POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/add-corporate-employee-cards-accounts

The API allows to add an employee and its card(s) and account(s) to a corporate contract identified by the Issuer Contract external reference.

Create a Corporate contract

POST /issuers/{issuerId}/corporate-contracts/create-corporate-contract

The Create Corporate Contract API allows the creation of a new corporate contract with the company organization (complete or partial structure).

Modify an entity of a Corporate contract

PATCH /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-contract-entity/{companyEntityExternalReference}

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

Pre-conditions: The correlation ID, if provided by the issuer, must be unique. In case of re-use of a correlation ID from an existing corporate contract, the system will return the data from the existing corporate contract (e.g., if the API call returns a "time-out" response, the same correlation ID can be provided to retrieve corporate contract data from Worldline system for further checks).

During the corporate contract creation

  1. The issuer can provide a list of new customers/companies, otherwise the references to existing customers/companies in Worldline system can be used
  2. The issuer has the possibility to create
  • the company organization, by adding 1 or several corporate entities such as countries, divisions, departments (this is also possible afterwards with dedicated API)
  • the employees with their cards and accounts (this is also possible afterwards with dedicated API)

As a result, the contract is created:

  • with its own reference calculated by our system
  • with the status set to "Signed"
  • with entity levels of the company organization (at least the company itself)
  • with the root entity account

The API response returns

  • the different identifiers related to the corporate contract, such as the contract itself, contract owner, account owner of an entity
  • if requested identifiers of employee accounts, card contracts, cards and cardholders if any (each identifier is composed of the Worldline internal reference and, optionally, the external reference if provided by the issuer in the request)

The references are used to: retrieve/update/close corporate contracts, retrieve the list of entities for a corporate contract, retrieve the corporate employee account, etc.

Retrieve the list of add-on services

GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/addon-subscriptions

The API allows to retrieve the list of add-on subscriptions for a contract.

Subscribe to add-on

POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/addon-subscriptions

The API allows to subscribe to an add-on service for a contract

Unsubscribe add-on

POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/addon-subscriptions/unsubscribe

The API allows to unsubscribe from an add-on service.

Retrieve the list of add-on services

GET /issuers/{issuerId}/contracts/{contractReference}/addon-subscriptions

The API allows to retrieve the list of add-on subscriptions for a contract.

Subscribe to add-on

POST /issuers/{issuerId}/contracts/{contractReference}/addon-subscriptions

The API allows to subscribe to an add-on service for a contract.

Unsubscribe add-on

POST /issuers/{issuerId}/contracts/{contractReference}/addon-subscriptions/unsubscribe

The API allows to unsubscribe from add-on service

Invalidate address

POST /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/invalidate

The API allows to invalidate on demand an address by providing.

  • the reference of the customer,
  • the reference of the address
  • the issuer Id.

Invalidate address

POST /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/invalidate

The API allows to invalidate on demand an address by providing

  • the reference of the customer,
  • the reference of the address
  • the issuer Id.

Invalidate address

POST /issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/invalidate

The API allows activation on demand of an address by providing

  • the reference of the customer,
  • the reference of the address
  • the issuer Id.

Invalidate address

POST /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/invalidate

The API allows activation on demand of an address by providing

  • the reference of the customer,
  • the reference of the address
  • the issuer Id.

Modify Contact by customer reference and contact reference

PUT /issuers/{issuerId}/companies/{customerReference}/contacts/{contactReference}

The API allows information of a contact of the company to be modified. All attributes must be provided (even if some of them have not been modified) else the value of missing attributes will be empty.

Modify Contact by issuer customer external reference and contact reference

PUT /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/contacts/{contactReference}

The API allows information of a contact of the company to be modified. All attributes must be provided (even if some of them have not been modified) else the value of missing attributes will be empty.

What's Changed


GET /health
Parameters:

Added: WL-Origin in header

GET /info
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/balance
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/credit-limit
Parameters:

Added: WL-Origin in header

PUT /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/credit-limit
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-balance-adjustment-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-fee-operation
Parameters:

Added: WL-Origin in header

Request body:
  • New required properties:

    • adjustment
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-payment-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-reimbursement-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-load-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-unload-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/reverse-balance-adjustment-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/reverse-fee-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/reverse-payment-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/last/reprint
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/{cycleClosureDate}/reprint
Parameters:

Added: WL-Origin in header

DELETE /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/temporary-credit-limits/{temporaryCreditLimitReference}
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/create-mandate
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/cancel-mandate
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/{accountReference}/balance
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/{accountReference}/credit-limit
Parameters:

Added: WL-Origin in header

PUT /issuers/{issuerId}/accounts/{accountReference}/credit-limit
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/post-balance-adjustment-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/post-fee-operation
Parameters:

Added: WL-Origin in header

Request body:
  • New required properties:

    • adjustment
POST /issuers/{issuerId}/accounts/{accountReference}/post-payment-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/post-reimbursement-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/post-load-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/post-unload-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/reverse-balance-adjustment-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/reverse-fee-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/reverse-payment-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/statements/last/reprint
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/statements/{cycleClosureDate}/reprint
Parameters:

Added: WL-Origin in header

DELETE /issuers/{issuerId}/accounts/{accountReference}/temporary-credit-limits/{temporaryCreditLimitReference}
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/create-mandate
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/cancel-mandate
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/activate
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/deactivate
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders/{orderReference}/release
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/remind-pin
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/unblock
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/{cardReference}/activate
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/{cardReference}/deactivate
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/declare-counterfeit-card
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/{cardReference}/orders/{orderReference}/release
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/{cardReference}/remind-pin
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/{cardReference}/unblock
Parameters:

Added: WL-Origin in header

PUT /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/legitimacy-documents/external-customers/{issuerCustomerExternalReference}
Parameters:

Added: WL-Origin in header

PUT /issuers/{issuerId}/contracts/{contractReference}/legitimacy-documents/{customerReference}
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/contracts/{contractReference}/cancel-product-change
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/cancel-product-change
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/credit-instalments/terminate-all
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/credit-instalments/{creditInstalmentReference}/activate
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/credit-instalments/{creditInstalmentReference}/cancel
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/credit-instalments/{creditInstalmentReference}/repay
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/credit-instalments/{creditInstalmentReference}/terminate
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/credit-transfers/{endToEndId}/cancel
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/direct-debits
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/direct-debits/{endToEndId}/cancel
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/disputes/{disputeFolderReference}/postings
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/disputes/external-disputes/{issuerDisputeExternalReference}/postings
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/disputes/{disputeFolderReference}/events
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/disputes/external-disputes/{issuerDisputeExternalReference}/events
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/disputes/{disputeFolderReference}/documents
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/disputes/external-disputes/{issuerDisputeExternalReference}/documents
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/disputes/{disputeFolderReference}/generate-chargeback
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/disputes/external-disputes/{issuerDisputeExternalReference}/generate-chargeback
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/companies/{customerReference}/contacts
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/contacts
Parameters:

Added: WL-Origin in header

DELETE /issuers/{issuerId}/companies/{customerReference}/contacts/{contactReference}
Parameters:

Added: WL-Origin in header

DELETE /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/contacts/{contactReference}
Parameters:

Added: WL-Origin in header

GET /issuers
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates/{creationDate}
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/insurance-contracts/{insurancePackageReference}
Parameters:

Added: WL-Origin in header

DELETE /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/insurance-contracts/{insurancePackageReference}
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/insurance-contracts/{insurancePackageReference}/insurance-events
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/cancel-delinquency
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/last
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/next
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/{cycleClosureDate}
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/temporary-credit-limits
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/temporary-credit-limits
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/{accountReference}/account-future-updates/{creationDate}
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/cancel-delinquency
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/{accountReference}/insurance-contracts/{insurancePackageReference}
Parameters:

Added: WL-Origin in header

DELETE /issuers/{issuerId}/accounts/{accountReference}/insurance-contracts/{insurancePackageReference}
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/insurance-contracts/{insurancePackageReference}/insurance-events
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/{accountReference}/statements/last
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/{accountReference}/statements/next
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/{accountReference}/statements/{cycleClosureDate}
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/temporary-credit-limits
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/{accountReference}/temporary-credit-limits
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/companies/{customerReference}/addresses/{addressReference}/activate
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/activate
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/companies/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/activate
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/activate
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/companies/{customerReference}/addresses/{addressReference}/deactivate
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/deactivate
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/companies/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/deactivate
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/deactivate
Parameters:

Added: WL-Origin in header

DELETE /issuers/{issuerId}/companies/{customerReference}/addresses/{addressReference}/address-usages
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/companies/{customerReference}/addresses/{addressReference}/address-usages
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/address-usages
Parameters:

Added: WL-Origin in header

DELETE /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/address-usages
Parameters:

Added: WL-Origin in header

DELETE /issuers/{issuerId}/companies/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/companies/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages
Parameters:

Added: WL-Origin in header

DELETE /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

POST /issuers/{issuerId}/card-contracts/{cardContractReference}/close
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/block-all
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/block
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/block-and-replace
Parameters:

Added: WL-Origin in header

Request body:
  • Changed property replaceCardRequest (object ReplaceCardRequest)

    • Added property forceNewPin (boolean)
    • Deleted property forceNewPIN (boolean)
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/new-tan
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/reorder-pin
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/replace
Parameters:

Added: WL-Origin in header

Request body:
  • Added property forceNewPin (boolean)
  • Deleted property forceNewPIN (boolean)
POST /issuers/{issuerId}/cards/unblock-all
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/{cardReference}/block
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/{cardReference}/block-and-replace
Parameters:

Added: WL-Origin in header

Request body:
  • Changed property replaceCardRequest (object ReplaceCardRequest)

    • Added property forceNewPin (boolean)
    • Deleted property forceNewPIN (boolean)
GET /issuers/{issuerId}/cards/{cardReference}/orders/{orderReference}
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/{cardReference}/reorder-pin
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/{cardReference}/replace
Parameters:

Added: WL-Origin in header

Request body:
  • Added property forceNewPin (boolean)
  • Deleted property forceNewPIN (boolean)
GET /issuers/{issuerId}/cards/{cardReference}/blocking-information
Parameters:

Added: WL-Origin in header

PATCH /issuers/{issuerId}/cards/{cardReference}/blocking-information
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

PATCH /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/blocking-information
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/update-all-blocking-information
Parameters:

Added: WL-Origin in header

Response:
  • Changed property data (array)

    • Changed items (object BlockAllCardsResponse)

      • New required properties:

        • cards
      • New optional properties:

        • issuerId
      • Added property cards (array)

      • Deleted property issuerId (string)

      • Deleted property cardIdentifier (object)

      • Deleted property encryptedPan (object)

      • Deleted property pan (string)

      • Deleted property maskedPan (string)

      • Deleted property panReference (string)

      • Deleted property expiryDate (string)

      • Deleted property panSequenceNumber (string)

      • Deleted property status (string)

      • Deleted property statusDate (string)

      • Deleted property statusHistory (array)

      • Deleted property embossingName (string)

      • Deleted property embossingName2ndLine (string)

      • Deleted property embossingLine5 (string)

      • Deleted property artwork (string)

      • Deleted property permanentlyBlocked (boolean)

      • Deleted property emergencyCard (boolean)

      • Deleted property emergencyCashAdvance (boolean)

      • Deleted property renewed (boolean)

      • Deleted property replaced (boolean)

      • Deleted property replacementReason (string)

      • Deleted property blockingReason (string)

      • Deleted property pinInheritanceCardReference (string)

      • Deleted property specificFields (object)

      • Deleted property renewedBy (object)

      • Deleted property replacementBy (object)

      • Deleted property renewedFor (object)

      • Deleted property replacementFor (object)

      • Deleted property cardContractIdentifier (object)

      • Deleted property cardContract (object)

      • Deleted property orderIdentifiers (array)

      • Deleted property isCardDigitalizationAllowed (boolean)

      • Deleted property multiCardInfo (object)

      • Deleted property cardScheme (string)

      • Deleted property virtual (boolean)

      • Deleted property contactlessEnabled (boolean)

      • Deleted property technologyType (string)

      • Deleted property techAndAppModelName (string)

      • Deleted property photoReference (string)

      • Deleted property pictureReference (string)

      • Deleted property logoReference (string)

      • Deleted property dispatchCode (string)

      • Deleted property automaticDeactivationDate (string)

      • Deleted property contractType (string)

POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/cancel-close
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/cancel-suspend
Parameters:

Added: WL-Origin in header

PATCH /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/contract-fees/{accountReference}
Parameters:

Added: WL-Origin in header

PATCH /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/contract-fees/external-accounts/{issuerAccountExternalReference}
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/legitimacy-documents
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/contracts/{contractReference}/cancel-close
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/contracts/{contractReference}/cancel-suspend
Parameters:

Added: WL-Origin in header

PATCH /issuers/{issuerId}/contracts/{contractReference}/contract-fees/{accountReference}
Parameters:

Added: WL-Origin in header

PATCH /issuers/{issuerId}/contracts/{contractReference}/contract-fees/external-accounts/{issuerAccountExternalReference}
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/contracts/{contractReference}/legitimacy-documents
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/credit-instalments/simulate
Parameters:

Added: WL-Origin in header

PATCH /issuers/{issuerId}/credit-instalments/{creditInstalmentReference}
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/credit-instalments/{creditInstalmentReference}
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/credit-transfers
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/credit-transfers/{endToEndId}
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}
Parameters:

Added: WL-Origin in header

PUT /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/activate
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages
Parameters:

Added: WL-Origin in header

DELETE /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/deactivate
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}
Parameters:

Added: WL-Origin in header

PUT /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/activate
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/address-usages
Parameters:

Added: WL-Origin in header

DELETE /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/address-usages
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/deactivate
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}
Parameters:

Added: WL-Origin in header

PUT /issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}
Parameters:

Added: WL-Origin in header

DELETE /issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/activate
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/deactivate
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}
Parameters:

Added: WL-Origin in header

PUT /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/activate
Parameters:

Added: WL-Origin in header

DELETE /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/address-usages
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/address-usages
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/deactivate
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/direct-debits/{endToEndId}
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/operations/{operationId}/disputes
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/disputes/{disputeFolderReference}
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/operations/{operationId}/dispute
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/disputes/external-disputes/{issuerDisputeExternalReference}
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/{cardReference}/new-tan
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/{cardReference}/create-emergency-card
Parameters:

Added: WL-Origin in header

Response:
  • Changed property data (object CreateEmergencyCardResponse)

    • Added property panReference (string)
    • Added property status (string)
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/create-emergency-card
Parameters:

Added: WL-Origin in header

Response:
  • Changed property data (object CreateEmergencyCardResponse)

    • Added property panReference (string)
    • Added property status (string)
PATCH /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}
Parameters:

Added: WL-Origin in header

Request body:
  • Changed property hierarchyOutgoingCreditTransferFeature (object ModifyHierarchyOutgoingCreditTransferFeature)

    • Added property octOnContractSuspensionAllowed (boolean)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}
Parameters:

Added: WL-Origin in header

Response:
  • Changed property data (object Account)

    • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

      • Added property octOnContractSuspensionAllowed (boolean)
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-guarantor
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-history
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-owner
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/credit-transfers
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/direct-debits
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/insurance-contracts
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/insurance-contracts
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/turnover-information
Parameters:

Added: WL-Origin in header

PATCH /issuers/{issuerId}/accounts/{accountReference}
Parameters:

Added: WL-Origin in header

Request body:
  • Changed property hierarchyOutgoingCreditTransferFeature (object ModifyHierarchyOutgoingCreditTransferFeature)

    • Added property octOnContractSuspensionAllowed (boolean)
GET /issuers/{issuerId}/accounts/{accountReference}
Parameters:

Added: WL-Origin in header

Response:
  • Changed property data (object Account)

    • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

      • Added property octOnContractSuspensionAllowed (boolean)
POST /issuers/{issuerId}/accounts/{accountReference}/account-future-updates
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/{accountReference}/account-future-updates
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/{accountReference}/account-guarantor
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/{accountReference}/account-history
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/{accountReference}/turnover-information
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/{accountReference}/credit-transfers
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/{accountReference}/direct-debits
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/insurance-contracts
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/{accountReference}/insurance-contracts
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/{accountReference}/operations/{operationId}
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/{accountReference}/statements
Parameters:

Added: WL-Origin in header

PUT /issuers/{issuerId}/companies/{customerReference}
Parameters:

Added: WL-Origin in header

PATCH /issuers/{issuerId}/companies/{customerReference}
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/companies/{customerReference}
Parameters:

Added: WL-Origin in header

PUT /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}
Parameters:

Added: WL-Origin in header

PATCH /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/companies/{customerReference}/addresses
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/companies/{customerReference}/addresses
Parameters:

Added: WL-Origin in header

PUT /issuers/{issuerId}/companies/{customerReference}/addresses/{addressReference}
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/companies/{customerReference}/addresses/{addressReference}
Parameters:

Added: WL-Origin in header

PUT /issuers/{issuerId}/companies/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/companies/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses
Parameters:

Added: WL-Origin in header

PUT /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}
Parameters:

Added: WL-Origin in header

PUT /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}
Parameters:

Added: WL-Origin in header

PATCH /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cardholder
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cards
Parameters:

Added: WL-Origin in header

PATCH /issuers/{issuerId}/card-contracts/{cardContractReference}
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/card-contracts/{cardContractReference}
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/card-contracts/{cardContractReference}/cardholder
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/card-contracts/{cardContractReference}/cards
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

POST /issuers/{issuerId}/corporate-contracts/{contractReference}/close
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/close
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

GET /issuers/{issuerId}/cards/{cardReference}/card-contract
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/cards/{cardReference}/card-events
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/contract-fees
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/contract-owner
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/contracts/{contractReference}/contract-fees
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/contracts/{contractReference}/contract-owner
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/credit-instalments/
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/credit-instalments/
Parameters:

Added: WL-Origin in header

PUT /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}
Parameters:

Added: WL-Origin in header

PATCH /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses
Parameters:

Added: WL-Origin in header

PUT /issuers/{issuerId}/customers/{customerReference}
Parameters:

Added: WL-Origin in header

PATCH /issuers/{issuerId}/customers/{customerReference}
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/customers/{customerReference}
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/customers/{customerReference}/addresses
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/contract
Parameters:

Added: WL-Origin in header
Changed: embed in query

Response:
  • Changed property data (object Contract)

    • Added property addonSubscriptions (array)
    • Changed property accounts (array)
      • Changed items (object Account)

        • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

          • Added property octOnContractSuspensionAllowed (boolean)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/last/operations
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/next/operations
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/{cycleClosureDate}/operations
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/{accountReference}/contract
Parameters:

Added: WL-Origin in header
Changed: embed in query

Response:
  • Changed property data (object Contract)

    • Added property addonSubscriptions (array)
    • Changed property accounts (array)
      • Changed items (object Account)

        • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

          • Added property octOnContractSuspensionAllowed (boolean)
GET /issuers/{issuerId}/accounts/{accountReference}/operations
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/{accountReference}/statements/last/operations
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/{accountReference}/statements/next/operations
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/{accountReference}/statements/{cycleClosureDate}/operations
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/companies
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/companies
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/contract
Parameters:

Added: WL-Origin in header
Changed: embed in query

Response:
  • Changed property data (object Contract)

    • Added property addonSubscriptions (array)
    • Changed property accounts (array)
      • Changed items (object Account)

        • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

          • Added property octOnContractSuspensionAllowed (boolean)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}/contract
Parameters:

Added: WL-Origin in header
Changed: embed in query

Response:
  • Changed property data (object Contract)

    • Added property addonSubscriptions (array)
    • Changed property accounts (array)
      • Changed items (object Account)

        • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

          • Added property octOnContractSuspensionAllowed (boolean)
PATCH /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Parameters:

Added: WL-Origin in header

Response:
  • Changed property data (object CorporateEmployeeAccountResponse)

    • Changed property account (object Account)

      • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

        • Added property octOnContractSuspensionAllowed (boolean)
PATCH /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Parameters:

Added: WL-Origin in header

Response:
  • Changed property data (object CorporateEmployeeAccountResponse)

    • Changed property account (object Account)

      • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

        • Added property octOnContractSuspensionAllowed (boolean)
PATCH /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/{accountReference}
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/{accountReference}
Parameters:

Added: WL-Origin in header

Response:
  • Changed property data (object CorporateEmployeeAccountResponse)

    • Changed property account (object Account)

      • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

        • Added property octOnContractSuspensionAllowed (boolean)
PATCH /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}
Parameters:

Added: WL-Origin in header
Changed: embed in query

Response:
  • Changed property data (object Contract)

    • Added property addonSubscriptions (array)
    • Changed property accounts (array)
      • Changed items (object Account)

        • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

          • Added property octOnContractSuspensionAllowed (boolean)
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/accounts
Parameters:

Added: WL-Origin in header

Response:
  • Changed property data (array)

    • Changed items (object Account)

      • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

        • Added property octOnContractSuspensionAllowed (boolean)
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/card-contracts
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/close
Parameters:

Added: WL-Origin in header

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)

              • Added property panReference (string)
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/update-all-customers-addresses
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/suspend
Parameters:

Added: WL-Origin in header

Response:
  • Changed property data (object SuspendContractResponse)

    • Changed property contract (object SuspendContractResponse.Contract)

      • Added property closingDate (string)
      • Changed property cardContracts (array)
        • Changed items (object SuspendContractResponse.CardContract)

          • Added property replacementBlockingReason (string)
          • Added property renewalBlockingReason (string)
          • Changed property cards (array)
            • Changed items (object SuspendContractResponse.Card)

              • Added property panReference (string)
PATCH /issuers/{issuerId}/contracts/{contractReference}
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/contracts/{contractReference}
Parameters:

Added: WL-Origin in header
Changed: embed in query

Response:
  • Changed property data (object Contract)

    • Added property addonSubscriptions (array)
    • Changed property accounts (array)
      • Changed items (object Account)

        • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

          • Added property octOnContractSuspensionAllowed (boolean)
GET /issuers/{issuerId}/contracts/{contractReference}/accounts
Parameters:

Added: WL-Origin in header

Response:
  • Changed property data (array)

    • Changed items (object Account)

      • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

        • Added property octOnContractSuspensionAllowed (boolean)
GET /issuers/{issuerId}/contracts/{contractReference}/card-contracts
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/contracts/{contractReference}/close
Parameters:

Added: WL-Origin in header

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)

              • Added property panReference (string)
POST /issuers/{issuerId}/contracts/{contractReference}/update-all-customers-addresses
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/contracts/{contractReference}/suspend
Parameters:

Added: WL-Origin in header

Response:
  • Changed property data (object SuspendContractResponse)

    • Changed property contract (object SuspendContractResponse.Contract)

      • Added property closingDate (string)
      • Changed property cardContracts (array)
        • Changed items (object SuspendContractResponse.CardContract)

          • Added property replacementBlockingReason (string)
          • Added property renewalBlockingReason (string)
          • Changed property cards (array)
            • Changed items (object SuspendContractResponse.Card)

              • Added property panReference (string)
POST /issuers/{issuerId}/contracts/{contractReference}/switch-principal-card
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/switch-principal-card
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

GET /issuers/{issuerId}/customers
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/accounts
Parameters:

Added: WL-Origin in header

Response:
  • Changed property data (array)

    • Changed items (object Account)

      • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

        • Added property octOnContractSuspensionAllowed (boolean)
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/card-contracts
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/customers/{customerReference}/accounts
Parameters:

Added: WL-Origin in header

Response:
  • Changed property data (array)

    • Changed items (object Account)

      • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

        • Added property octOnContractSuspensionAllowed (boolean)
GET /issuers/{issuerId}/customers/{customerReference}/card-contracts
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

GET /issuers/{issuerId}/corporate-contracts/{contractReference}
Parameters:

Added: WL-Origin in header

Response:
  • Changed property data (object CorporateContract)

    • Changed property corporateContractEntities (array)

      • Changed items (object CorporateContractEntity)

        • Added property deliveryChannel (object)
        • Added property advertisementFlags (object)
        • Changed property account (object Account)
          • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

            • Added property octOnContractSuspensionAllowed (boolean)
    • Changed property corporateEmployeeAccounts (array)
      • Changed items (object CorporateEmployeeAccount)

        • Changed property account (object Account)

          • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

            • Added property octOnContractSuspensionAllowed (boolean)
PATCH /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

Response:
  • Changed property data (object CorporateContract)

    • Changed property corporateContractEntities (array)

      • Changed items (object CorporateContractEntity)

        • Added property deliveryChannel (object)
        • Added property advertisementFlags (object)
        • Changed property account (object Account)
          • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

            • Added property octOnContractSuspensionAllowed (boolean)
    • Changed property corporateEmployeeAccounts (array)
      • Changed items (object CorporateEmployeeAccount)

        • Changed property account (object Account)

          • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

            • Added property octOnContractSuspensionAllowed (boolean)
POST /issuers/{issuerId}/contracts/{contractReference}/sign
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/sign
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header
Changed: embed in query

Response:
  • Changed property data (array)

    • Changed items (object Contract)

      • Added property addonSubscriptions (array)
      • Changed property accounts (array)
        • Changed items (object Account)

          • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

            • Added property octOnContractSuspensionAllowed (boolean)
POST /issuers/{issuerId}/contracts/{contractReference}/change-product
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/change-product
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/contracts/{contractReference}/force-product-change
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/force-product-change
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contracts
Parameters:

Added: WL-Origin in header

Response:
  • Changed property data (array)

    • Changed items (object Contract)

      • Added property addonSubscriptions (array)
      • Changed property accounts (array)
        • Changed items (object Account)

          • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

            • Added property octOnContractSuspensionAllowed (boolean)
GET /issuers/{issuerId}/customers/{customerReference}/contracts
Parameters:

Added: WL-Origin in header

Response:
  • Changed property data (array)

    • Changed items (object Contract)

      • Added property addonSubscriptions (array)
      • Changed property accounts (array)
        • Changed items (object Account)

          • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

            • Added property octOnContractSuspensionAllowed (boolean)
GET /issuers/{issuerId}/companies/{customerReference}/corporate-contracts
Parameters:

Added: WL-Origin in header

Response:
  • Changed property data (array)

    • Changed items (object CorporateContract)

      • Changed property corporateContractEntities (array)

        • Changed items (object CorporateContractEntity)

          • Added property deliveryChannel (object)
          • Added property advertisementFlags (object)
          • Changed property account (object Account)
            • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

              • Added property octOnContractSuspensionAllowed (boolean)
      • Changed property corporateEmployeeAccounts (array)
        • Changed items (object CorporateEmployeeAccount)

          • Changed property account (object Account)

            • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

              • Added property octOnContractSuspensionAllowed (boolean)
GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/corporate-contracts
Parameters:

Added: WL-Origin in header

Response:
  • Changed property data (array)

    • Changed items (object CorporateContract)

      • Changed property corporateContractEntities (array)

        • Changed items (object CorporateContractEntity)

          • Added property deliveryChannel (object)
          • Added property advertisementFlags (object)
          • Changed property account (object Account)
            • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

              • Added property octOnContractSuspensionAllowed (boolean)
      • Changed property corporateEmployeeAccounts (array)
        • Changed items (object CorporateEmployeeAccount)

          • Changed property account (object Account)

            • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

              • Added property octOnContractSuspensionAllowed (boolean)
POST /issuers/{issuerId}/contracts/create-consumer-contract
Parameters:

Added: WL-Origin in header

Request body:
  • Changed property addCardsAccounts (object CreateConsumerContractRequest.AddCardsAccounts)

    • Changed property accounts (array)

      • Changed items (object CreateConsumerContractRequest.Account)

        • Added property contractAddOnsSubscriptions (array)
    • Changed property cardContracts (array)
      • Changed items (object CreateConsumerContractRequest.CardContract)

        • Added property contractAddOnsSubscriptions (array)
  • Changed property contract (object CreateConsumerContractRequest.Contract)
    • Changed property accountHierarchy (object CreateConsumerContractRequest.AccountHierarchy)

      • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

        • Added property octOnContractSuspensionAllowed (boolean)
      • Changed property accounts (array)
        • Changed items (object CreateConsumerContractRequest.Account)

          • Added property contractAddOnsSubscriptions (array)
    • Changed property cardContracts (array)
      • Changed items (object CreateConsumerContractRequest.CardContract)

        • Added property contractAddOnsSubscriptions (array)
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/add-cards-accounts
Parameters:

Added: WL-Origin in header

Request body:
  • Changed property accountHierarchy (object AddCardsAccountsRequest.AccountHierarchy)

    • Changed property accounts (array)

      • Changed items (object CreateConsumerContractRequest.Account)

        • Added property contractAddOnsSubscriptions (array)
  • Changed property cardContracts (array)
    • Changed items (object CreateConsumerContractRequest.CardContract)

      • Added property contractAddOnsSubscriptions (array)
POST /issuers/{issuerId}/contracts/{contractReference}/add-cards-accounts
Parameters:

Added: WL-Origin in header

Request body:
  • Changed property accountHierarchy (object AddCardsAccountsRequest.AccountHierarchy)

    • Changed property accounts (array)

      • Changed items (object CreateConsumerContractRequest.Account)

        • Added property contractAddOnsSubscriptions (array)
  • Changed property cardContracts (array)
    • Changed items (object CreateConsumerContractRequest.CardContract)

      • Added property contractAddOnsSubscriptions (array)

What's Deleted


Modify Contact by customer reference and contact reference

PATCH /issuers/{issuerId}/companies/{customerReference}/contacts/{contactReference}

Modify Contact by customer reference and contact reference

PATCH /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/contacts/{contactReference}

What's Deprecated


 

No API deprecated.

Enable "on this page" menu on doc section
On

Buy Now Pay Later

Buy Now Pay Later

Buy now, pay later is a payment method that allows consumers to buy a product immediately and pay later. This payment method is gaining popularity around the world, especially among younger consumers.

Buy Now Pay Later works like this: Consumers make purchases online or in-store, then select the Buy Now Pay Later payment method. The consumer can then select a later payment date that is convenient to him. Depending on the terms of the contract, fees or interest may apply to this payment method.

Buy now, pay later offers consumers several benefits, including the ability to defer payments to a later date, which can help during temporary financial hardship. Additionally, consumers can better manage their budgets by spreading payments over multiple months.

Pay later usage are rising

globe

Global sales using Buy Now Pay Later reach €93B in 2020

growth

Will exceed €181B in 2022, and would reach 10X this volume in 2025

profile

75% of Buy Now Pay Later users are aged 18-36

How does it work ?

Instalment via push notification

phone and card

In the moment of card purchase, the banking app receives a push notification

phone

User can tap on it, see the details and select an instalment plan

phone

Split of transactions confirmed in banking app

Card control

Card control

Card Control enables the cardholder to manage his card in real-time. Cards can be managed via the banking app or online banking through our APIs

The cardholder knows best his habits and preferences for card usage. Card Control allows him/her to customize a card in different aspects. Some examples: set card limits on different channels – in-store/online/contactless payments, cash withdrawals at ATM. As well it is possible to block chosen payment channels or certain merchant categories (e.g., casinos, liquor store, etc.). Geographical reach can also be controlled: countries can be blocked or enabled for card payments. All the mentioned features can be set for a specific period of time. Altogether, a variety of features and its combination provide a detailed customization.

Thanks to a comprehensive customization, Card Control becomes a first step towards risk mitigation. Through spending limit management, country and merchant category blocks, spend notifications, etc. the cardholder gets alert about fraudulent activities and can prevent it. Next to this, extensive card self-management options lead to fewer disputes and a lower number of calls to the customer care center.

iphone

The cardholder loses a physical card. He/she opens the banking app and blocks the cards easily.

card

A new card is issued instantly. The cardholder customizes it by setting spending limits, blocking some merchants and activating notifications?

globe

The cardholder is getting ready for a trip. Before travelling, he/she activates payments by his/her card in specifi countries.

How it works ?

 

Card Control allows the cardholder to personalize his card overriding the issuer specific standard settings. The customization is achieved by updating and overriding cards authorization restrictions and velocity limits.

Each authorization restriction override is based on an existing authorization restriction. First step is to retrieve the authorizationRestrictionReference through the list of existing authorization restriction by calling the API List of authorization restriction for account. Second step is to modify the authorization restriction using the API Create authorization restriction override. The override created could be then updated using the appropriate API. 

Similar process applies to velocity limits. A default velocity limit could be overwritten by Velocity limit overrides API that allows to modify number and amount of authorizations allowed for a specific time period. The override created could be then updated and deleted using the appropriate API.

Merchant management (old version)

Technical Description

 

The WL FS merchant contract API enables retrieval and updating at site & terminal level. Access to contract data is restricted to your acquirer and own merchant contract identifiers. For third parties, contract updating is limited depending on the generic user role (e.g. PSP, PayFac, Merchant) limitations agreed with the acquiring bank.

Version note:
Please be aware that these API interfaces may be changed and improved (e.g. addition of fields).

The "Try out" feature does not work at this time because the sandbox is being improved to support new functionality.

Accounts

Accounts (Features For All Card Types)

Accounts are used to process operations, manage a balance in a dedicated currency, control the credit risk, perform transaction charging, calculate interest (credit or debit), generate an invoice (statement), process payments.

Three types of account working modes are being supported; Pay Later, Pay Now, Pay Before.

  • Pay Later account working mode is used to implement classical credit card products like charge cards or revolving credit. Pay later accounts are settled by a cyclic closure process and typically produce an invoice (statement) with an amount due which can represent the full or partial statement balance. Credit or debit interest algorithms may apply.
  • Pay Now account working mode is used for all types of debit cards. Such accounts are typically settled in short frequencies (e. g. daily) and produce debit orders, immediately forwarded to customers’ current accounts. Interest calculation never applies.
  • Pay Before account working mode is used for the wide range of prepaid card products. The balance is always positive.

The below diagram presents different use cases covered by the API in the account domain.

account diagram

Enable "on this page" menu on doc section
On

ob-p-ideal-notification

Notification API

for iDEAL

API Reference

The notification APIs described in this chapter needs 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. For the iDEAL product the post status notification is part of the product, a value-added service is not required (because the notification is part of the iDEAL scheme and the Open Banking Service doesn't have to-do additional polling).

POST Status

Endpoint: POST /status

This API will notify the initiating party about the status of the payment.

  • The purple fields are applicable to IDEAL.

  • The orange fields are mandatory for an IDEAL payment.

More details about the fields can be found in the API reference.

Request

Post status iDEAL request

Response

HTML 204 (No Content)

post status iDEAL response

Example: Notification for Standard iDEAL payment

Request (Signature-related fields "Digest" and "Signature" are conditionally present):

Address: https://checkout.company.com/transaction/webhook/91FA6EEC30844FAAB5/v3/notification/status
  HttpMethod: POST
  Headers: {Authorization=Bearer 123456789, X-Request-ID=c1452392-6c3f-4365-93f8-40558f61ac36, MessageCreateDateTime=2023-03-15T11:51:24.185+01:00, Digest=SHA-256=0hq1mKzxB1yyc6+hut2bEX7ps+nWyWb2pgQb6AhfhfM=, Signature=keyId="3EBEF6033C00730D9C6DA05165A3CAA1F31036FB",algorithm="rsa-sha256",headers="messagecreatedatetime x-request-id digest",signature="uYgovoK+ibAE7+MzJEKrApDUAgWfUv7RQK22zAxWHCdKCuG4d0HgqpDSqcGlKmP2IMFsC787zDU3oqKeeIIVXR72uZBiOnm0/84UL9e7LVDHDLQsRbfDnmvgX/4xQvdwROmyqh8kkcXTf/48zY0wo2n9iDspCbgTn1DEqAqtAlwunIpea8eYA3FQc+pV2px77wVP7l+9mTxexzLSmum61wWbqE4ESJn0K37gXY54229ZtCnNSlu9rsvjQ5xmDf1e6MvMLBOblXHIReN2t8IH85VGK7mpi8T7JeKb8rIG8qDbQ5TD3BmIS1+RspI95FldLCKLH91/KNrxsgPsrC2QgQ==", Content-Type=application/json}
  Payload: {
  "PaymentProductUsed" : "IDEAL",
  "CommonPaymentData" : {
    "GuaranteedAmount" : "10.00",
    "PaymentStatus" : "SettlementCompleted",
    "PaymentId" : "19928",
    "AspspPaymentId" : "0001070883053837",
    "AspspId" : "10002",
    "DebtorInformation" : {
      "Name" : "Edsger Wybe Dijkstra - Callback",
      "Agent" : "ABNANL2AXXX",
      "Account" : {
        "SchemeName" : "IBAN",
        "Identification" : "NL44RABO0123456789",
        "Currency" : "EUR"
      },
  "UseWaitingScreen" : false
}

Response:

ResponseCode: 204

Example: Notification for iDEAL Payment with Fast Checkout

Request (Signature-related fields "Digest" and "Signature" are conditionally present):

Address: https://checkout.company.com/transaction/webhook/91FA6EEC30844FAAB5/v3/notification/status
  HttpMethod: POST
  Content-Type: application/json
  Headers: {Authorization=Bearer 123456789, X-Request-ID=c1452392-6c3f-4365-93f8-40558f61ac36, MessageCreateDateTime=2023-03-15T11:51:24.185+01:00, Digest=SHA-256=0hq1mKzxB1yyc6+hut2bEX7ps+nWyWb2pgQb6AhfhfM=, Signature=keyId="3EBEF6033C00730D9C6DA05165A3CAA1F31036FB",algorithm="rsa-sha256",headers="messagecreatedatetime x-request-id digest",signature="uYgovoK+ibAE7+MzJEKrApDUAgWfUv7RQK22zAxWHCdKCuG4d0HgqpDSqcGlKmP2IMFsC787zDU3oqKeeIIVXR72uZBiOnm0/84UL9e7LVDHDLQsRbfDnmvgX/4xQvdwROmyqh8kkcXTf/48zY0wo2n9iDspCbgTn1DEqAqtAlwunIpea8eYA3FQc+pV2px77wVP7l+9mTxexzLSmum61wWbqE4ESJn0K37gXY54229ZtCnNSlu9rsvjQ5xmDf1e6MvMLBOblXHIReN2t8IH85VGK7mpi8T7JeKb8rIG8qDbQ5TD3BmIS1+RspI95FldLCKLH91/KNrxsgPsrC2QgQ==", Content-Type=application/json}
  Payload: {
  "PaymentProductUsed" : "IDEAL",
  "CommonPaymentData" : {
    "GuaranteedAmount" : "10.00",
    "PaymentStatus" : "SettlementCompleted",
    "PaymentId" : "19928",
    "AspspPaymentId" : "0001070883053837",
    "AspspId" : "RABONL2UXXX",
    "DebtorInformation" : {
      "Name" : "Edsger Wybe Dijkstra - Callback",
      "Agent" : "ABNANL2AXXX",
      "Account" : {
        "SchemeName" : "IBAN",
        "Identification" : "NL44RABO0123456789",
        "Currency" : "EUR"
      },
      "ContactDetails" : {
        "FirstName" : "Edsger",
        "LastName" : "Dijkstra",
        "PhoneNumber" : "+31612345678",
        "Email" : "edsger@domain.nl"
      },
    "ShippingAddress" : {
        "FirstName" : "Edsger",
        "LastName" : "Dijkstra",
        "PostCode" : "52066",
        "Country" : "NL"
        },
    "BillingAddress" : {
        "FirstName" : "Edsger",
        "LastName" : "Dijkstra",
        "PostCode" : "52066",
        "Country" : "NL"
        }     
    }
  },
  "UseWaitingScreen" : false
}

Response:

ResponseCode: 204

POST Debtor token

Endpoint: POST /debtorToken

This API will provide a debtor token update to the Initiating party.

  • The purple fields are applicable to IDEAL.

  • The orange fields are mandatory for an IDEAL payment.

More details about the fields can be found in the API reference.

Request

post debtorToken iDEAL request

Response

HTML 204 (No Content)

post debtorToken iDEAL response

Example: Debtor Token Notification for Standard iDEAL payment

Request (Signature-related fields "Digest" and "Signature" are conditionally present):

Address: https://checkout.company.com/transaction/webhook/91FA6EEC30844FAAB5/v3/notification/status
  HttpMethod: POST
  Content-Type: application/json
  Headers: {Authorization=Bearer 123456789, X-Request-ID=c1452392-6c3f-4365-93f8-40558f61ac36, MessageCreateDateTime=2023-03-15T11:51:24.185+01:00, Digest=SHA-256=0hq1mKzxB1yyc6+hut2bEX7ps+nWyWb2pgQb6AhfhfM=, Signature=keyId="3EBEF6033C00730D9C6DA05165A3CAA1F31036FB",algorithm="rsa-sha256",headers="messagecreatedatetime x-request-id digest",signature="uYgovoK+ibAE7+MzJEKrApDUAgWfUv7RQK22zAxWHCdKCuG4d0HgqpDSqcGlKmP2IMFsC787zDU3oqKeeIIVXR72uZBiOnm0/84UL9e7LVDHDLQsRbfDnmvgX/4xQvdwROmyqh8kkcXTf/48zY0wo2n9iDspCbgTn1DEqAqtAlwunIpea8eYA3FQc+pV2px77wVP7l+9mTxexzLSmum61wWbqE4ESJn0K37gXY54229ZtCnNSlu9rsvjQ5xmDf1e6MvMLBOblXHIReN2t8IH85VGK7mpi8T7JeKb8rIG8qDbQ5TD3BmIS1+RspI95FldLCKLH91/KNrxsgPsrC2QgQ==", Content-Type=application/json}
  Payload: {
  "PsuId": "TestOSZ",
  "PaymentId": "12345",
  "DebtorToken": "absjrfergd"
 }

Response:

ResponseCode: 204
Enable "on this page" menu on doc section
On

Event Stores

Event Stores

Our issuing solution is composed of several applications that pushes different types of events into one information repository.

Each Application can notify events toward this repository.

Event stores contains comments or business events that can be generated by the different applications (CMS, authorization server, customer service GUI,..) part of our solution.

Retrieve Event Stores

This API enables the list of events associated to a business reference type and a business reference value, for given period of time, to be retrieved.

A business reference type corresponds to a business domain like a CONTRACT, CARD, ACCOUNT whereas a business reference value can be typically a card, account, customer, card contract reference.

Currently, this API is mainly used to get the comments linked to a business reference value (e.g., a given card identifier).

API links

Enable "on this page" menu on doc section
On

Transactions doc

Transactions

 

This API enables you to retrieves comprehensive transaction data based on merchant payments, contract entity and on specific periods of time.

  • Show transaction data in your application of preference

  • Retrieve the transactions associated with merchant payment (paymentId) for reconciliation purposes

  • Retrieve transaction fees generated by the Worldline FS Merchant Pricing Engine such as: Merchant Service Charge (Interchange++, Interchange+, Fixed fees), Interchange fees, Service fees, etc.

  • Acquirers can allow third parties access to retrieve own transaction data

 

The illustration below shows examples of a happy flow (resulting in a paid transaction) from the POST Transaction in Accept Transactions API through the various transactionStates in the GET Transactions API.

Flow actions and transactionStates in APIs

 

 

GET Transactions calls

Request parameters in bold on the Transactions API reference page are mandatory to complete a call.
To ensure best search call response time please use as many parameters as available.

 

There are 3 GET Transactions API call field result sets:

 

1. Transaction calls - transactionResults (CNP update ongoing)

Retrieve the latest transactionState in the transactionResults for CNP & POS transactions.

The Back Office transactionStates are:

  • Captured - host accept CAPTURE request

  • Processed - sent to SCHEME for clearing

  • Paid - merchant settlement payment instructions created

 

2. Authorization calls - actionResults (CNP API roadmap)

Retrieve latest acceptance actionResults using the following calls:

  • GET transactionId (lifecycle)

  • GET actionId

  • GET authorizations using the merchant contract entity (e.g. merchant, site, terminal)

Both approved and declined Accept Transaction actionResults can be viewed using available identifiers.

All the following Accept Transaction API actionTypes are available in the actionResults.

  • AUTH

  • PREAUTH

  • AUTH_INCREMENTAL

  • AUTH_REVERSAL

  • AUTH_REVERSAL_PARTIAL

  • AUTH_AND_CAPTURE

  • CAPTURE

  • CAPTURE_SPLIT (multiple partial captures)

 

3. Transaction Lifecycle calls (API roadmap)

Retrieve the associated first/second presentment(s) data and the associated transaction data of the different stages in the dispute life cycle (presentment, re-presentment, chargeback, pre-arbitration, settlement, manual adjustment etc.)

 

 

API reference Accept transactions doc Merchant payments doc

 

 

Enable "on this page" menu on doc section
On

Credit Instalment Management

Credit Instalment Management

Our solution supports credit instalment management allowing the Issuer to propose a number of credit instalment types to its customers. By using our credit instalment different plans, the Issuer can decide to grant a credit to its customers on a condition of its repayment at regular intervals over a specified period of time, until it is fully paid.

 

Retrieve A Credit Instalment Model Simulation

The "Request credit Instalment model simulation" API allows to simulate repayment schedule either by providing instalment model reference or instalment type (e.g. transaction, cash etc) and then customer can choose a desired instalment contract with the desired terms and repayment plan.

The mandatory input fields are:

  • The issuer ID
  • Credit amount requested by customer
  • Reference of a credit instalment model or Instalment type

As a result system returns simulated information with 1 or more repayment plans containing such as:

  • total amount due
  • total interest amount
  • fee amount (if relevant)
  • each Instalment amount
  • full repayment schedule

API links

Create A Credit Instalment Contract

The "Create credit Instalment contract" API allows to create a credit Instalment contract based on provided information.

The mandatory input fields are:

  • The issuer ID
  • Credit amount (allowed within the model range)
  • External Reference of an active credit instalment model
  • Receiving account reference which relates to the account credited. The account should not be closed.
  • Paying account reference which is assigned for credit instalment repayment posting. The account shall not be closed.

The optional/conditional input fields:

  • The customer for which the detail is requested: It can be provided by using the customer reference or the issuer customer external reference.
  • Credit term which is allowed on the chosen instalment product
  • First instalment date which shall be allowed on the chosen instalment product
  • An external reference (MSISDN) can be provided to identify the Instalment credit contract to be credited (e.g. mobile phone number)

As a result Instalment contract is created with:

  • Credit instalment reference
  • Contract Status set as ‘Created’
  • Contract date defined as the date of the creation
  • Credit term (default value from the Instalment Model if not provided by issuer)
  • First Instalment Date (default value from the Instalment Model if not provided by issuer)
  • Total interest amount calculated
  • Total contract amount calculated (credit amount plus total interest amount and total fee)
  • Fee amount calculated
  • Monthly Instalment amount calculated
  • Repayment schedule calculated

If Instalment model reference is not provided, it will be derived from:

  • card type taken from card or card contract identifier
  • credit amount

Selected model must have the same currency and Channel Type as the one provided in the request.

If channel type is provided as 'SMS' then:

  • provided Receiving account and Paying account must be the same
  • MSISDN is mandatory

API links

Update A Credit Instalment Contract

The "Update Credit Instalment contract" API allows to update different parameters of the contract: credit amount, Instalment term, first instalment date etc.

The mandatory input fields are:

  • The issuer ID
  • Credit Instalment Contract Reference

When the credit instalment contract is in "ACTIVE" status, system only allows to update "Paying Account Number”. No restrictions are applied for updating credit amount, even if the value is out of instalment model defined range.

API links

Cancel A Credit Instalment Contract

The "Cancel Credit Instalment contract" API allows issuer to cancel the Instalment contract before posting of the first instalment amount.

Contract status must be in "Created" status.

The mandatory input fields are:

  • The issuer ID
  • Credit Instalment Contract Reference

Upon receiving this request, the contract status will be changed from ‘Created’ to ‘Cancelled’.

API links

Activate A Credit Instalment Contract

The "Activate Credit Instalment contract" API allows issuer to request contract validation, once customer is signing the instalment contract.

The mandatory input fields are:

  • The issuer ID
  • Credit Instalment Contract Reference

Upon receiving this request, the contract status will be changed from ‘Created’ to ‘Active’.

An instalment account is created after the contract activation.

Upon instalment contract activation repayment plan is started.

API links

List Credit Instalment Contracts

The "List credit Instalment contracts" API allows to get the list of credit Instalment contracts for a given customer & issuer.

The mandatory input fields are:

  • The issuer ID
  • The customer for which the detail is requested: It can be provided by using the customer reference or the issuer customer external reference.

In return the interface provides list of credit instalment contracts (both closed and open) for a given customer with details such as: credit amount, interest rate, interest amount, repayment details, posting details on principal amount and interest, etc.

API links

Retrieve Credit Instalment Contract

The "Retrieve Credit Instalment contract" API allows to retrieve details for credit Instalment contract.

The mandatory input fields are:

  • The issuer ID
  • Credit Instalment Contract Reference

In return the interface provides details as: credit amount, interest rate, interest amount, repayment details, posting details on principal amount and interest, etc.

API links

Close All Credit Instalment Contracts For An Account

The "Close all credit Instalment contracts for an account" API allows to close all credit Instalment contracts for an account. All the Instalment contracts linked to paying account are closed.

The mandatory input fields are:

  • The issuer ID
  • Paying account reference
  • Remaining credit instalment reimbursement option (issuer or paying account)

The remaining credit for the reimbursement contract can be repaid either by the issuer or customer from their paying account defined in the credit instalment contract.

Repayment amount can be posted with 2 possible options, if repayment posting type is defined in contract property "repayment posting type":

  • Principal amount with Interest and Fee
  • Principal amount with Interest

If property is not available, three different installment operations will be posted for PRINCIPAL, INTEREST and FEE.

As a result credit instalment contract is terminated.

API links

Terminate Credit Instalment Contract

The "Terminate Credit Instalment contract" API allows the issuer or the customer to terminate the credit Instalment contract.

The mandatory input fields are:

  • The issuer ID
  • Credit Instalment Contract Reference
  • Remaining credit instalment reimbursement option (issuer or paying account)

The remaining credit for the reimbursement contract can be repaid either by the issuer or customer from their paying account defined in the credit instalment contract.

Repayment amount can be posted with 2 possible options, if repayment posting type is defined in contract property "repayment posting type":

  • Principal amount with Interest and Fee
  • Principal amount with Interest

If property is not available, three different instalment operations will be posted for PRINCIPAL, INTEREST and FEE.

As a result credit instalment contract is terminated.

API links

Enable "on this page" menu on doc section
On