ob-data-ais

Account Data

As account holder needs to grant access to their data, the process of retrieving account data consists of several main steps, also visible in the diagram below:

  1. Consent preparation
  2. Consent initiation
  3. Consent authorisation
  4. Data retrieval

We prepared a set of functions supporting these steps (the white boxes in the diagram). Each of those functions have a page with more explanation. You can choose how to integrate:

  • Using Worldline Open Banking functions directly. This allows you to control the user experience, but will require more integration effort due to various combinations of authorisation flows.
  • Using ready-to-go components (Bank Selection Interface and Push Notification). This will provide you with a streamlined integration due to a set of white labeled screens which support bank selection and guide users through the consent steps while handling the complexity of consent authorisation flows. Additionally, you can choose to receive push notifications during the initiation and authorisation phase of the consent whenever the consent status changes.

Data retrieval is done with API's during the validity time of the consent (up to 6 months). You can consult consent's validity by using dedicated get consent status endpoint.

Account Data Overview
Enable "on this page" menu on doc section
On

ob-data-initservice

Bank Selection Interface

for Data

API Reference

The Bank Selection Interface provides a set of white labeled screens which support account holder's bank selection and capturing of additional information required for certain authorisation flows. The Bank Selection Interface will simplify the integration effort for the Initiating Party by handling the pre-authentication and consent initiation flows. It can be used by setting the field UseAuthorisationLandingPages= true in the Consent request.

A few screenshots below show how the screens look on a mobile device with the Worldline branding. The majority of the elements can be customised to support your branding.

Step 1: Bank Selection

Step 2: Authorize access

Step 3: Account Selection

Step 4: You can now retrieve the data

Users quickly find their bank: we highlight popular ones and provide a blazing-fast search experience. 

After the user validates their identity through the bank’s online banking or mobile app (redirect or decoupled flow). The screenshot below shows embedded flow, where Bank Selection Interface collects user credentials prior to sending them to the bank.

User selects one or more bank accounts for which the data access will be granted.

The user allowed their bank to share the data, so now you can retrieve the account details.

Bank Selection Interface Data step 1Bank Selection Interface Data step 2Bank Selection Interface Data step 3Bank Selection Interface Data step 4
Enable "on this page" menu on doc section
On

Cards: General Features

General Features

Remind current PIN of the card

     API Reference

The API allows a PIN reminder to be requested for a card, identified by the Issuer Card External Reference or the Card Reference when a cardholder forgot its PIN.

The card must be in “ACTIVE” status.

As a result, a PIN mailer order is generated.

API links

POST /api/v2/issuers/{issuerId}/cards/{cardReference}/remind-pin

POST /api/v2/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/remind-pin

Request data:

{
           "sendingMode":"Normal",
           "deliveryType":"CUSTOMER"
        }

Response data:

{
           "responseMetadata":{
              "correlationId":"2b54aa5c-aaf7-4b93-b6b2-5e12b92fa16b",
              "statusMessage":"Executed successfully",
              "statusCode":200,
              "responseDateTime":"2023-01-03T15:14:13.531+0100",
              "timeTakenMs":206
           },
           "data":{
              "orderIdentifier":{
                 "orderReference":"202301032000000000389047"
              },
              "currentInternalStatus":"ORDERABLE",
              "orderType":"PinMailerOrder"
           }
        }

 

Retrieve Card

This API enables card information for a given card identifier to be retrieved.

The response can also be enriched (if specified as embedded fields in input) with additional data such as the status history of the card, the card Contract information, the card order identifiers linked to the card.

API links

GET /api/v2/issuers/{issuerId}/cards/{cardReference}

GET /api/v2/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}

Below an example of request for

  • The issuer: 1234
  • Card reference: 2000000000386135

POST /api/v2/issuers/1234/cards/2000000000386135

Response data:

{
   "data":{
      "issuerId":"1234",
      "cardIdentifier":{
         "cardReference":"2000000000386135",
         "issuerCardExternalReference":"EXTREF_CARD_REF_MCI_ABC_CNT_235644290"
      },
      "pan":"5212137209162844",
      "maskedPan":"521213******2844",
      "expiryDate":"1227",
      "panSequenceNumber":"1",
      "status":"ACTIVE",
      "statusDate":"2022-12-22T11:18:11.973+00:00",
      "embossingName":"REMY NAME",
      "artwork":"12340001",
      "permanentlyBlocked":false,
      "emergencyCard":false,
      "emergencyCashAdvance":false,
      "renewed":false,
      "replaced":false,
      "cardContractIdentifier":{
         "cardContractReference":"12342000000000386134",
         "issuerCardContractExternalReference":"EXTREF_CARD_CRT_REF_MCI_ABC_CNT_235644290"
      },
      "isCardDigitalizationAllowed":false,
      "panReference":"2011231c953ee52147efb5a43d532c8fa43f",
      "cardScheme":"MASTERCARD",
      "virtual":false,
      "techAndAppModelName":"M_1234_APPTEC_MCI",
      "contractType":"CONSUMER"
   }
}

Search card with PAN, PAN sequence number and expiry date

This API enables card information to be retrieved based on PAN or PAN reference, and optionally on PAN sequence number and/or expiry date information as search criteria.

The response can be enriched (if specified as embedded fields in input) with additional data such as the status history of the card, the card Contract information, the card order identifiers linked to the card, card identifiers of the new card in case of replacement or renewal.

API links

POST /api/v2/issuers/{issuerId}/cards/search

Below an example of request with the response

  • Issuer: 1234
  • PAN: 4546175178227826

As the expiry date and the sequence number are not in the request, the response gives all existing cards with the card number (here, 2 cards are provided)

POST /api/v2/issuers/1234/cards/search

Request data:

{
                   "pan":"4546175178227826"
                }

Response data:

{
                   "responseMetadata":{
                      "correlationId":"a65a1fdb-dd67-4535-9b62-a62a4efc5c3f",
                      "statusMessage":"Executed successfully",
                      "statusCode":200,
                      "responseDateTime":"2023-01-03T15:44:43.195+0100",
                      "timeTakenMs":34
                   },
                   "data":[
                      {
                         "issuerId":"1234",
                         "cardIdentifier":{
                            "cardReference":"2000000000364034"
                         },
                         "pan":"4546175178227826",
                         "maskedPan":"454617******7826",
                         "expiryDate":"1127",
                         "panSequenceNumber":"2",
                         "status":"ACTIVE",
                         "statusDate":"2022-11-23T13:14:44.818+00:00",
                         "embossingName":"Boris PAVLOV",
                         "artwork":"DebitClassic",
                         "permanentlyBlocked":false,
                         "emergencyCard":false,
                         "emergencyCashAdvance":false,
                         "renewed":false,
                         "replaced":false,
                         "cardContractIdentifier":{
                            "cardContractReference":"12342000000000364012",
                            "issuerCardContractExternalReference":"EXTREF_CARD_CRT_REF_VIS_ING_CNT_20221123145502"
                         },
                         "isCardDigitalizationAllowed":false,
                         "panReference":"1500df38371f4b2541edad420044e1ba67ba",
                         "cardScheme":"VISA",
                         "virtual":false,
                         "techAndAppModelName":"M_1234_APPTEC_EMVT0VISA",
                         "contractType":"CONSUMER"
                      },
                      {
                         "issuerId":"1234",
                         "cardIdentifier":{
                            "cardReference":"2000000000364013",
                            "issuerCardExternalReference":"EXTREF_CARD_REF_VIS_ING_CNT_20221123145502"
                         },
                         "pan":"4546175178227826",
                         "maskedPan":"454617******7826",
                         "expiryDate":"1127",
                         "panSequenceNumber":"1",
                         "status":"ACTIVE",
                         "statusDate":"2022-11-23T12:55:04.256+00:00",
                         "embossingName":"REMYPAVLOV",
                         "artwork":"DebitClassic",
                         "permanentlyBlocked":false,
                         "emergencyCard":false,
                         "emergencyCashAdvance":false,
                         "renewed":false,
                         "replaced":true,
                         "replacementReason":"CARD_DATA_UPDATE",
                         "cardContractIdentifier":{
                            "cardContractReference":"12342000000000364012",
                            "issuerCardContractExternalReference":"EXTREF_CARD_CRT_REF_VIS_ING_CNT_20221123145502"
                         },
                         "isCardDigitalizationAllowed":false,
                         "panReference":"1500df38371f4b2541edad420044e1ba67ba",
                         "cardScheme":"VISA",
                         "virtual":false,
                         "techAndAppModelName":"M_1234_APPTEC_EMVT0VISA",
                         "contractType":"CONSUMER"
                      }
                   ]
                }

Retrieve Card Contract for a Card

The API enables the card contract information related to a given card to be retrieved.

The main input fields are:

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

It is also possible to request some additional data by using the embedded fields (such as the list of models linked to the card contract, the account identifiers linked to the card contract, the identifiers and the information of the linked cards).

In return, the interface provides the generic information (mainly master data) relevant to the card contract.

API links

GET /api/v2/issuers/{issuerId}/cards/{cardReference}/card-contract

GET /api/v2/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/card-contract

Below is an example of the request and the response

In input:

  • The issuer 1234
  • The card contract reference : 12342000000000242108

GET /api/v2/issuers/1234/card-contracts/12342000000000242108

Response data:

"data":{
           "issuerId":"1234",
           "cardContractIdentifier":{
              "cardContractReference":"12342000000000242108",
              "issuerCardContractExternalReference":"T_1234_CARD_VISA_DEBIT_CLASSIC_SHARE"
           },
           "cardTemplateReference":"T_1234_CARD_VISA_DEBIT_CLASSIC_SHARE",
           "cardTypeCode":"F",
           "status":"ACTIVE",
           "openingDate":"2022-06-14T12:54:58.930+00:00",
           "activationDate":"2022-06-14T12:54:58.930+00:00",
           "trustedAuthenticationReference":"123420220614145458365",
           "newCardRenewalAllowed":true,
           "issuerBranchCode":"NO_BRANCH",
           "artwork":"DebitClassicShare",
           "forcedEmbossingName":"ROSINETTE F CANAILLETTE",
           "schemeDeclarationOptOut":true,
           "principalSupplementaryCardIndicator":"PRINCIPAL",
           "productCategory":"DEBIT",
           "productCategoryLabel":"IMMEDIATE_DEBIT_DEBIT",
           "specificFields":{
              "cardContractKey2":"value2",
              "cardContractKey1":"value1"
           },
           "productIdentifier":{
              "issuerProductExternalReference":"PDT_1234_VISA_DEBIT_CLASSIC_SHARE",
              "productReference":"PDT_1234_VISA_DEBIT_CLASSIC_SHARE"
           },
           "cardHolderIdentifier":{
              "customerReference":"CUS10000243078"
           },
           "contractIdentifier":{
              "contractReference":"REF_MCI_BSW_CNT_216566294",
              "issuerContractExternalReference":"LEGACY_REF_MCI_BSW_CNT_216566294"
           },
           "cardProfileDescription":"P_1234_CARD_VISA_DEBIT_CLASSIC_SHARE",
           "cardProfileReference":"P_1234_CARD_VISA_DEBIT_CLASSIC_SHARE"
        }

Retrieve Card event list

The API enables the events information related to a given card to be retrieved (e.g. status change such as card blocking/card activation, card issuing for replacement or renewal, PIN change.)

API links

GET /api/v2/issuers/{issuerId}/cards/{cardReference}/card-events

GET /api/v2/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/card-events

Below is an example of the request and the response for:

  • The issuer 1234
  • The card reference : 2000000000374460

Following event types are then returned : CardBlocking, CardOrderIssuing, CardActivation, CardIssuing

GET /api/v2/issuers/1234/cards/2000000000374460/card-events

Response data:

{
   "data":[
      {
         "eventType":"CardBlocking",
         "eventDate":"2022-12-05T16:16:19.514+00:00",
         "reason":"LOST",
         "waiveFee":false,
         "blockingInformation":{
            "cardBlockingDateTime":"2022-12-05T16:16:19.514+00:00",
            "blockAgent":"admin",
            "blockingReason":"LOST",
            "blockingReasonDetail":"LOST",
            "lostStolenDate":"2022-10-11T11:14:08.493+00:00",
            "lossPlace":"lossPlace",
            "lossCountry":"lossCountry",
            "lastUsageDate":"2022-10-11T11:14:08.493+00:00",
            "lastUsagePlace":"lastUsage",
            "lossCircumstances":"lossCircumstances",
            "lossReportedBy":"lossReportedBy",
            "lossReportedVia":"lossReportedVia",
            "fraudCode":"01",
            "contactData":"contactData",
            "pinCompromised":true,
            "customerRequestingBlockDate":"2022-10-14T08:14:08.493+00:00",
            "transferEffectiveDate":"2022-10-14T08:14:08.493+00:00",
            "noReplacementReason":"tempAddr",
            "comment":"comment",
            "cppFlag":false,
            "scheduledCardBlockingReason":"LOST"
         }
      },
      {
         "eventType":"CardOrderIssuing",
         "eventDate":"2022-12-05T13:13:43.385+00:00",
         "waiveFee":false
      },
      {
         "eventType":"CardActivation",
         "eventDate":"2022-12-05T13:13:43.288+00:00",
         "reason":"CARD_CREATION",
         "waiveFee":false
      },
      {
         "eventType":"CardIssuing",
         "eventDate":"2022-12-05T13:13:43.185+00:00",
         "waiveFee":false
      }
   ]
}

Retrieve blocking information for a card

The API enables the blocking information related to a given card to be retrieved.

As a response, a set of information is returned such as :

  • Blocking reason and blocking date time
  • The date when our system receives the blocking instruction
  • If the PIN has been compromised
  • Additional information in case blocking reason is LOST : Lost date, Loss circumstances, the place or the country where the card has been lost
  • If a permanent card blocking is scheduled in the future
  • If the card has been compromised in Common Point of Purchase (card is in CPP list)

API links

GET /api/v2/issuers/{issuerId}/cards/{cardReference}/blocking-information

GET /api/v2/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/blocking-information

Below an example of request and the response for:

  • Issuer: 1234
  • Card reference: 2000000000374460

GET /api/v2/issuers/1234/cards/2000000000374460/blocking-information

Response data:

{
           "data":{
              "cardBlockingDateTime":"2022-12-05T16:16:19.514+00:00",
              "blockAgent":"admin",
              "blockingReason":"LOST",
              "blockingReasonDetail":"LOST",
              "lossPlace":"lossPlace",
              "lossCountry":"lossCountry",
              "lastUsageDate":"2022-10-11T11:14:08.493+00:00",
              "lastUsagePlace":"lastUsage",
              "lossCircumstances":"lossCircumstances",
              "lossReportedBy":"lossReportedBy",
              "lossReportedVia":"lossReportedVia",
              "fraudCode":"01",
              "contactData":"contactData",
              "customerRequestingBlockDate":"2022-10-14T08:14:08.493+00:00",
              "transferEffectiveDate":"2022-10-14T08:14:08.493+00:00",
              "noReplacementReason":"tempAddr",
              "cppFlag":false
           }
        }

Update blocking information for a card

This API is no more maintained. The block card API must be used instead.

The API enables blocking information related to a given card to be updated such as:

  • Blocking reason among those available for the issuer
  • Blocking detail
  • Lost and stolen date if the blocking reason is LOST or STOLEN
  • The fraud process
  • The flag indicating whether the card is in a CPP list
  • The flag indicating whether the PIN is compromised
  • Scheduled blocking information : delay or blocking reason if the delay is not yet reached

API links

PATCH /api/v2/issuers/{issuerId}/cards/{cardReference}/blocking-information

PATCH /api/v2/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/blocking-information

Below an example of request for

  • Issuer: 1234
  • Card reference: 2000000000444867

/api/v2/issuers/1234/cards/2000000000444867/blocking-information

Request data:

{
                   "cppFlag":true,
                   "blockingReason":"LOST",
                   "blockingReasonDetail":"Detail blk rsn",
                   "lostStolenDate":"2023-03-06T17:18:42.806Z",
                   "pinCompromised":true,
                   "transferEffectiveDate":"2023-03-06T17:18:42.806Z",
                   "comment":"fieldComment"
                }

Response data:

{
                   "responseMetadata":{
                      "correlationId":"492efcae-cc01-48e0-b5b4-8944ee5937ba",
                      "statusMessage":"Executed successfully",
                      "statusCode":200,
                      "responseDateTime":"2023-03-06T18:26:22.009+0100",
                      "timeTakenMs":70
                   },
                   "data":{
                      "cardIdentifier":{
                         "cardReference":"2000000000444867",
                         "issuerCardExternalReference":"CARD-2023022800001A"
                      }
                   }
                }

Update blocking information for all cards with same PAN or same PAN reference

This API is no more maintained. The block all cards API must be used instead.

The API is similar to “Update blocking information for a card” API but is applied to all cards having the same PAN or same PAN reference.

  • Blocking information can be updated such as:
  • Blocking reason among those available for the issuer
  • Blocking detail
  • Lost and stolen date if the blocking reason is LOST or STOLEN
  • The fraud process
  • The flag indicating whether the card is in a CPP list
  • The flag indicating whether the PIN is compromised
  • Scheduled blocking information : delay or blocking reason if the delay is not yet reached

In response, card information for each matched card is provided.

API links

POST /api/v2/issuers/{issuerId}/cards/update-all-blocking-information

Create emergency card

Emergency Card is a type of card that can be provided to a customer in emergency cases (for example, a  customer has lost his card, while travelling outside his country and urgently needs a new card). The customer will call 24-hour service and request an Emergency Card.

In general, those cards will have short validity period and will not be renewed and replaced. Emergency Card is not produced by the issuer but by the scheme.

The emergency card creation is possible in our system only if an Emergency Card product is defined for the issuer and if the contract of the customer is allowed to issue an Emergency Card.

The API allows to create an emergency card for a given card.

API links

POST /api/v2/issuers/{issuerId}/cards/{cardReference}/create-emergency-card

POST /api/v2/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/create-emergency-card

Create new TAN

For PIN self-selection without a direct bank connection to the card issuing institute - i.e., without online banking access - Worldline offers the variant PIN change with TAN (Trusted Authentication Number). This applies to card programs where the bank is the card issuer for another partner, e.g., TUI or eBay.

The API allows to generate a TAN, which is used as a one-time password, printed and sent to cardholder in order to change card pin by e.g. IVR.

API links

POST /api/v2/issuers/{issuerId}/cards/{cardReference}/new-tan

POST /api/v2/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/new-tan

Below an example of request and the response for:

  • Issuer: 1234
  • Card reference: 2000000000410108

POST /api/v2/issuers/1234/cards/2000000000410108/new-tan

Request data:

{
   "tanOrigin":"string",
   "sendingMode":"normal",
   "waiveFee":false,
   "waiveShippingFee":false
}

Response data:

{
   "responseMetadata":{
      "correlationId":"a3e4fb90-72f9-4154-93d1-a0050b28c273",
      "statusMessage":"Executed successfully",
      "statusCode":200,
      "responseDateTime":"2023-01-31T15:22:50.893+0100",
      "timeTakenMs":155
   },
   "data":{
      "orderIdentifier":{
         "orderReference":"202301312000000000418220"
      },
      "currentInternalStatus":"ORDERABLE"
   }"orderType":"TanMailerOrder"
}

Retrieve CVV

This service offers the option to the issuer to display the CVV2 inside the mobile app.

As the CVV2 is not stored it must be re-created using the received card data from the request.

Note: Worldline will send the encrypted CVV2 towards the issuer. The issuer is responsible for displaying the CVV2 inside the mobile app or Homebanking service.

API links

POST /api/v2/issuers/{issuerId}/cards/{cardReference}/display-cvv

POST /api/v2/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/display-cvv

Display Pin for a card

This service offers the option to the issuer to display the PIN inside the mobile app for a given card. The card is identified either by the internal or external card reference.

Note: Worldline will only send the PIN block towards the issuer. The issuer is responsible for displaying the PIN inside the mobile app or Homebanking device.

API links

POST /api/v2/issuers/{issuerId}/cards/{cardReference}/display-pin

POST /api/v2/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/display-pin

Set a Pin for a card

This Service allows the issuer to set the PIN after card creation, via issuer home banking or mobile app The card is identified either by the internal or external card reference.

API links

POST /api/v2/issuers/{issuerId}/cards/{cardReference}/pin

POST /api/v2/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/pin

Reorder new Pin for a card

The API allows to order a new PIN for the card when a cardholder wants to change its PIN. The card must be in "CREATED" or "ACTIVE" status. As a result, a PIN mailer order with PIN REORDER reason is generated. This functionality can be used only if configured for the issuer.

API links

POST /api/v2/issuers/{issuerId}/cards/{cardReference}/pin

POST /api/v2/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/pin

Below an example of request for the

  • Card reference: 2000000000259979
  • Issuer: 1234

POST /api/v2/issuers/1234/cards/2000000000259979/reorder-pin

Request data:

{
   "sendingMode":"Normal",
   "deliveryType":"CUSTOMER"
}

Response data:

{
   "responseMetadata":{
      "correlationId":"be841b98-4624-4df6-9a67-c07b0fd44cf6",
      "statusMessage":"Executed successfully",
      "statusCode":200,
      "responseDateTime":"2023-02-03T18:52:35.578+0100",
      "timeTakenMs":475
   },
   "data":{
      "orderIdentifier":{
         "orderReference":"202302032000000000327150"
      },
      "currentInternalStatus":"ORDERABLE",
      "orderType":"PinMailerOrder"
   }
}

List orders for a card

The API enables the orders information related to a given card to be retrieved. The response can also be enriched (if specified as embedded fields in input) with additional data such as the orders status history of the card, the card information.

API links

GET /api/v2/issuers/{issuerId}/cards/{cardReference}/orders

GET /api/v2/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders

Below an example of request for the

  • Below is an example of the request and the response

    In input:

    • The issuer 1234
    • The card reference : 2000000000242109

    In response, one card order is provided back with the order reason (“FIRST_PIN_CARD_ISSUE”), the order date, the status, the pass-through data (“specific fields”) sent to the card embosser.

    GET /api/v2/issuers/1234/cards/2000000000242109/orders

Response data:

{
   "data":[
      {
         "issuerId":"1234",
         "orderType":"CardOrder",
         "orderIdentifier":{
            "orderReference":"202206142000000000242110"
         },
         "currentInternalStatus":"ORDERED",
         "currentInternalStatusDate":"2022-06-14T12:57:19.090+00:00",
         "sendingMode":"Normal",
         "deliveryType":"CUSTOMER",
         "orderReason":"FIRST_PIN_CARD_ISSUE",
         "cardProducer":"00022",
         "specificFields":{
            "insuranceCode":"insuranceCode",
            "cardOrderKey2":"value2",
            "cardOrderKey1":"value1"
         },
         "cardIdentifier":{
            "cardReference":"2000000000242109"
         },
         "free":true
      }
   ]
}

Retrieve card order for a card

The API enables the order information (card, PIN mailer or TAN mailer order) related to a given card to be retrieved. The order is identified with order reference.

The response can also be enriched (if specified as embedded fields in input) with additional data such as the orders status history of the card, the card information.

API links

GET /api/v2/issuers/{issuerId}/cards/{cardReference}/orders

GET /api/v2/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders

Below is an example of the request and the response

In input:

  • The issuer 1234
  • The card reference : 2000000000242109
  • The card order reference: 202206142000000000242110

GET /api/v2/issuers/1234/cards/2000000000242109/orders/202206142000000000242110

Request data:

{
                   "sendingMode":"Normal",
                   "deliveryType":"CUSTOMER"
                }

Response data:

{
                   "data":{
                      "issuerId":"1234",
                      "orderType":"CardOrder",
                      "orderIdentifier":{
                         "orderReference":"202206142000000000242110"
                      },
                      "currentInternalStatus":"ORDERED",
                      "currentInternalStatusDate":"2022-06-14T12:57:19.090+00:00",
                      "sendingMode":"Normal",
                      "deliveryType":"CUSTOMER",
                      "orderReason":"FIRST_PIN_CARD_ISSUE",
                      "cardProducer":"00022",
                      "specificFields":{
                         "insuranceCode":"insuranceCode",
                         "cardOrderKey2":"value2",
                         "cardOrderKey1":"value1"
                      },
                      "cardIdentifier":{
                         "cardReference":"2000000000242109"
                      },
                      "free":true
                   }
                }

Reset Pin try counter for a card

This API enables the issuer to reset the PIN try Counter value.

A control related to this counter value ((MAX Pin try) can be performed during the authorization processing if configured.

API links

POST /api/v2/issuers/{issuerId}/cards/{cardReference}/reset-pin-try-counter

POST /api/v2/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/reset-pin-try-counter

Enable "on this page" menu on doc section
On

Merchant payments

API reference Transactions doc

Merchant payments

 

This API enables you to retrieve comprehensive payment data using specific criteria and periods of time.

  • Show payments data in your application of preference
  • The merchant payments are matched with PAID status transactions in the Transactions API for reconciliation purposes
  • Acquirers can allow third parties access to retrieve own merchant payments data

 

GET Merchant payments calls

Request parameters in bold on the Merchant payments 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 two types of GET METHOD calls:

  • GET call to Search using one or more query parameters (e.g. paymentReference, merchantHierarchyId, merchantId, contractId and iban). Valid calls return a list of payment results
  • GET calls to retrieve a Specific entity (e.g. paymentId) – returns a particular payment result

 

Enable "on this page" menu on doc section
On

Card lifecycle management

Card Lifecycle Management

Worldline supports the whole card lifecycle.

Please find below an illustration of the possible transitions from one status to another

Activate a card

An issuer can activate a card on demand from Issuer Card External Reference or Card Reference only if the card is in CREATED status.

The issuer chooses the activation reason from the customised reasons previously configured.

 

As a result, the card is active in our system.

Note : The issuer can alternatively use one of the options offered by WL system to activate a card such as:

  • Directly when the card is created
  • or at first PIN based approved authorization

API links

POST/api/v2/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/activate

POST/api/v2/issuers/{issuerId}/cards/{cardReference}/activate

Block a card

The API allows to block a card permanently (immediately or in the future) or to block a card temporarily depending on the configured blocking reason by using the Issuer Card External Reference or the Card Reference.

The card is in “CREATED” or “ACTIVE” status.

The blocking reason is chosen among the reasons configured beforehand for the issuer.

Example of use cases :

Use case 1: The card is blocked permanently, in case of lost, stolen, not delivered, fraudulent activity, for example.

The issuer can provide:

  • Transfer Effective Date – estimated date when the card was lost or stolen
  • If the PIN is compromised
  • If the card is lost or stolen:
    • Lost Stolen Date
  • If the card is lost:
    • Loss Circumstances

As a result, the card is definitively blocked in our system (final status).

Next online authorizations are declined for the card. 

If the card is permanently blocked, it can be notified to the scheme (card exceptions file sent to Stoplist network).

Use case 2: The card has been compromised in Common Point of Purchase (CPP) : a permanent card blocking is scheduled for the card and the cardholder is still allowed to use its card for PIN based transactions by the issuer.

The issuer indicates that the card has been compromised in a Common Point of Purchase (cppFlag) and provides the delay to block the card in the future (scheduledCardBlockingDelay)

As a result, the card is still active in our system and a permanent card blocking is scheduled for the card.

Authorizations are still accepted for the card.

The card is effectively blocked via batch process once the scheduled permanent card blocking date is reached.

Use case 3: The card is blocked temporarily in case of fraud suspicion by e.g. Issuer or Fraud system.

Fraud information as free text (fraud code) can be provided and can be used later (e.g. in dispute management in case there is a fraud declared on this card) 

As a result, the card is temporarily blocked in our system and can be unblocked later.

Next online authorizations are declined for the card.

It is also possible to update the following blocking information by this API :

  • When the card is already blocked:
    • Blocking reason among those available for the issuer
    • Blocking detail
    • Lost and stolen date if the blocking reason is LOST or STOLEN
    • Fraud process
    • The flag indicating whether the PIN is compromised
    • Scheduled blocking information : delay or blocking reason if the delay is not yet reached
  • When the card is active :
    • Scheduled blocking information : delay or blocking reason if the delay is not yet reached

 

API links

POST /api/v2/issuers/{issuerId}/cards/{cardReference}/block

POST /api/v2/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/block

Example : Request for permanent blocking reason

  • Issuer: 1234
  • CardReference: 2000000000374460
  • Blocking reason: LOST

POST /api/v2/issuers/1234/cards/2000000000374460/block

Request data

{
                   "blockingReason":"LOST",
                   "blockingReasonDetail":"LOST",
                   "comment":"comment",
                   "contactData":"contactData",
                   "customerRequestingBlockDate":"2022-10-14T08:14:08.493Z",
                   "fraudCode":"01",
                   "lastUsageDate":"2022-10-11T11:14:08.493Z",
                   "lastUsagePlace":"lastUsage",
                   "lossCircumstances":"lossCircumstances",
                   "lossCountry":"lossCountry",
                   "lossPlace":"lossPlace",
                   "lossReportedBy":"lossReportedBy",
                   "lossReportedVia":"lossReportedVia",
                   "lostStolenDate":"2022-10-11T11:14:08.493Z",
                   "noReplacementReason":"tempAddr",
                   "pinCompromised":true,
                   "transferEffectiveDate":"2022-10-14T08:14:08.493Z"
                }

Response data

"data":{
                   "cardIdentifier":{
                      "cardReference":"2000000000374460"
                   },
                   "status":"BLOCKED",
                   "blockingReason":"LOST",
                   "blockingReasonDetail":"LOST",
                   "cardBlockingDateTime":"2022-12-05T16:16:19.514+00:00"
                }

Unblock a card

An issuer can reactivate a temporarily blocked card.

The card is in temporary “Blocked” status.

The issuer identifies the card with their own reference (Issuer Card External Reference) or with the reference generated by WL (Card Reference).

The issuer chooses the unblocking reason from the reasons configured beforehand for him.

As a result, the card is active again in our system.

 

An issuer cannot request the unblocking of a permanently blocked card.

API links

POST /api/v2/issuers/{issuerId}/cards/{cardReference}/unblock

POST /api/v2/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/unblock

Block all cards with same PAN or same PAN reference

The API is similar to Block a card API but is applied to all cards having the same PAN or same PAN reference.

The API allows the permanent blocking (immediately or in the future), or temporary blocking, depending on the configured blocking reason, of all cards having the same PAN or same PAN reference.

Cards must be in “CREATED” or “ACTIVE” status.

The blocking reason is chosen from the reasons configured beforehand for the issuer

It is also possible to update the following blocking information by this API :

  • When the card is already blocked:
    • Blocking reason among those available for the issuer
    • Blocking detail
    • Lost and stolen date if the blocking reason is LOST or STOLEN
    • Fraud process
    • The flag indicating whether the PIN is compromised
    • Scheduled blocking information : delay or blocking reason if the delay is not yet reached
  • When the card is active :
    • Scheduled blocking information : delay or blocking reason if the delay is not yet reached

API links

POST /api/v2/issuers/{issuerId}/cards/block-all

Unblock all cards with same PAN or same PAN reference

The API is similar to Unblock a card API but is applied to all cards having the same PAN or same PAN reference.

The API allows the unblocking of all cards having the same PAN or same PAN reference.

Cards must be in temporary “Blocked” status.

The unblocking reason is chosen from the reasons configured beforehand for the issuer.

The Issuer cannot request this API for permanently blocked cards.

As a result, cards having the same PAN or same PAN reference are active again in our system.

API links

POST /api/v2/issuers/{issuerId}/cards/unblock-all

Deactivate a card

The API allows an active card, or a temporary blocked card, to be deactivated on demand, by using the Issuer Card External Reference or the Card Reference.

The deactivation reason is chosen from the reasons configured beforehand for the issuer.

As a result, the card is deactivated in our system.

This process is not reversible. New card authorizations are declined. If necessary, a request for a card replacement may be made by the issuer.

This API allows also to cancel a card in “Created” status, e.g., when the card production has failed.

API links

POST /api/v2/issuers/{issuerId}/cards/{cardReference}/deactivate

POST /api/v2/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/deactivate

Replace a card

The API allows a card, that has not yet been replaced or renewed, to be replaced when the card is lost/stolen or damaged, or when the customer’s information has changed, by using the Issuer Card External Reference or the Card Reference.

The card contract must be ACTIVE with no replacement blocking and the card must not be in CREATED status.

The replacement reason is chosen from the reasons configured beforehand for the issuer.

Data that may need to be changed during replacement can be provided, such as: card data (e.g., embossing name), order data (e.g., card producer if several are allowed), customer data (e.g., name), PIN.

As a result, the new card is created, a card order and a PIN mailer order are created when applicable (physical card requested).

In case a product change on renewal is planned on the contract of the card to be replaced, the card will not be replaced but the product change will be forced instead. From the request, only blocking reason and embossingName/embossingName2ndLine will be considered :

  • If blocking reason is provided (for temporary blocking only), the new card of the new contract is blocked with this reason
  • If embossingName and/or embossingName2ndLine are provided, they will be appplied to the old card and will be transferred to the new card of the new contract.

In the request response, information related to the new contract and the product change will be returned.

API links

POST /api/v2/issuers/{issuerId}/cards/{cardReference}/replace

POST /api/v2/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/replace

Example Replacement Request for LOST_STOLEN replacement reason

  • Issuer: 1234
  • CardReference: 2000000000374460
  • replacement reason: LOST_STOLEN

POST /api/v2/issuers/1234/cards/2000000000374460/replace

Request data:

{
           "waiveFee":false,
           "replacementReason":"LOST_STOLEN",
           "cardContract":{
              "specificFields":{
                 "additionalProp1":"string",
                 "additionalProp2":"string",
                 "additionalProp3":"string"
              },
              "card":{
                 "issuerCardExternalReference":"CARD-20221119",
                 "cardOrder":{
                    "specificFields":{
                       "additionalProp1":"string",
                       "additionalProp2":"string",
                       "additionalProp3":"string"
                    },
                    "sendingMode":"Normal"
                 }
              }
           },
           "overrideDistributionRules":false
        }

Response data:

"data":{
           "card":{
              "cardIdentifier":{
                 "cardReference":"2000000000374491",
                 "issuerCardExternalReference":"CARD-20221119"
              },
              "pan":"4546174672045636",
              "maskedPan":"454617******2386",
              "expiryDate":"1227",
              "panSequenceNumber":"1",
              "status":"ACTIVE",
              "replacementFor":{
                 "cardReference":"2000000000374460"
              },
              "orders":[
                 {
                    "orderIdentifier":{
                       "orderReference":"202212052000000000374492"
                    },
                    "orderType":"CardOrder",
                    "currentInternalStatus":"ORDERABLE"
                 }
              ],
              "panReference":"1500d015027a202e47b39d56e25aab9fcc1d"
           },
           "replacementForCardStatus":"BLOCKED",
           "replacementReason":"LOST_STOLEN",
           "cardReplacementDateTime":"2022-12-05T16:27:57.340+00:00"
        }

Block and replace a card

The API allows a card identified by the Issuer Card External Reference or the Card Reference to be blocked and replaced.

This API regroups Block a card (for card blocking or blocking information update) and Replace a card APIs in a single request.

As result, the card is blocked and the new card is created.

If any error occurs while card blocking or card replacing, the card is neither blocked nor replaced.

With this API, it is also possible to block all cards having the same PAN than the card referenced by Issuer Card External Reference or the Card Reference. In this case Block all cards API is called instead Block a card API.

In case a product change on renewal is planned on the contract of the card to be replaced, the card will not be replaced but the product change will be forced instead. From the replace card request, only blocking reason and embossingName/embossingName2ndLine will be considered :

  • If blocking reason is provided (for temporary blocking only), the new card of the new contract is blocked with this reason
  • If embossingName and/or embossingName2ndLine are provided, they will be applied to the old card and will be transferred to the new card of the new contract.

In the request response, information related to the new contract and the product change will be returned.

API links

POST /api/v2/issuers/{issuerId}/cards/{cardReference}/block-and-replace

POST /api/v2/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/block-and-replace

Enable "on this page" menu on doc section
On

General Contract Management

General Contract Management

Create A Consumer Contract

API Reference

The Create Consumer Contract API allows the creation of a new consumer contract already signed by the customer or not, and its first card(s), either with physical support (plastic) or not (virtual card).

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 contract, the system will return the data from the existing contract (e.g., if the API call returns a "time-out“ response, the same correlation ID can be provided to retrieve contract data from WL system for further checks).
  • An active consumer product exists with a physical or pure virtual card.

The issuer can request the creation of a new consumer contract from the provided active consumer product with additional information such as

  • the contract is already signed (status as "SIGNED") by the customer or not (status as "AWAITING_SIGNATURE")
  • The issuer can provide a list of new customers or the references to existing customers in Worldline system

As a result, the contract is created:

  • with the provided status by the issuer: either the contract is already signed (its account hierarchy is immediately in "ACTIVE" status) or not (its account hierarchy is in "AWAITING_SIGNATURE" status)
  • with each card and its status set to created or active, depending on the card product configuration
  • with related card order to produce the physical card, if plastic required and the pin mailer order if required.

The API response returns newly created contract information such as

  • the new contract itself
  • the different identifiers such as the contract reference, contract owner, account owner, add-on, card contract, card and cardholder. Each identifier is composed of the Worldline internal reference and the external reference (is not present if not provided by the issuer and not generated by any algorithm)

The references are used to: retrieve/update/close contracts, list accounts for a contract, retrieve the contract owner for a contract, retrieve/update legitimacy documents, etc..

Additional information for credit card when creating the contract

  • it is possible to provide a customized credit limit amount value (e.g. after credit scoring)
  • it is possible to provide SEPA mandate data to send a direct debit note to the debtor’s bank to repay the cyclic due amount
  • it is possible to provide an insurance package (in order to calculate insurance fees) and to activate it (insuranceEventCode)

Additional information for prepaid card when creating the contract

  • the credit limit amount is equal to 0 and cannot be changed during contract lifetime
  • it is possible to provide SEPA mandate data to send a direct debit note to the debtor’s bank in case offline transactions have to be repaid (note that our system can put on hold such offline transactions that lead the prepaid account to a debit position, waiting for payment by the customer)

Card Issue Flow

 

API links

POST /api/v2/issuers/{issuerId}/contracts/create-consumer-contract

Below is an example where the data for customer creation is provided in the request:

POST /api/v2/issuers/1234/contracts/create-consumer-contract

Request data

"data":{
   " ""customers":" "[
      "        "{
         "/* Comment":"here is provided the customer required to create this contract. This customer is the contract owner (see above contractOwnerRequestCorrelationId"": "92"). Then it is also the account owner of the account “issuerAccountExternalReference":" ""ROOT_ACCOUNT-202212050001""and also the cardholder of the card by automatic inheritance. */ 

            ""addresses":" "[
            "                "{
               "addressLabel":" ""MAIN_POSTAL_ADDRESS",
               "                    ""addressType":" ""POSTAL_MAIL",
               "                    ""issuerAddressExternalReference":" ""ADDRESS-202212050001",
               "                    ""postalAddress":" "{
                  "                        ""line1":" ""Belziger 70",
                  "                        ""line2":" ""Test line2",
                  "                        ""townName":" ""BERLIN",
                  "                        ""country":" ""DE""                    "
               }"                "
            }"            "
         ],
         "            ""birthDate":" ""1970-10-22T00:00Z",
         "            ""birthPlace":" ""London",
         "            ""courtesyTitle":" ""Mr",
         "            ""firstName":" ""John",
         "            ""issuerCustomerExternalReference":" ""PERSON-202212050001",
         "            ""lastName":" ""SMITH",
         "            ""commercialStatus":" ""Normal",
         "            ""onlineRiskCategory":" ""Standard",
         "            ""offlineRiskCategory":" ""Standard",
         "            ""requestCorrelationId":" ""92",
         "/* is used in the rest of the message to assign this new customer as e.g. contract owner",
         "account owner",
         "cardholder) */ 

            ""sex":" ""M",
         "            ""nationality":" ""DE""        "
      }"/* Another new customer can be provided if contract owner and account owner or cardholder are not the same */ 
    "
   ]"    ""contract":" "{
      "        ""accountHierarchy":" "{
         "            ""accounts":" "[
            "                "{
               "                    ""accountTemplateReference":" ""T_1234_ACC_ROOT_VISA_DEBIT_CLASSIC",
               "                    ""bic":" ""XXXDEBB",
               "                    ""iban":" ""DE02500105174128973163",
               "                    ""issuerAccountExternalReference":" ""ROOT_ACCOUNT-202212050001""                "
            },
            "                "{
               "                    ""accountTemplateReference":" ""T_1234_ACC_CHILD_VISA_DEBIT_CLASSIC",
               "                    ""bic":" ""XXXDEBB",
               "                    ""iban":" ""DE02500105174128973163",
               "                    ""issuerAccountExternalReference":" ""CHILD_ACCOUNT-202212050001""                "
            }"            "
         ]"        "
      },
      "        ""cardContracts":" "[
         "            "{
            "      ""card":" "{
               "                    ""cardOrder":" "{
                  "                        ""sendingMode":" ""Normal""                    "
               },
               "                    ""issuerCardExternalReference":" ""CARD-202212050001""                "
            },
            "                ""cardTemplateReference":" ""T_1234_CARD_VISA_DEBIT_CLASSIC",
            "                ""forcedEmbossingName":" ""SMITH JOHN",
            "                ""forcedEmbossingName2ndLine":" ""STEVEN",
            "                ""issuerCardContractExternalReference":" ""CARD_CONTRACT-202212050001""            "
         }"        "
      ],
      "        ""cardReleaseOrder":" ""AUTOMATIC",
      "        ""contractOwnerRequestCorrelationId":" ""92",
      /* the new customer provided in the list of customers above and identiied by correlationId as “92” is assigned to contract owner role */ 

        "issuerContractExternalReference":" ""CONTRACT-202212050001",
      "        ""issuerProductExternalReference":" ""PDT_1234_VISA_DEBIT_CLASSIC",
      "        ""issuerBranchCode":" ""NO_BRANCH""    "
   }
}

Response data

"data":{
   " ""contract":" "{
      "            ""contractIdentifier":" "{
         "                ""contractReference":" ""4459f986-5242-4202-9ed5-f652573e9f63",
         "                ""issuerContractExternalReference":" ""CONTRACT-202212050001""            "
      },
      "            ""status":" ""SIGNED",
      "            ""creationDate":" ""2022-12-05T12:34:43.770+00:00",
      "            ""signatureDate":" ""2022-12-05T12:34:43.758+00:00",
      "            ""issuerBranchCode":" ""NO_BRANCH",
      "            ""cardReleaseOrder":" ""AUTOMATIC",
      "            ""productIdentifier":" "{
         "                ""issuerProductExternalReference":" ""PDT_1234_VISA_DEBIT_CLASSIC",
         "                ""productReference":" ""PDT_1234_VISA_DEBIT_CLASSIC""            "
      },
      "            ""contractOwnerIdentifier":" "{
         "            ""customerReference":" ""CUS10000346472",
         "            ""issuerCustomerExternalReference":" ""PERSON-202212050001""            "
      },
      "            ""accounts":" "[
         "                "{
            "accountIdentifier":" "{
               "                 ""accountReference":" ""12348505533653587133",
               "                 ""issuerAccountExternalReference":" ""CHILD_ACCOUNT-202212050001""                    "
            },
            "                    ""root":" false",
            "                    ""status":" ""ACTIVE",
            "                    ""accountOwnerIdentifier":" "{
               "                    ""customerReference":" ""CUS10000346472",
               "                    ""issuerCustomerExternalReference":" ""PERSON-202212050001""                    "
            },
            "                    ""accountGuarantorIdentifier":" "{
               "                    ""customerReference":" ""CUS10000346472",
               "                   ""issuerCustomerExternalReference":" ""PERSON-202212050001""                    "
            }"                "
         },
         "                "{
            "accountIdentifier":" "{
               "                  ""accountReference":" ""12346621070985963583",
               "                ""issuerAccountExternalReference":" ""ROOT_ACCOUNT-202212050001""                    "
            },
            "                    ""root":" true",
            "                    ""status":" ""ACTIVE",
            "                    ""accountOwnerIdentifier":" "{
               "                    ""customerReference":" ""CUS10000346472",
               "                    ""issuerCustomerExternalReference":" ""PERSON-202212050001""                    "
            },
            "                   ""accountGuarantorIdentifier":" "{
               "                        ""customerReference":" ""CUS10000346472",
               "                        ""issuerCustomerExternalReference":" ""PERSON-202212050001""                    "
            }"                "
         }"            "
      ],
      "            ""cardContracts":" "[
         "                "{
            "  ""cardContractIdentifier":" "{
               "                    ""cardContractReference":" ""12342000000000374437",
               "                    ""issuerCardContractExternalReference":" ""CARD_CONTRACT-202212050001""                    "
            },
            "                    ""cardHolderIdentifier":" "{
               "                       ""customerReference":" ""CUS10000346472",
               "                        ""issuerCustomerExternalReference":" ""PERSON-202212050001""                    "
            },
            "                    ""status":" ""ACTIVE",
            "                    ""principalSupplementaryCardIndicator":" ""PRINCIPAL",
            "                    ""card":" "{
               "                        ""cardIdentifier":" "{
                  "                           ""cardReference":" ""2000000000374438",
                  "                            ""issuerCardExternalReference":" ""CARD-202212050001""                        "
               },
               "                        ""pan":" ""4546177060616413",
               "                        ""maskedPan":" ""454617******6413",
               "                        ""expiryDate":" ""1227",
               "                        ""panSequenceNumber":" ""1",
               "                        ""status":" ""ACTIVE",
               "                        ""orders":" "[
                  "                            "{
                     "                                ""orderIdentifier":" "{
                        "                                    ""orderReference":" ""202212052000000000374439""                                "
                     },
                     "                                ""orderType":" ""CardOrder",
                     "                                ""currentInternalStatus":" ""ORDERABLE""                            "
                  }"                        "
               ],
               "                        ""panReference":" ""1500fc52cb34fa714bf3bd94c9421d38c79c""                    "
            },
            "                    ""relatedAccounts":" "[
               "                       "{
                  "                            ""relation":" ""DEFAULT",
                  "                            ""accountIdentifier":" "{
                     "                                ""accountReference":" ""12348505533653587133",
                     "                               ""issuerAccountExternalReference":" ""CHILD_ACCOUNT-202212050001""                            "
                  }"                        "
               }"                    "
            ]"                "
         }"            "
      ]"        "
   },
   "        ""customers":" "[
      "            "{
         "                ""customerIdentifier":" "{
            "                    ""customerReference":" ""CUS10000346472",
            "                    ""issuerCustomerExternalReference":" ""PERSON-202212050001""                "
         },
         "                ""courtesyTitle":" ""Mr",
         "                ""lastName":" ""SMITH",
         "                ""firstName":" ""John",
         "                ""addresses":" "[
            "                    "{
               "                        ""addressIdentifier":" "{
                  "                            ""addressReference":" ""ADDREF_MAIN_POSTAL_ADDRESS_1000000000385897",
                  "                            ""issuerAddressExternalReference":" ""ADDRESS-202212050001""                        "
               },
               "                        ""addressLabel":" ""MAIN_POSTAL_ADDRESS",
               "                        ""addressType":" ""POSTAL_MAIL""                    "
            }"                "
         ]"            "
      }"        "
   ]"    "
}
}
}

Search Contracts By criteria​

This API is no more maintained. The Global search for contracts API must be used instead to retrieve consumer contracts by criteria (multi issuers).

The API provides possibility to retrieve a list of consumer contracts for an issuer, based on certain criteria.

One of the following criteria for searching must be provided:

  • either account's criteria
  • or customer's criteria
  • or card's criteria

For searching with account's criteria, only one of the following data must be provided :

  • IBAN
  • or account identifier : either account reference or issuer account external reference
  • or account membership number 1
  • or account membership number 2

For searching with customer's criteria, only one of the following data must be provided :

  • Customer Attributes with last name and first name (and optionally with birth date, postal address : postal code, street name and/or building number, phonetic criteria : phonetic search and/or phonetic algorithm)
  • or customer identifier : either customer reference or issuer customer external reference
  • or partner external reference

For searching with card's criteria, only one of the following data must be provided :

  • PAN
  • or card contract identifier : either card contract reference or issuer card contract external reference
  • or card identifier : either card reference or issuer card external reference

If requested, the API input parameters allows also to:

  • limit the list of returned cards per card contract to either the latest card only or all previous cards
  • return the direct parent account in the hierarchy of the account and/or the list of child accounts of the account matching the criteria if the research is based on account's criteria
  • request to enrich the response with additional data relative to the accounts, the card contracts, the cards and the customers by using embedded fields

The API response contains all matched contracts and for each returned contract some information is provided such as :

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

API links

POST /api/v2/issuers/{issuerId}/contracts/search

 

Retrieve Contract

This API allows the retrieval of a particular contract from its reference or its issuer external reference.

The API response contains contract information, such as:

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

API links

GET /api/v2/issuers/{issuerId}/contracts/{contractReference}​

GET /api/v2/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}​

Below an example of a request for:

  • The contract: 4459f986-5242-4202-9ed5-f652573e9f63
  • The issuer: 1234

GET /api/v2/issuers/1234/contracts/4459f986-5242-4202-9ed5-f652573e9f63

Response data

"data":" "{
           "issuerId":" ""1234",
           "        ""contractIdentifier":" "{
              "            ""contractReference":" ""4459f986-5242-4202-9ed5-f652573e9f63",
              "            ""issuerContractExternalReference":" ""CONTRACT-202212050001""        "
           },
           "        ""issuerBranchCode":" ""NO_BRANCH",
           "        ""cardReleaseOrder":" ""AUTOMATIC",
           "        ""signatureDate":" ""2022-12-05T12:34:43.000+00:00",
           "        ""status":" ""SIGNED",
           "        ""statusDate":" ""2022-12-05T12:34:43.000+00:00",
           "        ""contractOwnerIdentifier":" "{
              "            ""customerReference":" ""CUS10000346472",
              "            ""issuerCustomerExternalReference":" ""PERSON-202212050001""        "
           },
           "        ""productIdentifier":" "{
              "            ""issuerProductExternalReference":" ""PDT_1234_VISA_DEBIT_CLASSIC",
              "            ""productReference":" ""PDT_1234_VISA_DEBIT_CLASSIC""        "
           },
           "        ""rootAccountIdentifier":" "{
              "            ""accountReference":" ""12346621070985963583",
              "            ""issuerAccountExternalReference":" ""ROOT_ACCOUNT-202212050001""        "
           }"    "
        }

Below a second example of a request for:

  • The contract: 1e9802ae-68db-467b-8610-ae59f0d37291
  • The issuer: 1234

With requested embedded field: cardContracts

In the response, the 3 card contracts are provided.

GET /api/v2/issuers/1234/contracts/1e9802ae-68db-467b-8610-ae59f0d37291?embed=cardContracts

Response data

"data":{
           "        ""issuerId":" ""1234",
           "        ""contractIdentifier":" "{
              "            ""contractReference":" ""1e9802ae-68db-467b-8610-ae59f0d37291",
              "            ""issuerContractExternalReference":" ""CONTRACT-202212130001""        "
           },
           "        ""issuerBranchCode":" ""NO_BRANCH",
           "        ""cardReleaseOrder":" ""AUTOMATIC",
           "        ""numberOfFreeCardsPrimaryCardImpacted":" false",
           "        ""signatureDate":" ""2022-12-13T14:40:21.000+00:00",
           "        ""status":" ""SIGNED",
           "        ""statusDate":" ""2022-12-13T14:40:21.000+00:00",
           "        ""cardContracts":" "[
              "            "{
                 "                ""issuerId":" ""1234",
                 "                ""cardContractIdentifier":" "{
                    "                    ""cardContractReference":" ""12342000000000380697""                "
                 },
                 "                ""cardTemplateReference":" ""T_1234_CARD_VISA_DEBIT_CLASSIC",
                 "                ""cardTypeCode":" ""F",
                 "                ""status":" ""ACTIVE",
                 "                ""openingDate":" ""2022-12-13T15:25:57.710+00:00",
                 "                ""activationDate":" ""2022-12-13T15:25:57.730+00:00",
                 "                ""trustedAuthenticationReference":" ""123420221213162557294",
                 "                ""newCardRenewalAllowed":" true",
                 "                ""issuerBranchCode":" ""NO_BRANCH",
                 "                ""artwork":" ""DebitClassic",
                 "                ""forcedEmbossingName":" ""BOUBOU",
                 "                ""schemeDeclarationOptOut":" false",
                 "                ""principalSupplementaryCardIndicator":" ""SUPPLEMENTARY",
                 "                ""productCategory":" ""DEBIT",
                 "                ""productCategoryLabel":" ""IMMEDIATE_DEBIT_DEBIT",
                 "                ""productIdentifier":" "{
                    "                    ""issuerProductExternalReference":" ""PDT_1234_VISA_DEBIT_CLASSIC",
                    "                    ""productReference":" ""PDT_1234_VISA_DEBIT_CLASSIC""                "
                 },
                 "                ""cardHolderIdentifier":" "{
                    "                    ""customerReference":" ""CUS10000351532",
                    "                    ""issuerCustomerExternalReference":" "" PERSON-202212130001B""                "
                 },
                 "                ""vipFlag":" false",
                 "                ""contractIdentifier":" "{
                    "                    ""contractReference":" ""1e9802ae-68db-467b-8610-ae59f0d37291",
                    "                    ""issuerContractExternalReference":" ""CONTRACT-202212130001""                "
                 },
                 "                ""cardProfileDescription":" ""P_1234_CARD_VISA_DEBIT_CLASSIC",
                 "                ""cardProfileReference":" ""P_1234_CARD_VISA_DEBIT_CLASSIC""            "
              },
              "            "{
                 "                ""issuerId":" ""1234",
                 "                ""cardContractIdentifier":" "{
                    "                    ""cardContractReference":" ""12342000000000380694",
                    "                    ""issuerCardContractExternalReference":" ""CARD_CONTRACT-202212130001""                "
                 },
                 "                ""cardTemplateReference":" ""T_1234_CARD_VISA_DEBIT_CLASSIC",
                 "                ""cardTypeCode":" ""F",
                 "                ""status":" ""ACTIVE",
                 "                ""openingDate":" ""2022-12-13T14:40:21.527+00:00",
                 "                ""activationDate":" ""2022-12-13T14:40:21.527+00:00",
                 "                ""trustedAuthenticationReference":" ""123420221213154021607",
                 "                ""newCardRenewalAllowed":" true",
                 "                ""issuerBranchCode":" ""NO_BRANCH",
                 "                ""artwork":" ""DebitClassic",
                 "                ""forcedEmbossingName":" ""BOUBOU*TEST BOUBOU EMBOSS2",
                 "                ""schemeDeclarationOptOut":" false",
                 "                ""principalSupplementaryCardIndicator":" ""PRINCIPAL",
                 "                ""productCategory":" ""DEBIT",
                 "                ""productCategoryLabel":" ""IMMEDIATE_DEBIT_DEBIT",
                 "                ""productIdentifier":" "{
                    "                    ""issuerProductExternalReference":" ""PDT_1234_VISA_DEBIT_CLASSIC",
                    "                    ""productReference":" ""PDT_1234_VISA_DEBIT_CLASSIC""                "
                 },
                 "                ""cardHolderIdentifier":" "{
                    "                    ""customerReference":" ""CUS10000351531",
                    "                    ""issuerCustomerExternalReference":" ""PERSON-202212130001""                "
                 },
                 "                ""vipFlag":" false",
                 "                ""contractIdentifier":" "{
                    "                    ""contractReference":" ""1e9802ae-68db-467b-8610-ae59f0d37291",
                    "                    ""issuerContractExternalReference":" ""CONTRACT-202212130001""                "
                 },
                 "                ""cardProfileDescription":" ""P_1234_CARD_VISA_DEBIT_CLASSIC",
                 "                ""cardProfileReference":" ""P_1234_CARD_VISA_DEBIT_CLASSIC""            "
              },
              "            "{
                 "                ""issuerId":" ""1234",
                 "                ""cardContractIdentifier":" "{
                    "                    ""cardContractReference":" ""12342000000000380700""                "
                 },
                 "                ""cardTemplateReference":" ""T_1234_CARD_VISA_DEBIT_CLASSIC",
                 "                ""cardTypeCode":" ""F",
                 "                ""status":" ""ACTIVE",
                 "                ""openingDate":" ""2022-12-13T16:54:15.002+00:00",
                 "                ""activationDate":" ""2022-12-13T16:54:15.112+00:00",
                 "                ""trustedAuthenticationReference":" ""123420221213175415246",
                 "                ""newCardRenewalAllowed":" true",
                 "                ""issuerBranchCode":" ""NO_BRANCH",
                 "                ""artwork":" ""DebitClassic",
                 "                ""forcedEmbossingName":" ""BOUBOU",
                 "                ""schemeDeclarationOptOut":" false",
                 "                ""principalSupplementaryCardIndicator":" ""SUPPLEMENTARY",
                 "                ""productCategory":" ""DEBIT",
                 "                ""productCategoryLabel":" ""IMMEDIATE_DEBIT_DEBIT",
                 "                ""productIdentifier":" "{
                    "                    ""issuerProductExternalReference":" ""PDT_1234_VISA_DEBIT_CLASSIC",
                    "                    ""productReference":" ""PDT_1234_VISA_DEBIT_CLASSIC""                "
                 },
                 "                ""cardHolderIdentifier":" "{
                    "                    ""customerReference":" ""CUS10000351533",
                    "                    ""issuerCustomerExternalReference":" ""PERSON-202212130001C""                "
                 },
                 "                ""vipFlag":" false",
                 "                ""contractIdentifier":" "{
                    "                    ""contractReference":" ""1e9802ae-68db-467b-8610-ae59f0d37291",
                    "                    ""issuerContractExternalReference":" ""CONTRACT-202212130001""                "
                 },
                 "                ""cardProfileDescription":" ""P_1234_CARD_VISA_DEBIT_CLASSIC",
                 "                ""cardProfileReference":" ""P_1234_CARD_VISA_DEBIT_CLASSIC""            "
              }"        "
           ],
           "        ""contractOwnerIdentifier":" "{
              "            ""customerReference":" ""CUS10000351531",
              "            ""issuerCustomerExternalReference":" ""PERSON-202212130001""        "
           },
           "        ""productIdentifier":" "{
              "            ""issuerProductExternalReference":" ""PDT_1234_VISA_DEBIT_CLASSIC",
              "            ""productReference":" ""PDT_1234_VISA_DEBIT_CLASSIC""        "
           },
           "        ""rootAccountIdentifier":" "{
              "            ""accountReference":" ""12343652199237560111",
              "            ""issuerAccountExternalReference":" ""ROOT_ACCOUNT-202212130001""        "
           }"    "
        }
        }

Update Addresses Of All Contract Members

This API is used to update all members of a given contract with same provided address (including address usages).

E.g., for Contract A, contract owner, cardholders 1 and 2 are updated simultaneously with the same Main postal address data.

This API is used also:

  • to invalidate a particular address of all members of a contract by setting the flag "invalid" to True and providing only the address label and the address type (limited to address type as postalAddress). All the other data are ignored.
  • or to provide a valid address for all contract members by setting the flag "invalid" to False (default value) and providing the address label, the address type and the valid address (limited to address type as postalAddress)’

Each provided address must have

  • an addressLabel among the ones configured such as MAIN_POSTAL_ADDRESS
  • an address type to indicate whether it a postal, an e-mail or a phone number
  • the address itself depending on its type: MailAddress, EmailAddress or PhoneNumber

Each provided address can have

  • none, 1,... N address usages. Such address usages can be used to retrieve the address related to a business process (e.g. CARD_DELIVERY used to identify the address to be used to send the card to the cardholder).
  • startDate: this is the date when the provided address becomes valid. If not provided this is by default the current date.

API links

POST /api/v2/issuers/{issuerId}/contracts/{contractReference}/update-all-customers-addresses​

POST /api/v2/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/update-all-customers-addresses​

POST /api/v2/issuers/1234/contracts/1e9802ae-68db-467b-8610-ae59f0d37291/update-all-customers-addresses

Request data

{
           "  ""addresses":" "[
              "    "{
                 "      ""addressLabel":" ""MAIN_POSTAL_ADDRESS",
                 "      ""addressType":" ""POSTAL_MAIL",
                 "      ""postalAddress":" "{
                    "        ""line1":" ""50 AVENUE LAMARTINE",
                    "        ""line3":" ""string",
                    "        ""line4":" ""string",
                    "        ""line5":" ""string",
                    "        ""buildingNumber":" ""50",
                    "        ""streetName":" ""AVENUE LAMARTINE",
                    "        ""postCode":" ""75010",
                    "        ""townName":" ""PARIS",
                    "        ""country":" ""FR""      "
                 },
                 "      ""startDate":" ""2022-12-13T16:37:26.625Z""    "
              }"  "
           ]
        }

Response data

"data":" "{
           {
              "        ""contractIdentifier":" "{
                 "            ""contractReference":" ""1e9802ae-68db-467b-8610-ae59f0d37291",
                 "            ""issuerContractExternalReference":" ""CONTRACT-202212130001""        "
              },
              "        ""customers":" "[
                 "            "{
                    "                ""customerIdentifier":" "{
                       "                    ""customerReference":" ""CUS10000351531",
                       "                    ""issuerCustomerExternalReference":" ""PERSON-202212130001""                "
                    },
                    "                ""addresses":" "[
                       "                    "{
                          "                        ""addressIdentifier":" "{
                             "                            ""addressReference":" ""ADDREF_MAIN_POSTAL_ADDRESS_1000000000392073""                        "
                          },
                          "                        ""addressLabel":" ""MAIN_POSTAL_ADDRESS",
                          "                        ""addressType":" ""POSTAL_MAIL""                    "
                       }"                "
                    ]"            "
                 },
                 "            "{
                    "                ""customerIdentifier":" "{
                       "                    ""customerReference":" ""CUS10000351532",
                       "                    ""issuerCustomerExternalReference":" ""HOME_ADDR_REF_PERSON-202212130001B""                "
                    },
                    "                ""addresses":" "[
                       "                    "{
                          "                        ""addressIdentifier":" "{
                             "                            ""addressReference":" ""ADDREF_MAIN_POSTAL_ADDRESS_1000000000392074""                        "
                          },
                          "                        ""addressLabel":" ""MAIN_POSTAL_ADDRESS",
                          "                        ""addressType":" ""POSTAL_MAIL""                    "
                       }"                "
                    ]"            "
                 }"        "
              ]"    "
           }
        }

Add Card To An Existing Contract

This API allows an issuer to add a new card (debit, credit, prepaid, either physical or virtual), a new account to an existing contract, together or independently, from a product extension among those allowed by the product used to instantiate the contract.

This product extension is usually composed of both card and account products, but can be composed of a card or several cards only, or of one or several accounts only or combination of both cards and accounts. It leads to create a new card and a new card account within the contract (multiple contents of product extensions can be configured depending on issuer's needs).

The new card account is in most of the cases attached to the root account of the hierarchy (default behaviour) but the issuer can provide its parent account if it is not the root (complex account hierarchy with more than 2 account levels).

The issuer shall provide required data for each account and card contract/card if required (depends on product extension configuration).

The issuer can provide:

  • a list of new customers or the references to existing customers in Worldline system
  • the legitimacy document(s) per customer
  • different membership fee and account setup fee (contract fees) if needed per account

The issuer can choose to receive in response for the extended/updated contract new resources created only or all resources (e.g. already existing accounts, card contracts, cards).

In case it is configured that adding additional card and account should trigger a product change, and there is an already scheduled product change, then the product change will be initiated and the new card and account will be created in the new contract.

The API response returns the extended contract with information related to account(s), card contract(s) and card(s) (limited to newly created account(s) and card contract(s)/card(s) if requested).

 

 

Add Cards and Accounts Request

API links

POST /api/v2/issuers/{issuerId}/contracts/{contractReference}/add-cards-accounts

POST /api/v2/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/add-cards-accounts

Below, an example of a request to add a card to:

  • The existing contract: 1e9802ae-68db-467b-8610-ae59f0d37291
  • Issuer: 1234
  • for a new customer (Helen BOUBOU)

With the parameter “newResourcesOnly” set to true, only the created card and account are provided back.

POST /api/v2/issuers/1234/contracts/1e9802ae-68db-467b-8610-ae59f0d37291/add-cards-accounts?newResourcesOnly=true

Request data

{
   "  ""customers":" "[
      "                           "{
         "            ""requestCorrelationId":" ""117",
         "            ""issuerCustomerExternalReference":" ""PERSON-202212130001C",
         "            ""active":" true",
         "            ""courtesyTitle":" ""Frau",
         "            ""lastName":" ""BOUBOU",
         "            ""firstName":" ""Helen",
         "            ""birthDate":" ""1989-12-20T00:00:00.000Z",
         "            ""birthPlace":" ""Lorch",
         "            ""sex":" ""F",
         "            ""nationality":" ""DE",
         "            ""onlineRiskCategory":"Standard",
         "            ""offlineRiskCategory":"Standard",
         "            ""commercialStatus":"Normal",
         "               ""addresses":" "[
            "                "{
               "                    ""issuerAddressExternalReference":" ""HOME_ADDR_REF_PERSON-202212130001C",
               "                    ""addressLabel":" ""MAIN_POSTAL_ADDRESS",
               "                    ""addressType":" ""POSTAL_MAIL",
               "                    ""postalAddress":" "{
                  "                        ""country":" ""DE",
                  "                        ""line1"" ":" ""HUBERTUSANLAGE 25""                    "
               }"                "
            }"   
            "
         ]"        "
      }"  "
   ],
   "  ""issuerProductExtensionExternalReference":" ""PDT_1234_EXT_VISA_DEBIT_CLASSIC",
   "  ""accountHierarchy":" "{
      "    ""accounts":" "[
         "      "{
            "        ""accountTemplateReference":" ""T_1234_ACC_CHILD_VISA_DEBIT_CLASSIC",
            "         ""issuerAccountExternalReference":" ""CHILD_ACCOUNT-202212130001C",
            "        ""iban":" ""DE02500105174128973163",
            "        ""accountOwnerRequestCorrelationId":" ""117""      "
         }"    "
      ]"  "
   },
   "  ""cardContracts":" "[
      "    "{
         "      ""card":" "{
            "        ""cardOrder":" "{
               "             ""sendingMode":" ""Normal""        "
            }"      "
         },
         "      ""cardTemplateReference":" ""T_1234_CARD_VISA_DEBIT_CLASSIC",
         "      ""principalSupplementaryCardIndicator":" ""SUPPLEMENTARY",
         "      ""forcedEmbossingName":" ""BOUBOU""    "
      }"  "
   ]
}

Response data

{
   "    ""responseMetadata":" "{
      "        ""correlationId":" ""d4f2ceeb-7e1e-483d-af01-38e630a8e343",
      "        ""statusMessage":" ""Executed successfully",
      "        ""statusCode": 200,
      "        ""responseDateTime":" ""2022-12-13T17:54:15.838+0100",
      "        ""timeTakenMs": 1174 
    
   },
   "    ""data":" "{
      "        ""contract":" "{
         "            ""contractIdentifier":" "{
            "                ""contractReference":" ""1e9802ae-68db-467b-8610-ae59f0d37291",
            "                ""issuerContractExternalReference":" ""CONTRACT-202212130001""            "
         },
         "            ""status":" ""SIGNED",
         "            ""creationDate":" ""2022-12-13T14:40:21.036+00:00",
         "            ""signatureDate":" ""2022-12-13T14:40:21.000+00:00",
         "            ""issuerBranchCode":" ""NO_BRANCH",
         "            ""cardReleaseOrder":" ""AUTOMATIC",
         "            ""productIdentifier":" "{
            "                ""issuerProductExternalReference":" ""PDT_1234_VISA_DEBIT_CLASSIC",
            "                ""productReference":" ""PDT_1234_VISA_DEBIT_CLASSIC""            "
         },
         "            ""contractOwnerIdentifier":" "{
            "                ""customerReference":" ""CUS10000351531",
            "                ""issuerCustomerExternalReference":" ""PERSON-202212130001""            "
         },
         "            ""accounts":" "[
            "                "{
               "                    ""accountIdentifier":" "{
                  "                        ""accountReference":" ""12341542264159267791",
                  "                        ""issuerAccountExternalReference":" ""CHILD_ACCOUNT-202212130001C""                    "
               },
               "                    ""root":" false",
               "                    ""status":" ""ACTIVE",
               "                    ""accountOwnerIdentifier":" "{
                  "                        ""customerReference":" ""CUS10000351533",
                  "                        ""issuerCustomerExternalReference":" ""PERSON-202212130001C""                    "
               },
               "                    ""accountGuarantorIdentifier":" "{
                  "                        ""customerReference":" ""CUS10000351531",
                  "                        ""issuerCustomerExternalReference":" ""PERSON-202212130001""                    "
               }"                "
            }"            "
         ],
         "            ""cardContracts":" "[
            "                "{
               "                    ""cardContractIdentifier":" "{
                  "                        ""cardContractReference":" ""12342000000000380700""                    "
               },
               "                    ""cardHolderIdentifier":" "{
                  "                        ""customerReference":" ""CUS10000351533",
                  "                        ""issuerCustomerExternalReference":" ""PERSON-202212130001C""                    "
               },
               "                    ""status":" ""ACTIVE",
               "                    ""principalSupplementaryCardIndicator":" ""SUPPLEMENTARY",
               "                    ""card":" "{
                  "                        ""cardIdentifier":" "{
                     "                            ""cardReference":" ""2000000000380701""                        "
                  },
                  "                        ""pan":" ""4546176812235324",
                  "                        ""maskedPan":" ""454617******5324",
                  "                        ""expiryDate":" ""1227",
                  "                        ""panSequenceNumber":" ""1",
                  "                        ""status":" ""ACTIVE",
                  "                        ""orders":" "[
                     "                            "{
                        "                                ""orderIdentifier":" "{
                           "                                    ""orderReference":" ""202212132000000000380702""                                "
                        },
                        "                                ""orderType":" ""CardOrder",
                        "                                ""currentInternalStatus":" ""ORDERABLE""                            "
                     }"                        "
                  ],
                  "                        ""panReference":" ""15007c193f2d588f4b8b991ab24537ebe001""                    "
               },
               "                    ""relatedAccounts":" "[
                  "                        "{
                     "                            ""relation":" ""DEFAULT",
                     "                            ""accountIdentifier":" "{
                        "                                ""accountReference":" ""12341542264159267791",
                        "                                ""issuerAccountExternalReference":" ""CHILD_ACCOUNT-202212130001C""                            "
                     }"                        "
                  }"                    "
               ]"                "
            }"            "
         ]"        "
      },
      "        ""customers":" "[
         "            "{
            "                ""customerIdentifier":" "{
               "                    ""customerReference":" ""CUS10000351533",
               "                    ""issuerCustomerExternalReference":" ""PERSON-202212130001C""                "
            },
            "                ""courtesyTitle":" ""Frau",
            "                ""lastName":" ""BOUBOU",
            "                ""firstName":" ""Helen",
            "                ""addresses":" "[
               "                    "{
                  "                        ""addressIdentifier":" "{
                     "                            ""addressReference":" ""ADDREF_MAIN_POSTAL_ADDRESS_1000000000392075",
                     "                            ""issuerAddressExternalReference":" ""HOME_ADDR_REF_PERSON-202212130001C""                        "
                  },
                  "                        ""addressLabel":" ""MAIN_POSTAL_ADDRESS",
                  "                        ""addressType":" ""POSTAL_MAIL""                    "
               }"                "
            ]"            "
         }"        "
      ]"    "
   }
}

Update Contract

The API allows to update certain data of an existing consumer contract, identified by the Issuer Contract external reference or the Contract reference.

  • allowed advertisement channels (flags)
  • allowed data analysis
  • the issuer branch code (e.g. bank agency in charge of this contract)
  • allowed delivery channel for possible letters
  • if the membership fee should be reimbursed when a card contract is closed
  • how many cards should free of membership fee and/or account setup fee
  • if the primary card should be considered as the first to be free for membership/account setup fees or if only additional cards should be considered
  • if both membership and account setup fees should be waived during contract lifecycle (can be changed at any moment)
  • the membership fee anniversary date can be changed
  • pass-through data can be updated (specificFields)
  • content

As a result, the contract is immediately updated with provided data in our system.

Add Cards and Accounts Request

API links

POST /api/v2/issuers/{issuerId}/contracts/{contractReference}/add-cards-accounts

POST /api/v2/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/add-cards-accounts

Below an example of request where the advertisement flags, the delivery channels for correspondence and the branch code are updated for the:

  • contract reference: 1e9802ae-68db-467b-8610-ae59f0d37291
  • Issuer: 1234

PATCH /api/v2/issuers/1234/contracts/1e9802ae-68db-467b-8610-ae59f0d37291

Request data

{
   "  ""advertisementFlags":" "{
      "    ""general":" true",
      "    ""email":" false",
      "    ""letter":" false",
      "    ""phone":" false",
      "    ""statement":" true",
      "    ""sms":" false 

  "
   },
   "  ""issuerBranchCode":" ""NO_BRANCH",
   "    ""dataAnalysisFlags":" "{
      "    ""person":" false",
      "    ""paymentTransaction":" false",
      "    ""exchangeThirdParties":" false 

  "
   },
   "  ""deliveryChannel":" "{
      "    ""contractLetterType":" ""LETTER",
      "    ""disputeLetterType":" ""LETTER",
      "    ""statementType":" ""WEB""  "
   }
}

Response data

{
   "    ""responseMetadata":" "{
      "        ""correlationId":" ""25eb44b4-7ff7-41fe-a253-0c2b7519f380",
      "        ""statusMessage":" ""Executed successfully",
      "        ""statusCode": 200,
      "        ""responseDateTime":" ""2022-12-14T18:11:53.053+0100",
      "        ""timeTakenMs": 229 

    
   },
   "    ""data":" "{
      "        ""contractIdentifier":" "{
         "            ""contractReference":" ""1e9802ae-68db-467b-8610-ae59f0d37291",
         "            ""issuerContractExternalReference":" ""CONTRACT-202212130001""        "
      }"    "
   }
}

List Accounts For A Contract

The API allows the list of accounts for a contract, identified by the Issuer Contract external reference or the Contract reference, to be retrieved.

API links

GET /api/v2/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/accounts

GET /api/v2/issuers/{issuerId}/contracts/{contractReference}/accounts

Below an example of request for:

  • The contract reference: 1e9802ae-68db-467b-8610-ae59f0d37291
  • The issuer: 1234

The response includes 4 accounts: 1 root account and 3 card accounts.

GET /api/v2/issuers/1234/contracts/1e9802ae-68db-467b-8610-ae59f0d37291/accounts

Response data

{
   "    ""data":" "[
      "        "{
         "            ""issuerId":" ""1234",
         "            ""accountIdentifier":" "{
            "                ""accountReference":" ""12341542264159267791",
            "                ""issuerAccountExternalReference":" ""CHILD_ACCOUNT-202212130001C""            "
         },
         "            ""root":" false",
         "            ""accountBalance":" "{
            "                ""value": 0,
            "                ""exponent": 2,
            "                ""isoCode":" ""EUR""            "
         },
         "            ""status":" ""ACTIVE",
         "            ""statusDate":" ""2022-12-13T16:54:14.000+00:00",
         "            ""exclusiveCurrency":" false",
         "            ""activationDate":" ""2022-12-13T16:54:14.000+00:00",
         "            ""iban":" ""DE02500105174128973163",
         "            ""name":" ""T_1234_ACC_CHILD_VISA_DEBIT_CLASSIC",
         "            ""workingCurrencyCode":" ""EUR",
         "            ""originalWorkingMode":" ""PAY_NOW",
         "            ""workingMode":" ""PAY_NOW",
         "            ""subscriptionSwitch":" false",
         "            ""toBeSwitched":" false",
         "            ""accountHierarchyReference":" ""12343652199237560111",
         "            ""noGraceOnTheFirstCycle":" false",
         "            ""productIdentifier":" "{
            "                ""issuerProductExternalReference":" ""PDT_1234_VISA_DEBIT_CLASSIC",
            "                ""productReference":" ""PDT_1234_VISA_DEBIT_CLASSIC""            "
         },
         "            ""accountProfileReference":" ""P_1234_ACC_CHILD",
         "            ""closureCalendar":" ""C_1234_CLOSURE_DEFAULT",
         "            ""overlimitContribution":" ""0.0",
         "            ""spareChangeSaving":" false",
         "            ""rootAccountIdentifier":" "{
            "                ""accountReference":" ""12343652199237560111",
            "                ""issuerAccountExternalReference":" ""ROOT_ACCOUNT-202212130001""            "
         },
         "            ""parentAccountIdentifier":" "{
            "                ""accountReference":" ""12343652199237560111",
            "                ""issuerAccountExternalReference":" ""ROOT_ACCOUNT-202212130001""            "
         },
         "            ""payingAccountIdentifier":" "{
            "                ""accountReference":" ""12341542264159267791",
            "                ""issuerAccountExternalReference":" ""CHILD_ACCOUNT-202212130001C""            "
         },
         "            ""accountOwnerIdentifier":" "{
            "                ""customerReference":" ""CUS10000351533",
            "                ""issuerCustomerExternalReference":" ""PERSON-202212130001C""            "
         },
         "            ""accountGuarantorIdentifier":" "{
            "                ""customerReference":" ""CUS10000351533",
            "                ""issuerCustomerExternalReference":" ""PERSON-202212130001C""            "
         },
         "            ""contractIdentifier":" "{
            "                ""contractReference":" ""1e9802ae-68db-467b-8610-ae59f0d37291",
            "                ""issuerContractExternalReference":" ""CONTRACT-202212130001""            "
         },
         "            ""delinquent":" false",
         "            ""noOtbCheck":" false",
         "            ""noParentNotification":" false",
         "            ""contractType":" ""CONSUMER",
         "            ""hierarchyOutgoingCreditTransferFeature":" "{
            "                ""periodicOct":" false",
            "                ""octOnContractTerminationAllowed":" false",
            "                ""octOnAccountTerminationAllowed":" false",
            "                ""octOnDemandAllowed":" false 
            "
         }"        "
      },
      "        "{
         "            ""issuerId":" ""1234",
         "            ""accountIdentifier":" "{
            "                ""accountReference":" ""12343652199237560111",
            "                ""issuerAccountExternalReference":" ""ROOT_ACCOUNT-202212130001""            "
         },
         "            ""root":" true",
         "            ""accountBalance":" "{
            "                ""value": 0,
            "                ""exponent": 2,
            "                ""isoCode":" ""EUR""            "
         },
         "            ""bic":" ""INGDEBB",
         "            ""status":" ""ACTIVE",
         "            ""statusDate":" ""2022-12-13T14:40:21.000+00:00",
         "            ""exclusiveCurrency":" false",
         "            ""activationDate":" ""2022-12-13T14:40:21.000+00:00",
         "            ""iban":" ""DE02500105174128973163",
         "            ""name":" ""T_1234_ACC_ROOT_VISA_DEBIT_CLASSIC",
         "            ""workingCurrencyCode":" ""EUR",
         "            ""originalWorkingMode":" ""PAY_NOW",
         "            ""workingMode":" ""PAY_NOW",
         "            ""subscriptionSwitch":" false",
         "            ""toBeSwitched":" false",
         "            ""accountHierarchyReference":" ""12343652199237560111",
         "            ""originalPaymentMode":" ""CARDHOLDER_DETERMINED",
         "            ""noGraceOnTheFirstCycle":" false",
         "            ""amountDueCalculationLevel":" ""COMPONENT_LEVEL",
         "            ""productIdentifier":" "{
            "                ""issuerProductExternalReference":" ""PDT_1234_VISA_DEBIT_CLASSIC",
            "                ""productReference":" ""PDT_1234_VISA_DEBIT_CLASSIC""            "
         },
         "            ""accountProfileReference":" ""P_1234_ACC_ROOT",
         "            ""accountTemplateReference":" ""T_1234_ACC_ROOT_VISA_DEBIT_CLASSIC",
         "            ""closureCalendar":" ""C_1234_CLOSURE_DEFAULT",
         "            ""overlimitContribution":" ""0.0",
         "            ""spareChangeSaving":" false",
         "            ""rootAccountIdentifier":" "{
            "                ""accountReference":" ""12343652199237560111",
            "                ""issuerAccountExternalReference":" ""ROOT_ACCOUNT-202212130001""            "
         },
         "            ""payingAccountIdentifier":" "{
            "                ""accountReference":" ""12343652199237560111",
            "                ""issuerAccountExternalReference":" ""ROOT_ACCOUNT-202212130001""            "
         },
         "            ""accountOwnerIdentifier":" "{
            "                ""customerReference":" ""CUS10000351533",
            "                ""issuerCustomerExternalReference":" ""PERSON-202212130001C""            "
         },
         "            ""accountGuarantorIdentifier":" "{
            "                ""customerReference":" ""CUS10000351533",
            "                ""issuerCustomerExternalReference":" ""PERSON-202212130001C""            "
         },
         "            ""contractIdentifier":" "{
            "                ""contractReference":" ""1e9802ae-68db-467b-8610-ae59f0d37291",
            "                ""issuerContractExternalReference":" ""CONTRACT-202212130001""            "
         },
         "            ""delinquent":" false",
         "            ""noOtbCheck":" false",
         "            ""noParentNotification":" false",
         "            ""contractType":" ""CONSUMER",
         "            ""hierarchyOutgoingCreditTransferFeature":" "{
            "                ""periodicOct":" false",
            "                ""octOnContractTerminationAllowed":" false",
            "                ""octOnAccountTerminationAllowed":" false",
            "                ""octOnDemandAllowed":" false 
           "
         }"         "
      },
      "        "{
         "            ""issuerId":" ""1234",
         "            ""accountIdentifier":" "{
            "                ""accountReference":" ""12344689712869894759",
            "                ""issuerAccountExternalReference":" ""CHILD_ACCOUNT-202212130001B""            "
         },
         "            ""root":" false",
         "            ""accountBalance":" "{
            "                ""value": 0,
            "                ""exponent": 2,
            "                ""isoCode":" ""EUR""            "
         },
         "            ""status":" ""ACTIVE",
         "            ""statusDate":" ""2022-12-13T15:25:57.000+00:00",
         "            ""exclusiveCurrency":" false",
         "            ""activationDate":" ""2022-12-13T15:25:57.000+00:00",
         "            ""iban":" ""DE02500105174128973163",
         "            ""name":" ""T_1234_ACC_CHILD_VISA_DEBIT_CLASSIC",
         "            ""workingCurrencyCode":" ""EUR",
         "            ""originalWorkingMode":" ""PAY_NOW",
         "            ""workingMode":" ""PAY_NOW",
         "            ""subscriptionSwitch":" false",
         "            ""toBeSwitched":" false",
         "            ""accountHierarchyReference":" ""12343652199237560111",
         "            ""noGraceOnTheFirstCycle":" false",
         "            ""productIdentifier":" "{
            "                ""issuerProductExternalReference":" ""PDT_1234_VISA_DEBIT_CLASSIC",
            "                ""productReference":" ""PDT_1234_VISA_DEBIT_CLASSIC""            "
         },
         "            ""accountProfileReference":" ""P_1234_ACC_CHILD",
         "            ""closureCalendar":" ""C_1234_CLOSURE_DEFAULT",
         "            ""overlimitContribution":" ""0.0",
         "            ""spareChangeSaving":" false",
         "            ""rootAccountIdentifier":" "{
            "                ""accountReference":" ""12343652199237560111",
            "                ""issuerAccountExternalReference":" ""ROOT_ACCOUNT-202212130001""            "
         },
         "            ""parentAccountIdentifier":" "{
            "                ""accountReference":" ""12343652199237560111",
            "                ""issuerAccountExternalReference":" ""ROOT_ACCOUNT-202212130001""            "
         },
         "            ""payingAccountIdentifier":" "{
            "                ""accountReference":" ""12344689712869894759",
            "                ""issuerAccountExternalReference":" ""CHILD_ACCOUNT-202212130001B""            "
         },
         "            ""accountOwnerIdentifier":" "{
            "                ""customerReference":" ""CUS10000351532",
            "                ""issuerCustomerExternalReference":" ""HOME_ADDR_REF_PERSON-202212130001B""            "
         },
         "            ""accountGuarantorIdentifier":" "{
            "                ""customerReference":" ""CUS10000351533",
            "                ""issuerCustomerExternalReference":" ""PERSON-202212130001C""            "
         },
         "            ""contractIdentifier":" "{
            "                ""contractReference":" ""1e9802ae-68db-467b-8610-ae59f0d37291",
            "                ""issuerContractExternalReference":" ""CONTRACT-202212130001""            "
         },
         "            ""delinquent":" false",
         "            ""noOtbCheck":" false",
         "            ""noParentNotification":" false",
         "            ""contractType":" ""CONSUMER",
         "            ""hierarchyOutgoingCreditTransferFeature":" "{
            "                ""periodicOct":" false",
            "                ""octOnContractTerminationAllowed":" false",
            "                ""octOnAccountTerminationAllowed":" false",
            "                ""octOnDemandAllowed":" false 
            "
         }"        "
      },
      "        "{
         "            ""issuerId":" ""1234",
         "            ""accountIdentifier":" "{
            "                ""accountReference":" ""12343686269046574979",
            "                ""issuerAccountExternalReference":" ""CHILD_ACCOUNT-202212130001""            "
         },
         "            ""root":" false",
         "            ""accountBalance":" "{
            "                ""value": 0,
            "                ""exponent": 2,
            "                ""isoCode":" ""EUR""            "
         },
         "            ""bic":" ""INGDEBB",
         "            ""status":" ""ACTIVE",
         "            ""statusDate":" ""2022-12-13T14:40:21.000+00:00",
         "            ""exclusiveCurrency":" false",
         "            ""activationDate":" ""2022-12-13T14:40:21.000+00:00",
         "            ""iban":" ""DE02500105174128973163",
         "            ""name":" ""T_1234_ACC_CHILD_VISA_DEBIT_CLASSIC",
         "            ""workingCurrencyCode":" ""EUR",
         "            ""originalWorkingMode":" ""PAY_NOW",
         "            ""workingMode":" ""PAY_NOW",
         "            ""subscriptionSwitch":" false",
         "            ""toBeSwitched":" false",
         "            ""accountHierarchyReference":" ""12343652199237560111",
         "            ""originalPaymentMode":" ""CARDHOLDER_DETERMINED",
         "            ""noGraceOnTheFirstCycle":" false",
         "            ""amountDueCalculationLevel":" ""COMPONENT_LEVEL",
         "            ""productIdentifier":" "{
            "                ""issuerProductExternalReference":" ""PDT_1234_VISA_DEBIT_CLASSIC",
            "                ""productReference":" ""PDT_1234_VISA_DEBIT_CLASSIC""            "
         },
         "            ""accountProfileReference":" ""P_1234_ACC_CHILD",
         "            ""accountTemplateReference":" ""T_1234_ACC_CHILD_VISA_DEBIT_CLASSIC",
         "            ""closureCalendar":" ""C_1234_CLOSURE_DEFAULT",
         "            ""overlimitContribution":" ""0.0",
         "            ""spareChangeSaving":" false",
         "            ""rootAccountIdentifier":" "{
            "                ""accountReference":" ""12343652199237560111",
            "                ""issuerAccountExternalReference":" ""ROOT_ACCOUNT-202212130001""            "
         },
         "            ""parentAccountIdentifier":" "{
            "                ""accountReference":" ""12343652199237560111",
            "                ""issuerAccountExternalReference":" ""ROOT_ACCOUNT-202212130001""            "
         },
         "            ""payingAccountIdentifier":" "{
            "                ""accountReference":" ""12343686269046574979",
            "                ""issuerAccountExternalReference":" ""CHILD_ACCOUNT-202212130001""            "
         },
         "            ""accountOwnerIdentifier":" "{
            "                ""customerReference":" ""CUS10000351531",
            "                ""issuerCustomerExternalReference":" ""PERSON-202212130001""            "
         },
         "            ""accountGuarantorIdentifier":" "{
            "                ""customerReference":" ""CUS10000351533",
            "                ""issuerCustomerExternalReference":" ""PERSON-202212130001C""            "
         },
         "            ""contractIdentifier":" "{
            "                ""contractReference":" ""1e9802ae-68db-467b-8610-ae59f0d37291",
            "               ""issuerContractExternalReference":" ""CONTRACT-202212130001""            "
         },
         "            ""delinquent":" false",
         "            ""noOtbCheck":" false",
         "            ""noParentNotification":" false",
         "            ""contractType":" ""CONSUMER",
         "            ""hierarchyOutgoingCreditTransferFeature":" "{
            "                ""periodicOct":" false",
            "                ""octOnContractTerminationAllowed":" false",
            "                ""octOnAccountTerminationAllowed":" false",
            "                ""octOnDemandAllowed":" false 
            "
         }"        "
      }"    "
   ]
}

List Card Contracts For A Contract

The API allows the list of card contract linked to a contract, identified by the Issuer Contract external reference or the Contract reference, to be retrieved.

API links

GET /api/v2/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/card-contracts

GET /api/v2/issuers/{issuerId}/contracts/{contractReference}/card-contracts

Below an example of request for:

  • The contract reference: 1e9802ae-68db-467b-8610-ae59f0d37291
  • The issuer: 1234

The response gives 3 card contracts.

GET /api/v2/issuers/1234/contracts/1e9802ae-68db-467b-8610-ae59f0d37291/card-contracts

Response data

{
           "data":" "[
              "        "{
                 "            ""issuerId":" ""1234",
                 "            ""cardContractIdentifier":" "{
                    "                ""cardContractReference":" ""12342000000000380697""            "
                 },
                 "            ""cardTemplateReference":" ""T_1234_CARD_VISA_DEBIT_CLASSIC",
                 "            ""cardTypeCode":" ""F",
                 "            ""status":" ""ACTIVE",
                 "            ""openingDate":" ""2022-12-13T15:25:57.710+00:00",
                 "            ""activationDate":" ""2022-12-13T15:25:57.730+00:00",
                 "            ""trustedAuthenticationReference":" ""123420221213162557294",
                 "            ""newCardRenewalAllowed":" true",
                 "            ""issuerBranchCode":" ""NO_BRANCH",
                 "            ""artwork":" ""DebitClassic",
                 "            ""forcedEmbossingName":" ""BOUBOU",
                 "            ""schemeDeclarationOptOut":" false",
                 "            ""principalSupplementaryCardIndicator":" ""SUPPLEMENTARY",
                 "            ""productCategory":" ""DEBIT",
                 "            ""productCategoryLabel":" ""IMMEDIATE_DEBIT_DEBIT",
                 "            ""productIdentifier":" "{
                    "                ""issuerProductExternalReference":" ""PDT_1234_VISA_DEBIT_CLASSIC",
                    "                ""productReference":" ""PDT_1234_VISA_DEBIT_CLASSIC""            "
                 },
                 "            ""cardHolderIdentifier":" "{
                    "                ""customerReference":" ""CUS10000351532",
                    "                ""issuerCustomerExternalReference":" ""HOME_ADDR_REF_PERSON-202212130001B""            "
                 },
                 "            ""vipFlag":" false",
                 "            ""contractIdentifier":" "{
                    "                ""contractReference":" ""1e9802ae-68db-467b-8610-ae59f0d37291",
                    "                ""issuerContractExternalReference":" ""CONTRACT-202212130001""            "
                 },
                 "            ""cardProfileDescription":" ""P_1234_CARD_VISA_DEBIT_CLASSIC",
                 "            ""cardProfileReference":" ""P_1234_CARD_VISA_DEBIT_CLASSIC""        "
              },
              "        "{
                 "            ""issuerId":" ""1234",
                 "            ""cardContractIdentifier":" "{
                    "                ""cardContractReference":" ""12342000000000380694",
                    "                ""issuerCardContractExternalReference":" ""CARD_CONTRACT-202212130001""            "
                 },
                 "            ""cardTemplateReference":" ""T_1234_CARD_VISA_DEBIT_CLASSIC",
                 "            ""cardTypeCode":" ""F",
                 "            ""status":" ""ACTIVE",
                 "            ""openingDate":" ""2022-12-13T14:40:21.527+00:00",
                 "            ""activationDate":" ""2022-12-13T14:40:21.527+00:00",
                 "            ""trustedAuthenticationReference":" ""123420221213154021607",
                 "            ""newCardRenewalAllowed":" true",
                 "            ""issuerBranchCode":" ""NO_BRANCH",
                 "            ""artwork":" ""DebitClassic",
                 "            ""forcedEmbossingName":" ""BOUBOU*TEST BOUBOU EMBOSS2",
                 "            ""schemeDeclarationOptOut":" false",
                 "            ""principalSupplementaryCardIndicator":" ""SUPPLEMENTARY",
                 "            ""productCategory":" ""DEBIT",
                 "            ""productCategoryLabel":" ""IMMEDIATE_DEBIT_DEBIT",
                 "            ""productIdentifier":" "{
                    "                ""issuerProductExternalReference":" ""PDT_1234_VISA_DEBIT_CLASSIC",
                    "                ""productReference":" ""PDT_1234_VISA_DEBIT_CLASSIC""            "
                 },
                 "            ""cardHolderIdentifier":" "{
                    "                ""customerReference":" ""CUS10000351531",
                    "                ""issuerCustomerExternalReference":" ""PERSON-202212130001""            "
                 },
                 "            ""contractIdentifier":" "{
                    "                ""contractReference":" ""1e9802ae-68db-467b-8610-ae59f0d37291",
                    "                ""issuerContractExternalReference":" ""CONTRACT-202212130001""            "
                 },
                 "            ""cardProfileDescription":" ""P_1234_CARD_VISA_DEBIT_CLASSIC",
                 "            ""cardProfileReference":" ""P_1234_CARD_VISA_DEBIT_CLASSIC""        "
              },
              "        "{
                 "            ""issuerId":" ""1234",
                 "            ""cardContractIdentifier":" "{
                    "                ""cardContractReference":" ""12342000000000380700""            "
                 },
                 "            ""cardTemplateReference":" ""T_1234_CARD_VISA_DEBIT_CLASSIC",
                 "            ""cardTypeCode":" ""F",
                 "            ""status":" ""ACTIVE",
                 "            ""openingDate":" ""2022-12-13T16:54:15.002+00:00",
                 "            ""activationDate":" ""2022-12-13T16:54:15.112+00:00",
                 "            ""trustedAuthenticationReference":" ""123420221213175415246",
                 "            ""newCardRenewalAllowed":" true",
                 "            ""issuerBranchCode":" ""NO_BRANCH",
                 "            ""artwork":" ""DebitClassic",
                 "            ""forcedEmbossingName":" ""BOUBOU",
                 "            ""schemeDeclarationOptOut":" false",
                 "            ""principalSupplementaryCardIndicator":" ""PRINCIPAL",
                 "            ""productCategory":" ""DEBIT",
                 "            ""productCategoryLabel":" ""IMMEDIATE_DEBIT_DEBIT",
                 "            ""productIdentifier":" "{
                    "                ""issuerProductExternalReference":" ""PDT_1234_VISA_DEBIT_CLASSIC",
                    "                ""productReference":" ""PDT_1234_VISA_DEBIT_CLASSIC""            "
                 },
                 "            ""cardHolderIdentifier":" "{
                    "                ""customerReference":" ""CUS10000351533",
                    "                ""issuerCustomerExternalReference":" ""PERSON-202212130001C""            "
                 },
                 "            ""contractIdentifier":" "{
                    "                ""contractReference":" ""1e9802ae-68db-467b-8610-ae59f0d37291",
                    "                ""issuerContractExternalReference":" ""CONTRACT-202212130001""            "
                 },
                 "            ""cardProfileDescription":" ""P_1234_CARD_VISA_DEBIT_CLASSIC",
                 "            ""cardProfileReference":" ""P_1234_CARD_VISA_DEBIT_CLASSIC""        "
              }"    "
           ]
        }

Suspend A Contract

The API allows a contract, identified by the Issuer Contract external reference or the Contract reference, to be suspended.

It is possible to indicate whether membership/account setup fees must be partially reimbursed with the contract suspension.

The contract suspension has the following effects:

  • The contract closure is scheduled according to a delay configurable at issuer level
  • Immediate temporary card blocking
  • Renewal and replacement of all cards blocking
  • Account Setup Fee and Membership Fee are suppressed.
  • An Outgoing Credit Transfer (OCT) is automatically generated if the account has a credit balance.

API links

POST /api/v2/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/suspend

POST /api/v2/issuers/{issuerId}/contracts/{contractReference}/suspend

Cancel A Contract Suspension

As long as the closure date is not reached, contract suspension can be removed.

The contract suspension cancellation has the following effects:

  • The scheduled contract closure date is removed
  • Renewal is unblocked
  • Replacement is unblocked
  • Cards linked to the contract are unblocked

The API allows a contract suspension process to be cancelled.

The contract is identified by the Issuer Contract external reference or the Contract reference.

API links

POST /api/v2/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/cancel-suspend

POST /api/v2/issuers/{issuerId}/contracts/{contractReference}/cancel-suspend

Close Contract

The API allows a contract, identified by the Issuer Contract external reference or the Contract reference, to be closed.

The contract can be closed immediately, scheduled to be closed at a date provided by the issuer or set to be closed at the card expiry date.

The contract must not be closed or awaiting signature.

As a result:

  • For immediate closure: the contract is closed, the cards within the contract are deactivated (next authorizations are declined), the closure is triggered for the accounts.
  • For scheduled closure: the contract is not changed until the closing date is reached. Once the closing date is reached, the contract is closed, the cards within the contract are deactivated, the closure is triggered for the accounts.

API links

POST /api/V2/issuers/{issuerId}/contracts/{contractReference}/close

POST /api/V2/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/close

Below an example of request with a scheduled closure date:

  • contract reference: 4459f986-5242-4202-9ed5-f652573e9f63
  • issuer: 1234

POST api/v2/issuers/1234/contracts/4459f986-5242-4202-9ed5-f652573e9f63/close

Request data

{
                           "  ""closingComment":" ""closingContract",
                           "  ""closingDate":" ""2023-04-30T02:31:44.650Z",
                           "  ""closingReason":" ""EXPIRED",
                           "  ""closureDelayType":" ""SCHEDULED"
                        }

Response data

{
                           "    ""responseMetadata":" "{
                              "        ""correlationId":" ""65aa7f43-b3d2-4160-927e-95801efad125",
                              "        ""statusMessage":" ""Executed successfully",
                              "        ""statusCode": 200,
                              "        ""responseDateTime":" ""2023-02-02T15:52:38.281+0100",
                              "        ""timeTakenMs": 450 
                            
                           },
                           "    ""data":" "{
                              "        ""contract":" "{
                                 "            ""contractIdentifier":" "{
                                    "                ""contractReference":" ""4459f986-5242-4202-9ed5-f652573e9f63",
                                    "                ""issuerContractExternalReference":" ""CONTRACT-202212050001""            "
                                 },
                                 "            ""status":" ""SIGNED",
                                 "            ""closingDate":" ""2023-04-30T02:31:44.650+00:00",
                                 "            ""accounts":" "[
                                    "                "{
                                       "                    ""accountIdentifier":" "{
                                          "                        ""accountReference":" ""65008505533653587133",
                                          "                        ""issuerAccountExternalReference":" ""CHILD_ACCOUNT-202212050001""                    "
                                       },
                                       "                    ""root":" false",
                                       "                    ""status":" ""ACTIVE""                "
                                    },
                                    "                "{
                                       "                    ""accountIdentifier":" "{
                                          "                        ""accountReference":" ""65006621070985963583",
                                          "                        ""issuerAccountExternalReference":" ""ROOT_ACCOUNT-202212050001""                    "
                                       },
                                       "                    ""root":" true",
                                       "                    ""status":" ""ACTIVE""                "
                                    },
                                    "                "{
                                       "                    ""accountIdentifier":" "{
                                          "                        ""accountReference":" ""65009389899134164294",
                                          "                        ""issuerAccountExternalReference":" ""CHILD_ACCOUNT-202212050001B""                    "
                                       },
                                       "                    ""root":" false",
                                       "                    ""status":" ""ACTIVE""                "
                                    }"            "
                                 ],
                                 "            ""cardContracts":" "[
                                    "                "{
                                       "                    ""cardContractIdentifier":" "{
                                          "                        ""cardContractReference":" ""65002000000000374459""                    "
                                       },
                                       "                    ""status":" ""ACTIVE",
                                       "                    ""cards":" "[
                                          "                        "{
                                             "                            ""cardIdentifier":" "{
                                                "                                ""cardReference":" ""2000000000374460""                            "
                                             },
                                             "                            ""maskedPan":" ""454617******2386",
                                             "                            ""expiryDate":" ""1227",
                                             "                            ""panSequenceNumber":" ""1",
                                             "                            ""status":" ""BLOCKED""                        "
                                          }"                    "
                                       ]"                "
                                    },
                                    "                "{
                                       "                    ""cardContractIdentifier":" "{
                                          "                        ""cardContractReference":" ""65002000000000374437""                    "
                                       },
                                       "                    ""status":" ""ACTIVE",
                                       "                    ""cards":" "[
                                          "                        "{
                                             "                            ""cardIdentifier":" "{
                                                "                                ""cardReference":" ""2000000000374438",
                                                "                                ""issuerCardExternalReference":" ""CARD-202212050001""                            "
                                             },
                                             "                            ""maskedPan":" ""454617******6413",
                                             "                            ""expiryDate":" ""1227",
                                             "                            ""panSequenceNumber":" ""1",
                                             "                            ""status":" ""ACTIVE""                        "
                                          }"                    "
                                       ]"                "
                                    }"            "
                                 ]"        "
                              }"    "
                           }
                        }

Cancel A Contract Closing

This API enables to cancel a contract closing with a scheduled date in the future.

The main input fields are:

  • The issuer ID
  • The issuer contract external reference or the contract reference

As a result, no closing date is planned anymore for the contract.

API links

POST /api/v2/issuers/{issuerId}/contracts/{contractReference}/cancel-close

POST /api/v2/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/cancel-close

Below an example of request with a scheduled closure date:

  • contract reference: 4459f986-5242-4202-9ed5-f652573e9f63
  • issuer: 1234

POST /api/v2/issuers/1234/contracts/4459f986-5242-4202-9ed5-f652573e9f63/cancel-close

Response data

{
           "    ""responseMetadata":" "{
              "        ""correlationId":" ""3e657247-7ff1-4a1c-b590-6180fb10f353",
              "        ""statusMessage":" ""Executed successfully",
              "        ""statusCode": 200,
              "        ""responseDateTime":" ""2023-02-02T16:35:32.795+0100",
              "        ""timeTakenMs": 81 
            
           },
           "    ""data":" "{
              "        ""contractIdentifier":" "{
                 "            ""contractReference":" ""4459f986-5242-4202-9ed5-f652573e9f63",
                 "            ""issuerContractExternalReference":" ""CONTRACT-202212050001""        "
              }"    "
           }
        }

List Contract Fees For A Contract

The API allows the list of contract fees linked to a contract, identified by the Issuer Contract external reference or the Contract reference, to be retrieved.

In response, the model references are provided for each account part of the contract.

API links

GET /api/v2/issuers/{issuerId}/contracts/{contractReference}/contract-fees

GET /api/v2/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/contract-fees

Here, an example of request for:

  • The contract reference: 1f798c05-f18b-4e6d-9ce3-017d6de43b92
  • The issuer: 1234

The response gives membership fee model applied to the card account “12349288360035054578”.

GET /api/v2/issuers/1234/contracts/1f798c05-f18b-4e6d-9ce3-017d6de43b92/contract-fees

Response data

{
   "    ""data":" "[
      "        "{
         "            ""accountIdentifier":" "{
            "                ""accountReference":" ""12344084403017969976",
            "                ""issuerAccountExternalReference":" ""ROOT_ACCOUNT-202212160001""            "
         }"        "
      },
      "        "{
         "            ""accountIdentifier":" "{
            "                ""accountReference":" ""12349288360035054578",
            "                ""issuerAccountExternalReference":" ""CHILD_ACCOUNT-202212160001""            "
         },
         "            ""selectedModels":" "[
            "                "{
               "                    ""reference":" ""M_1234_ACCSETUPFEE_GOLD_41",
               "                    ""type":" ""ACCOUNT_SETUP_FEE""                "
            },
            "                "{
               "                    ""reference":" ""M_1234_MEMBERSHIPFEE_GOLD_41",
               "                    ""type":" ""MEMBERSHIP_FEE""                "
            }"            "
         ]"        "
      }"    "
   ]
}

Update Contract Fees For A Given Contract And Card Account

This API enables the contract fees (Membership fee and account set-up fee) to be updated for a given contract and given card account in the contract.

This is done by providing in input the new model reference and the type to be used.

This model has to be configured previously for the product.

API links

PATCH /api/v2/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/contract-fees/{accountReference}

PATCH /api/v2/issuers/{issuerId}/contracts/{contractReference}/contract-fees/{accountReference}

PATCH /api/v2/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/contract-fees/external-accounts/{issuerAccountExternalReference}

PATCH /api/v2/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/contract-fees/external-accounts/{issuerAccountExternalReference}

Here, an example of request for:

  • The contract reference: 1f798c05-f18b-4e6d-9ce3-017d6de43b92
  • The issuer: 1234
  • The account 12349288360035054578

The response updates the membership fee model applied to the card account “12349288360035054578”.

PATCH /api/v2/issuers/1234/contracts/1f798c05-f18b-4e6d-9ce3-017d6de43b92/contract-fees/12349288360035054578

Request data

{
   "  ""selectedModels":" "[
      "    "{
         "      ""reference":" ""M_1234_MEMBERSHIPFEE_GOLD_21",
         "      ""type":" ""MEMBERSHIP_FEE""    "
      }"  "
   ]
}

Response data

{
   "    ""responseMetadata":" "{
      "        ""correlationId":" ""29a7a912-b795-4cc1-a831-7d872128015a",
      "        ""statusMessage":" ""Executed successfully",
      "        ""statusCode": 200,
      "        ""responseDateTime":" ""2022-12-16T17:28:18.502+0100",
      "        ""timeTakenMs": 317 
    
   },
   "    ""data":" "{
      "        ""accountIdentifier":" "{
         "            ""accountReference":" ""12349288360035054578",
         "            ""issuerAccountExternalReference":" ""CHILD_ACCOUNT-202212160001""        "
      }"    "
   }
}

Retrieve Contract Owner A Contract

This API allows the contract owner for a contract identified by the Issuer Contract external reference or the Contract reference, to be retrieved.

API links

GET /api/v2/issuers/{issuerId}/contracts/{contractReference}/contract-owner

Here, an example of request for:

  • The contract reference: 1e9802ae-68db-467b-8610-ae59f0d37291
  • The issuer: 1234

GET /api/v2/issuers/1234/contracts/1e9802ae-68db-467b-8610-ae59f0d37291/contract-owner

Response data

{
   "    ""data":" "{
      "        ""issuerId":" ""1234",
      "        ""customerIdentifier":" "{
         "            ""customerReference":" ""CUS10000351533",
         "            ""issuerCustomerExternalReference":" ""PERSON-202212130001C""        "
      },
      "        ""active":" true",
      "        ""birthDate":" ""1989-12-20T00:00:00.000+00:00",
      "        ""birthPlace":" ""Lorch",
      "        ""commercialStatus":" ""Normal",
      "        ""courtesyTitle":" ""Frau",
      "        ""firstName":" ""Helen",
      "        ""lastName":" ""BOUBOU",
      "        ""monthlySalary":" ""0",
      "        ""nationality":" ""DE",
      "        ""offlineRiskCategory":" ""Standard",
      "        ""onlineRiskCategory":" ""Standard",
      "        ""sex":" ""F""    "
   }
}

Switch Between Principal And Supplementary Cards

The API is used to change the contract owner of the main card by a cardholder of an additional card belonging to the same contract.

The API requires in input:

  • the Issuer ID
  • the contract reference
  • the cardholder reference (future contract owner and future cardholder of the main card)
  • the card contract reference (optional - in case the cardholder has several card contracts in different contracts)

In return, the list of all changes is provided at contract level and card contracts level (old main card and new main card).

API links

POST /api/V2/issuers/{issuerId}/contracts/{contractReference}/switch-principal-card

POST /api/V2/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/switch-principal-card

Below an example of the switch request for

  • Contract reference: 1e9802ae-68db-467b-8610-ae59f0d37291
  • Customer reference: CUS10000351533

POST /api/v2/issuers/1234/contracts/1e9802ae-68db-467b-8610-ae59f0d37291/switch-principal-card

Request data

{ 
        "cardHolderIdentifier": { 
            "customerReference": "CUS10000351533" 
          } 
        }

Response data

{
           " ""responseMetadata":" "{
              "        ""correlationId":" ""adae8262-0114-4221-8bd4-305be87e2f89",
              "        ""statusMessage":" ""Executed successfully",
              "        ""statusCode": 200,
              "        ""responseDateTime":" ""2022-12-14T12:49:33.884+0100",
              "        ""timeTakenMs": 1138 
            
           },
           "    ""data":" "{
              "        ""contract":" "{
                 "            ""contractIdentifier":" "{
                    "                ""contractReference":" ""1e9802ae-68db-467b-8610-ae59f0d37291",
                    "                ""issuerContractExternalReference":" ""CONTRACT-202212130001""            "
                 },
                 "            ""contractOwnerIdentifier":" "{
                    "                ""customerReference":" ""CUS10000351533",
                    "                ""issuerCustomerExternalReference":" ""PERSON-202212130001C""            "
                 },
                 "            ""cardContracts":" "[
                    "                "{
                       "                    ""cardContractIdentifier":" "{
                          "                        ""cardContractReference":" ""12342000000000380700""                    "
                       },
                       "                    ""principalSupplementaryCardIndicator":" ""PRINCIPAL""                "
                    },
                    "                "{
                       "                    ""cardContractIdentifier":" "{
                          "                        ""cardContractReference":" ""12342000000000380694",
                          "                        ""issuerCardContractExternalReference":" ""CARD_CONTRACT-202212130001""                    "
                       },
                       "                    ""principalSupplementaryCardIndicator":" ""SUPPLEMENTARY""                "
                    }"            "
                 ]"        "
              }"    "
           }
        }

List Legitimacy Documents For A Contract

Legitimacy documents correspond to documents that prove the identity of a customer (pass ID, national card ID)

The document type, The document ID, the expiry date of the document, its issuing date can be stored in our system.

This API is used to get the customers legitimacy documents of a contract.

The input parameters are:

  • the contract reference for which information is requested: It can be provided by using the contract reference or the issuer external contract reference.

API links

GET /api/v2/issuers/{issuerId}/contracts/{contractReference}/legitimacy-documents

GET /api/v2/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/legitimacy-documents

Below an example of request for:

  • The contract reference: 1e9802ae-68db-467b-8610-ae59f0d37291

For this contract, there are 2 customers. The response gives the legitimacy documents for each of them.

GET /api/v2/issuers/1234/contracts/1e9802ae-68db-467b-8610-ae59f0d37291/legitimacy-documents

Response data

{
   {
      "    ""data":" "[
         "        "{
            "            ""legitimacyDocumentType":" ""Passport",
            "            ""legitimacyDocumentId":" ""7845128",
            "            ""legitimacyDocumentDate":" ""2020-07-25T00:00:00.000+00:00",
            "            ""legitimacyDocumentExpiryDate":" ""2020-07-25T00:00:00.000+00:00",
            "            ""legitimated":" true",
            "            ""customerIdentifier":" "{
               "                ""customerReference":" ""CUS10000351532",
               "                ""issuerCustomerExternalReference":" ""PERSON-202212130001B""            "
            }"        "
         },
         "        "{
            "            ""legitimacyDocumentType":" ""Passport",
            "            ""legitimacyDocumentId":" ""9512345",
            "            ""legitimacyDocumentDate":" ""2016-10-13T00:00:00.000+00:00",
            "            ""legitimacyDocumentExpiryDate":" ""2026-10-13T00:00:00.000+00:00",
            "            ""legitimated":" true",
            "            ""customerIdentifier":" "{
               "                ""customerReference":" ""CUS10000351531",
               "                ""issuerCustomerExternalReference":" ""PERSON-202212130001""            "
            }"        "
         }"    "
      ]
   }
  • The contract reference: 1e9802ae-68db-467b-8610-ae59f0d37291

Update Legitimacy Document Of A Contract Customer

This API is used to update the customers legitimacy documents of a contract.

The input parameters are:

  • the contract and the customer identifier for which information must be updated.

They can be provided by using the internal references or the issuer external references:

  • contract reference and customer reference or
  • issuer contract external reference and issuer customer external reference

API links

POST /api/v2/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/legitimacy-documents/external-customers/{issuerCustomerExternalReference}

POST /api/v2/issuers/{issuerId}/contracts/{contractReference}/legitimacy-documents/{customerReference}

Below an example of request for:

  • the contract reference: 1e9802ae-68db-467b-8610-ae59f0d37291
  • the customer reference: CUS10000351531

POST /api/v2/issuers/1234/contracts/1e9802ae-68db-467b-8610-ae59f0d37291/legitimacy-documents/CUS10000351531

Request data

  { 
          "legitimacyDocumentType": "Passport", 
          "legitimacyDocumentId": "9512345", 
          "legitimacyDocumentDate": "2016-10-13T00:00:00.000Z", 
          "legitimacyDocumentExpiryDate": "2026-10-13T00:00:00.000Z", 
          "legitimated": true 
        }

Response data

{
           "responseMetadata":{
              "correlationId":"351096b5-98ce-409b-b01d-daa77ff6f5be",
              "statusMessage":"Executed successfully",
              "statusCode":200,
              "responseDateTime":"2022-12-13T16:35:02.551+0100",
              "timeTakenMs":148
           },
           "data":{
              "legitimacyDocumentType":"Passport",
              "legitimacyDocumentId":"9512345",
              "legitimacyDocumentDate":"2016-10-13T00:00:00.000+00:00",
              "legitimacyDocumentExpiryDate":"2026-10-13T00:00:00.000+00:00",
              "legitimated":true
           }
        }

Sign A Contract

The API allows to:

  • sign a contract, identified by the Issuer Contract external reference or the Contract reference (the contract must be in "awaiting signature" status)
  • request to activate all cards within this contract simultaneously

As a result:

  • the contract is signed
  • the accounts within the contract are activated
  • the cards within the contract are activated if requested
  • the contract can be updated

API links

POST /api/v2/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/sign

POST /api/v2 /issuers/{issuerId}/contracts/{contractReference}/sign

Replace A Customer Within A Consumer Contract

The API can be used to replace a customer belonging to a consumer contract, by an existing one in our system or by a new one.

The customer to be replaced can be the contract owner, the account owner, the cardholder, etc...of the contract.

The main input fields are:

  • The issuer ID
  • The issuer contract external reference or the contract reference
  • The issuer customer external reference or the customer reference for which the replacement is requested
  • The target customer (by providing either the issuer customer external reference or the customer reference) if the customer already exists in our system, or a new one

In return, the API provides the identifiers of all customers (contract owner account owner, the cardholder, etc...) associated to the consumer contract.

API links

POST /api/v2/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}replace-customer

POST /api/v2 /issuers/{issuerId}/contracts/{contractReference}/replace-customer

Refund fee on demand

The API is used to trigger an on demand pro rata refund of Account Setup (AS) fee or Membership fee (MS) for the unutilized period.

Pre Conditions:

  • In case refund for Account Setup fee is requested then card contract closure date should be less than card contract creation date + 1 year
  • In case refund for Membership fee is requested, then the Membership fee should already be posted
  • Account setup fee refund on demand can be received only once during contract lifecycle
  • Membership fee refund on demand can be received only once between Membership fee anniversary dates

The issuer can request the refund by AS or MS fee by providing:

  • The fee type: Either Account Setup fee or Membership Fee
  • Card Contract Reference

As a Result:

  • For Account Setup fee:
    • If account is in closed status (BEING_CLOSED), the pro rata refund will be calculated and posted with the following logic: Posted AS fee amount * (Number of days from contract cancellation till (card contract creation + 1 year) / number of days in the year),
    • In other cases, it will be calculated in the following logic:,Posted AS fee amount * (Number of days from the date when demand for refund is received till (card contract creation + 1 year) / number of days in the year)
  • For Membership Fee:
    • If account is in closed status (BEING_CLOSED), the pro rata refund will be calculated and posted with the following logic: MS fee posted on last MS fee anniversary date * (Number of days from contract cancellation till next MS Fee Anniversary date / number of days in the year)
    • In other cases, it will be calculated in the following logic: MS fee posted on last MS fee anniversary date * (Number of days from the date when demand for refund is received till next MS Fee Anniversary date / number of days in the year).

API links

POST /api/v2/issuers/{issuerId}/contract/{contractReference}/refundFeeOnDemand

POST /api/v2/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/refundFeeOnDemand

Search Contracts By criteria​ (multi-issuers)

The API provides possibility to retrieve a list of consumer contracts, based on certain criteria.

One of the following criteria for searching must be provided:

  • either account's criteria
  • or customer's criteria
  • or card's criteria

For searching with account's criteria, only one of the following data must be provided :

  • IBAN
  • or account identifier : either account reference or issuer account external reference
  • or account membership number 1
  • or account membership number 2

For searching with customer's criteria, only one of the following data must be provided :

  • Personal Data with last name and first name (and optionally with birth date, postal address : postal code, street name and/or building number, phonetic criteria)
  • or customer identifier : either customer reference or issuer customer external reference
  • or partner external reference

For searching with card's criteria, only one of the following data must be provided :

  • PAN
  • or card contract identifier : either card contract reference or issuer card contract external reference
  • or card identifier : either card reference or issuer card external reference

If requested, the API input parameters allows also to:

  • search from a list of issuers (by default, the search is performed on all issuers allowed for the user depending on its rights)
  • limit the list of returned cards per card contract to either the latest card only or all previous cards
  • return the direct parent account in the hierarchy of the account and/or the list of child accounts of the account matching the criteria if the research is based on account's criteria
  • request to enrich the response with additional data relative to the accounts, the card contracts, the cards and the customers by using embedded fields

The API response contains all matched contracts and for each returned contract some information is provided such as :

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

API links

POST /api/v2/search-contracts

Subscribe to add-on

The API allows a cardholder to subscribe to an additional service (e.g. new letter, travel insurance) for the contract during all contract life cycle

The list of allowed additional services are defined on the product (e.g. PORTAL_ACCESS, ALERT, NOTIFICATION).

The main input fields requested by the API are:

  • The issuer ID
  • The contract for which the add-on subscription is requested: It can be provided by using the contract reference or the issuer external contract reference
  • The identifier of the entity for which the add-on subscription is requested: Either the card contract by providing the card contract reference or the issuer external card contract reference, OR the account by providing the account reference or the issuer external account reference
  • The corresponding reference of the additional service
  • The service type reference defined at product level

Depending on the service type, the issuer can add additional parameters to the add-on service.

As a result:

  • The new add-on subscription for the contract is available and can be unsubscribed during all contract life cycle
  • A fee can be generated and posted to the cardholder account if required for the product.

 

API links

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

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

Unsubscribe to add-on

The API allows a cardholder to unsubscribe from an additional service (e.g. new letter, travel insurance) for the contract during all contract life cycle.

The main input fields requested by the API are:

  • The issuer ID
  • The contract for which the add-on unsubscription is requested: It can be provided by using the contract reference or the issuer external contract reference
  • The identifier of the entity for which the add-on unsubscription is requested: Either the card contract by providing the card contract reference or the issuer external card contract reference, OR the account by providing the account reference or the issuer external account reference
  • The corresponding reference of the additional service
  • The service type reference

As a result, the existing add-on subscription for the contract is no longer available.

 

API links

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

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

Retrieve the list of add-on services

The API allows the list of additional service subscriptions (e.g. new letter, travel insurance) for the contract to be retrieved.

The main input fields requested by the API are:

  • The issuer ID
  • The contract for which the add-on subscriptions are requested: It can be provided by using the contract reference or the issuer external contract reference

The API response contains add-on subscription information such as:

  • The reference of the additional service subscription
  • The service type reference
  • The card contract or the account on which the subscription has been done
  • The date of subscription to the add-on service
  • The list of add-on service parameters if any

 

API links

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

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

Enable "on this page" menu on doc section
On

ob-p-ideal-debtor-preference

Debtor preference retrieval API

API Reference

Get Preferences

Endpoint: Get /preferences/{Psuid}

This API can be used to retrieve the iDEAL preferences of a PSU. This will only work after an initial payment by this PSU was successfully completed. More details about the fields can be found in the API reference.

Data model

Legend

  • Orange fields: mandatory for iDEAL preferences
  • Purple fields: optional for iDEAL preferences 
RequestResponse
Get preferences requestGet preferences response

Example

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

Address: https://localhost:8443/xs2a/routingservice/services/ob/pis/v3/preferences/896587495-51254-85475893254
    HttpMethod: GET
    Headers: {Accept=application/json, AspspId=10002, Digest=SHA-256=47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=, X-Request-ID=08cc7007-f3c4-6586-4449-8dbf7a92740b, Authorization=Bearer 788b75b7ea27116c74d4a271404c5f49074fbc786ae67cf771a3a44a02a387d8, MessageCreateDateTime=2023-03-15T13:16:40.448Z, Signature=keyId="8D0F688AD3E6C2D4D5FB99FE129F2A2E3B496AF7",algorithm="SHA256withRSA",headers="digest x-request-id messagecreatedatetime (request-target)",signature="hjSmi6wuf/FTDyJ5W7F7QnzDj2X1KVjYuy5hbig+gF6JBhxBfJtZT4utnBgw6OG9dPyqB0EYHPJby786k+q44kl+pWMPJWAJjNHeXyNufNDENF3GGsRsnqBjwrNp9575vsIeimG34A6x47Ap1/01Nmsqk4NzGr0F0HAVyIbeX0Q9oKd6MJHBaswkv9nqaQTajIpmdesAA5D6eNTSfz4oBOCgk2FlJpUAdaAg9Nd1uZuXV+Jeug2coU+jc5FZUQXyZRaV7hiE5UtBIQVxpml6aydFZwCD6OaRJrGvluebVprYc1bqSsiMmS4Pk+qDJshSk5cWWhnp/bVsUFIIK+NU3g=="}

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

ResponseCode: 200
 
    Headers: {X-Request-ID=2db64c57-fc84-4998-a83c-aa33ff7fbd9b, MessageCreateDateTime=2023-03-15T13:16:40.898Z, Digest=SHA-256=bd7zfJ14uHY5YwvcXpqr78Df5jUpb0Z64styUET3afI=, Signature=keyId="3EBEF6033C00730D9C6DA05165A3CAA1F31036FB",algorithm="rsa-sha256",headers="messagecreatedatetime x-request-id digest",signature="kBpt9O2Auydz0398VFDf0M9lVWcGVI8CsNJbpvAcXxtmTnlO9cH2MlqZQqlMHGjDqcOMmjGeELaQLAft/R1p8HQoyIMJRxh9PtauyKTnHqLavLj6bJr4BoEUeQpE+xfXaR3tebVWz6zr+c7guHEqDjfNKaoKs5HjQIMm/qjKaptU7zkTCIiFsTWh0tmy/h+biI3MJzxqwpZcGdlOCgJ0LI1squZaQXmgA+AsC+uOomBgyhBMPRxMiFIyYPKnA3Ev+UL7UEm3F49B4d/AWYyO2E6B+9p470eA4Ippc4PHeBGvdNgX6zKERsDhCM8ZTmWlOeBh3i5QWvpJF/5Kv6qYHA==",  Date=Wed, 15 Mar 2023 13:16:40 GMT}
    Payload: {
    "AspspName": "IssuerName",
    "AspspLogoUrl": "https://checkout.company.com/login",
    "DebtorAccountIdentification": "NL44RABO******6789"
}
Enable "on this page" menu on doc section
On
Subscribe to