Welcome to our new developer portal! Use the "Ask" button to chat with our AI Agent.
Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

API de consumidor

Register consumer

put
/issuers/{issuerId}/consumers/{consumerId}

This request is used by the bank backend to request the registration of the end user with personal information.

Note

It is strongly recommended to provide the end user personal information such as first and last name, email, phone number, postal address. Personal information is used in D1 Tokenization by the Decision Engine or in D1 Push when building the card information to push to OEM Wallet.

Note

Some end user personal information are mandatory for issuers using D1 Click to Pay service. These mandatory personal information such as mobilePhoneNumber or language are tagged bellow with "This field is mandatory for Click to Pay".

Autorizaciones
AuthorizationstringRequerido

A JWT generated by the Get Authorization Token API.
The server checks the validity of the provided token to control access to this protected resource. Please refer to Get OAuth 2.0 access token for more details on the flow and on how to get this JWT.

Parámetros de ruta
issuerIdstring · mín: 10 · máx: 10Requerido

The id of the issuer

consumerIdstring · mín: 1 · máx: 64Requerido

Unique identifier of the consumer.

Pattern: ^[A-Za-z0-9_-]{1,64}$
Parámetros de encabezado
x-correlation-idstringOpcional

Random identifier which can be used to correlate the different API calls done as part of a single use-case. This identifier will be the one primarily used for troubleshooting.

Warning: This identifier should not be derived from sensitive personal data, as its value will be logged in clear.

There is no strong guarantee of the uniqueness of this identifier, so please refrain from using it for other purpose than logging and troubleshooting.

Pattern: ^[A-Za-z0-9_-]{1,64}$
x-user-idstringOpcional

Identifier of the user that requests the operation on D1 API. This value is provided for information purpose, D1 doesn't do any verification based on this identifier.
D1 manages to propagate the information to a subsequent internal system for tracking purpose.
This identifier is not mandatory.

Pattern: ^[A-Za-z0-9_-]{1,15}$
Cuerpo

The following object represent the end user (consumer).

Respuestas
204

Successful consumer registration.

Sin contenido
put/issuers/{issuerId}/consumers/{consumerId}
PUT /banking/v2/issuers/{issuerId}/consumers/{consumerId} HTTP/1.1
Host: api.d1.thalescloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 560

{
  "personalInformation": {
    "gender": "MALE",
    "language": "eng",
    "firstName": "John",
    "middleName": "John",
    "lastName": "Doe",
    "secondLastName": "Doe",
    "dateOfBirth": "1990-01-01",
    "title": "Mr.",
    "nationality": "FR",
    "email": "john.doe@dummymail.com",
    "mobilePhoneNumber": {
      "countryCode": "+420",
      "phoneNumber": "777222333"
    },
    "residencyAddress": {
      "recipientName": "Mr The Concierge",
      "line1": "Address line",
      "line2": "Address line",
      "line3": "Address line",
      "line4": "Address line",
      "city": "Prague",
      "state": "21",
      "zipCode": "140 00",
      "countryCode": "CZ"
    }
  },
  "preferences": {
    "notificationChannel": [
      "SMS"
    ]
  }
}
Sin contenido

Get Card List

get
/issuers/{issuerId}/consumers/{consumerId}/cards

This request is used to request the end user card list. It will return the cards & digital cards and associated accounts.

Autorizaciones
AuthorizationstringRequerido

A JWT generated by the Get Authorization Token API.
The server checks the validity of the provided token to control access to this protected resource. Please refer to Get OAuth 2.0 access token for more details on the flow and on how to get this JWT.

Parámetros de ruta
issuerIdstring · mín: 10 · máx: 10Requerido

The id of the issuer

consumerIdstring · mín: 1 · máx: 64Requerido

Unique identifier of the consumer.

Pattern: ^[A-Za-z0-9_-]{1,64}$
Parámetros de encabezado
x-correlation-idstringOpcional

Random identifier which can be used to correlate the different API calls done as part of a single use-case. This identifier will be the one primarily used for troubleshooting.

Warning: This identifier should not be derived from sensitive personal data, as its value will be logged in clear.

There is no strong guarantee of the uniqueness of this identifier, so please refrain from using it for other purpose than logging and troubleshooting.

Pattern: ^[A-Za-z0-9_-]{1,64}$
x-user-idstringOpcional

Identifier of the user that requests the operation on D1 API. This value is provided for information purpose, D1 doesn't do any verification based on this identifier.
D1 manages to propagate the information to a subsequent internal system for tracking purpose.
This identifier is not mandatory.

Pattern: ^[A-Za-z0-9_-]{1,15}$
Respuestas
200

Successful get end user card list

application/json
get/issuers/{issuerId}/consumers/{consumerId}/cards
GET /banking/v2/issuers/{issuerId}/consumers/{consumerId}/cards HTTP/1.1
Host: api.d1.thalescloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Delete

post
/issuers/{issuerId}/consumers/{consumerId}/operations:delete

This request is used by the bank backend to request the deletion of an end user. It will also in cascade delete all the accounts, cards and digital cards owned by the end user. Note: The deletion of the end user cannot be reverted. If the same end user is willing to reuse the solution, we will require a new end user registration with a new consumerId.

Autorizaciones
AuthorizationstringRequerido

A JWT generated by the Get Authorization Token API.
The server checks the validity of the provided token to control access to this protected resource. Please refer to Get OAuth 2.0 access token for more details on the flow and on how to get this JWT.

Parámetros de ruta
issuerIdstring · mín: 10 · máx: 10Requerido

The id of the issuer

consumerIdstring · mín: 1 · máx: 64Requerido

Unique identifier of the consumer.

Pattern: ^[A-Za-z0-9_-]{1,64}$
Parámetros de encabezado
x-correlation-idstringOpcional

Random identifier which can be used to correlate the different API calls done as part of a single use-case. This identifier will be the one primarily used for troubleshooting.

Warning: This identifier should not be derived from sensitive personal data, as its value will be logged in clear.

There is no strong guarantee of the uniqueness of this identifier, so please refrain from using it for other purpose than logging and troubleshooting.

Pattern: ^[A-Za-z0-9_-]{1,64}$
x-user-idstringOpcional

Identifier of the user that requests the operation on D1 API. This value is provided for information purpose, D1 doesn't do any verification based on this identifier.
D1 manages to propagate the information to a subsequent internal system for tracking purpose.
This identifier is not mandatory.

Pattern: ^[A-Za-z0-9_-]{1,15}$
Cuerpo
reasonstringOpcional

The reason why the action is performed.

This a free text field in case the bank wants to send details, that will be returned in the operations list.

Example: customer was contacted on June 28Pattern: ^[a-zA-Z0-9 ]{1,64}$
Respuestas
200

End user was deleted Successfully

application/json
operationIdstring · mín: 1 · máx: 64Opcional

Unique identifier of the operation

Pattern: ^[A-Za-z0-9_-]{1,64}$
post/issuers/{issuerId}/consumers/{consumerId}/operations:delete
POST /banking/v2/issuers/{issuerId}/consumers/{consumerId}/operations:delete HTTP/1.1
Host: api.d1.thalescloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "reason": "customer was contacted on June 28"
}
{
  "operationId": "text"
}

Update consumer information

post
/issuers/{issuerId}/consumers/{consumerId}/operations:update

This request is used by the bank backend to request the update of the consumer information.

Note

Some end user personal information are mandatory for issuers using D1 Click to Pay service. These mandatory personal information such as mobilePhoneNumber or language are tagged bellow with "This field is mandatory for Click to Pay".

Autorizaciones
AuthorizationstringRequerido

A JWT generated by the Get Authorization Token API.
The server checks the validity of the provided token to control access to this protected resource. Please refer to Get OAuth 2.0 access token for more details on the flow and on how to get this JWT.

Parámetros de ruta
issuerIdstring · mín: 10 · máx: 10Requerido

The id of the issuer

consumerIdstring · mín: 1 · máx: 64Requerido

Unique identifier of the consumer.

Pattern: ^[A-Za-z0-9_-]{1,64}$
Parámetros de encabezado
x-correlation-idstringOpcional

Random identifier which can be used to correlate the different API calls done as part of a single use-case. This identifier will be the one primarily used for troubleshooting.

Warning: This identifier should not be derived from sensitive personal data, as its value will be logged in clear.

There is no strong guarantee of the uniqueness of this identifier, so please refrain from using it for other purpose than logging and troubleshooting.

Pattern: ^[A-Za-z0-9_-]{1,64}$
x-user-idstringOpcional

Identifier of the user that requests the operation on D1 API. This value is provided for information purpose, D1 doesn't do any verification based on this identifier.
D1 manages to propagate the information to a subsequent internal system for tracking purpose.
This identifier is not mandatory.

Pattern: ^[A-Za-z0-9_-]{1,15}$
Cuerpo

The following object represent the information of the consumer or cardholder.

Respuestas
200

Consumer successfully updated.

application/json
operationIdstring · mín: 1 · máx: 64Opcional

Unique identifier of the operation

Pattern: ^[A-Za-z0-9_-]{1,64}$
post/issuers/{issuerId}/consumers/{consumerId}/operations:update
POST /banking/v2/issuers/{issuerId}/consumers/{consumerId}/operations:update HTTP/1.1
Host: api.d1.thalescloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 558

{
  "personalInformation": {
    "gender": "MALE",
    "language": "eng",
    "firstName": "John",
    "middleName": "John",
    "lastName": "Doe",
    "secondLastName": "Doe",
    "dateOfBirth": "1990-01-01",
    "title": "Mr.",
    "nationality": "FR",
    "email": "john.doe@dummymail.com",
    "mobilePhoneNumber": {
      "countryCode": "+420",
      "phoneNumber": "777222333"
    },
    "residencyAddress": {
      "recipientName": "Mr The Concierge",
      "line1": "Address line",
      "line2": "Address line",
      "line3": "Address line",
      "line4": "Address line",
      "city": "Prague",
      "state": 21,
      "zipCode": "140 00",
      "countryCode": "CZ"
    }
  },
  "preferences": {
    "notificationChannel": [
      "SMS"
    ]
  }
}
{
  "operationId": "text"
}
AnteriorAPI OAuth2
SiguienteAPI de tarjetas

Última actualización

¿Te fue útil?